API
Understanding the API Endpoints
Before using the API, it helps to understand how the data is organized and what each endpoint expects. This starts with the Data-Assets endpoint, which provides the foundation for exploring, retrieving, and using FERC data — the same data found in the Data Catalog.
☆
Data-Assets Endpoint
Provides core metadata of available FERC data assets and their respective datasets. A single data asset can contain multiple datasets, including their respective IDs to interact with all other endpoints.
Note: Dataset IDs may change over time, so please ensure that the correct ID is being referenced when retrieving data.
Dataset Endpoints
With a dataset ID in hand, you can use the following endpoints to access the dataset and its supporting information. This includes endpoint responses for metadata, full records, and column definitions to help you understand and use the data correctly.
1
Details
Provides additional metadata for a specific dataset, including the number of records, associated industry, last updated timestamp, and email of the designated point of contact.
2
Data
Provides the full dataset data, returning the same number of records as specified in the Details endpoint.
Note: There is currently no ability to return a filtered subset of this data.
3
Dictionary
Provides data dictionary details for a dataset, including column names, descriptions, and data type.
Note: Data dictionaries do not exist for every dataset.
To learn how to identify dataset IDs and retrieve the corresponding data with these endpoints, take a look at the Dataset Retrieval instructions