midas.client — energy.grid-coordination/clj-midas 0.2.0

MIDAS API client.

Spec-driven HTTP client built on Martian. The OpenAPI spec bundled in resources/midas-spec/openapi.yaml is the single source of truth for endpoint definitions and parameter validation.

Authentication flow:

1. Call (get-token username password) to obtain a 10-minute bearer token
2. Call (create-client token) to create an authenticated Martian client
3. Use the client with API functions (rin-list, rate-values, etc.)

api-url clj

body clj

(body response)

Extract the parsed body from an HTTP response.

create-auto-client clj

(create-auto-client username password)

(create-auto-client username
                    password
                    {:keys [url spec-path]
                     :or {url api-url spec-path default-spec-path}})

Create a MIDAS client that automatically refreshes its bearer token.

Acquires an initial token using the provided credentials and transparently refreshes it before any request where the token is expired or about to expire (within 30 seconds).

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

create-client clj

(create-client token)

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

Create an authenticated MIDAS API client from the bundled OpenAPI spec.

token can be either a raw token string or a token-info map from get-token.

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

default-spec-path clj

get-historical-data clj

(get-historical-data client rin startdate enddate)

Fetch archived rate data for a RIN within a date range. Dates are ISO 8601 strings (e.g. "2023-01-01").

get-historical-list clj

(get-historical-list client distribution-code energy-code)

Fetch list of RINs with historical data for a provider pair.

get-holidays clj

(get-holidays client)

Fetch all utility holidays.

get-lookup-table clj

(get-lookup-table client table-name)

Fetch a MIDAS lookup/reference table. table-name: Country, Daytype, Distribution, Enduse, Energy, Location, Ratetype, Sector, State, or Unit.

get-rate-values clj

(get-rate-values client rin query-type)

Fetch rate/price values for a specific RIN. query-type: "alldata" or "realtime".

get-rin-list clj

(get-rin-list client signal-type)

Fetch list of available RINs by signal type. signal-type: 0=All, 1=Rates, 2=GHG, 3=Flex Alert.

get-token clj

(get-token username password)

(get-token username password {:keys [url] :or {url api-url}})

Authenticate with MIDAS using HTTP Basic auth and return a bearer token.

The token is returned in the Token response header and is valid for 10 minutes. Returns the token string on success, nil on failure.

Options: :url - API base URL (default: production)

register clj

(register {:keys [fullname username password email organization]})

(register {:keys [fullname username password email organization]}
          {:keys [url] :or {url api-url}})

Register a new MIDAS API user account.

All string fields are automatically base64-encoded as required by the API. Returns the raw HTTP response. organization is optional.

Options: :url - API base URL (default: production)

routes clj

(routes client)

List all available route names for the client.

success? clj

(success? response)

True if the HTTP response has a 2xx status.

token-expired? clj

(token-expired? token-info)

(token-expired? token-info buffer-seconds)

True if a token-info map is expired or will expire within buffer-seconds (default 30).

token-info clj

(token-info client)

Get the current token-info from a client (works with both client types).