Liking cljdoc? Tell your friends :D

gridx.sce.client

SCE-specific GridX Pricing API client.

Wraps gridx.client with SCE defaults: utility, market, program, and API URLs. The OpenAPI spec at gridx-pricing-spec/sce/openapi.yaml defines the available rate schedules and circuit names.

Required params for get-pricing: :startdate - "YYYYMMDD" (earliest 20250701) :enddate - "YYYYMMDD" (max ~2 weeks span) :ratename - SCE rate schedule code (e.g. "TOU-EV-9S") :representativeCircuitId - substation name (e.g. "System", "Alamitos")

SCE-specific GridX Pricing API client.

Wraps `gridx.client` with SCE defaults: utility, market, program,
and API URLs. The OpenAPI spec at `gridx-pricing-spec/sce/openapi.yaml`
defines the available rate schedules and circuit names.

Required params for `get-pricing`:
  :startdate             - "YYYYMMDD" (earliest 20250701)
  :enddate               - "YYYYMMDD" (max ~2 weeks span)
  :ratename              - SCE rate schedule code (e.g. "TOU-EV-9S")
  :representativeCircuitId - substation name (e.g. "System", "Alamitos")
raw docstring

create-clientclj

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

Create an SCE GridX API client.

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

Create an SCE GridX API client.

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

default-spec-pathclj

source

get-pricingclj

(get-pricing client params)

Fetch SCE pricing data. Fills in utility/market/program defaults.

Required params: :startdate - "YYYYMMDD" :enddate - "YYYYMMDD" :ratename - rate schedule code :representativeCircuitId - substation name (e.g. "System")

Fetch SCE pricing data. Fills in utility/market/program defaults.

Required params:
  :startdate               - "YYYYMMDD"
  :enddate                 - "YYYYMMDD"
  :ratename                - rate schedule code
  :representativeCircuitId - substation name (e.g. "System")
sourceraw docstring

production-urlclj

source

stage-urlclj

source

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close