Details

Fetch metadata, data asset, row count, and column information.

The Detail endpoint provides metadata information about a specific dataset by providing its dataset ID number. This endpoint returns the description of the dataset, the associated industry, the most recent update date and time, the source URL, and the designated point of contact information for further inquiries on the dataset.

get/dataset/{id}/details/

Request

Base URL
https://data.ferc.gov (the document declares no server; this is the origin it was published from)
Auth
API key in query parameter api_key
TypeScript
https://skmtc.dev/ferc/apis/api-endpoints/docs/dataset/:id/details/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

Enter the dataset ID number you want to retrieve

Response

Successfully returned list of datasets

object[] required

Example response

[
  {
    "metadata": {
      "id": 0,
      "title": "string",
      "description": "String",
      "program_office": "String",
      "url": "URL",
      "point_of_contact_email": "string",
      "point_of_contact_name": "String",
      "source": "URL",
      "data-sets": [
        {
          "id": 0,
          "title": "string",
          "url": "string",
          "description": "string"
        },
        {
          "...": "..."
        }
      ]
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.