Dictionary

Fetch column descriptions and definitions from available data.

Get column descriptions and definitions from available data dictionaries (404 error if not available).

get/dataset/{id}/dictionary/

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/dictionary/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

Enter the ID number you want to retrieve

Response

Successfully returned object containing dictionary

object[] required

Example response

[
  {
    "dictionary": [
      {
        "column_id": 0,
        "column_name": "string",
        "data_type": "DOUBLE",
        "description": "string",
        "description_url": ""
      },
      {
        "...": "..."
      }
    ]
  }
]

Changes

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