capabilities.work

Open data — discover a dataset and retrieve it

A 4-step recipe with FERC. We can help you get access.

Recipe · 4 steps

Open data — discover a dataset and retrieve it

with FERC

Resolve a FERC dataset ID from the catalog and retrieve its dictionary and rows.

  1. List every FERC data asset and its nested datasets. This is the only authoritative source of dataset IDs.
  2. Read the dataset's metadata — record count, industry, last updated timestamp and point of contact. Use the record count to decide whether the full data pull is viable, since the data endpoint returns everything with no filtering or paging.
  3. Fetch the column dictionary so the untyped rows can be interpreted. A 404 is an expected outcome — FERC publishes dictionaries for some datasets only — so both 200 and 404 are accepted here and the workflow continues either way.
  4. Retrieve the full row set. There is no pagination and no filtering; the response is the entire dataset. Stream it rather than buffering when the record count from getDatasetDetails is large.
What you'll need to have ready
  • apiKey: The 40-character FERC API key issued from https://data.ferc.gov/developer/gettingstarted/sign-up-form/
  • datasetTitleMatch: Substring of the dataset title to select from the catalog, e.g. "Market-Based Rate".
For your developer

Arazzo workflow ferc:discoverAndRetrieveFercDataset, 4 operations: data-asset-id → detail-id → dictionary-id → data-id. Specs on APIs.io.