gridx.pge.client

Liking cljdoc? Tell your friends :D

Clojure only.

create-client
default-spec-path
get-pricing
production-url
stage-url

PG&E-specific GridX Pricing API client.

Wraps gridx.client with PG&E defaults: utility, market, program, and API URLs. The OpenAPI spec at gridx-pricing-spec/pge/openapi.yaml defines the available rate schedules and circuit IDs.

Required params for get-pricing: :startdate - "YYYYMMDD" (earliest 20240601) :enddate - "YYYYMMDD" (max ~2 weeks span) :ratename - PG&E rate schedule code (e.g. "EELEC") :representativeCircuitId - 9-digit feeder ID (see gridx.pge.circuits for location lookup)

Optional params: :cca - CCA code (e.g. "AVA", "PCE")

Use gridx.pge.circuits/find-circuits to look up circuit IDs by substation name, e.g. (find-circuits "mountain view").

PG&E-specific GridX Pricing API client.

Wraps `gridx.client` with PG&E defaults: utility, market, program,
and API URLs. The OpenAPI spec at `gridx-pricing-spec/pge/openapi.yaml`
defines the available rate schedules and circuit IDs.

Required params for `get-pricing`:
  :startdate               - "YYYYMMDD" (earliest 20240601)
  :enddate                 - "YYYYMMDD" (max ~2 weeks span)
  :ratename                - PG&E rate schedule code (e.g. "EELEC")
  :representativeCircuitId - 9-digit feeder ID (see gridx.pge.circuits
                             for location lookup)

Optional params:
  :cca                     - CCA code (e.g. "AVA", "PCE")

Use `gridx.pge.circuits/find-circuits` to look up circuit IDs by
substation name, e.g. (find-circuits "mountain view").

raw docstring

create-client^clj

(create-client)

(create-client {:keys [url spec-path]
                :or {url stage-url spec-path default-spec-path}})

Create a PG&E GridX API client.

Options: :url - API base URL (default: stage) :spec-path - classpath path to OpenAPI YAML (default: bundled PGE spec)

Create a PG&E GridX API client.

Options:
  :url       - API base URL (default: stage)
  :spec-path - classpath path to OpenAPI YAML (default: bundled PGE spec)

source raw docstring

default-spec-path^clj

source

get-pricing^clj

(get-pricing client params)

Fetch PG&E pricing data. Fills in utility/market/program defaults.

Required params: :startdate - "YYYYMMDD" :enddate - "YYYYMMDD" :ratename - rate schedule code :representativeCircuitId - 9-digit feeder ID (see gridx.pge.circuits)

Optional params: :cca - CCA code

Fetch PG&E pricing data. Fills in utility/market/program defaults.

Required params:
  :startdate               - "YYYYMMDD"
  :enddate                 - "YYYYMMDD"
  :ratename                - rate schedule code
  :representativeCircuitId - 9-digit feeder ID (see gridx.pge.circuits)

Optional params:
  :cca                     - CCA code

source raw docstring