openapi: 3.2.0
info:
  title: Endpoints Details API
  description: "Our API provides the necessary services to access data programmatically. You first need to utilize the **Data-Assets endpoint** to obtain the **dataset ID** before you can call the Details, Data, and Dictionary endpoints. The dataset ID is required to retrieve the respective dataset information.\n\n Please note that executing the endpoints directly on this page will only return the first 100 rows, whereas you can expect the full dataset when executing them from the browser or your application. You can get a  [better understanding of our APIs](/developer/gettingstarted/understanding-our-apis/) by reviewing our documentaiton."
  x-logo:
    url: /public/logo512.png
host: https://api-staging.data.ferc.gov/v1
schemes:
- https
security:
- ApiKeyQueryAuth: []
tags:
- name: Details
paths:
  /dataset/{id}/details/:
    get:
      tags:
      - Details
      summary: Fetch metadata, data asset, row count, and column information.
      description: 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.
      parameters:
      - name: id
        in: path
        description: Enter the dataset ID number you want to retrieve
        required: true
        schema:
          type: string
          example: 1
      operationId: detail-id
      responses:
        '200':
          description: Successfully returned list of datasets
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  example:
                    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
                      - '...': '...'
        '401':
          description: Unauthorized - Request unsuccessful due to lack of validation
        '404':
          description: Not Found - Dataset ID does not exist
        '405':
          description: Method Not Allowed - Only GET requests are allowed
        '429':
          description: Too Many Requests - Blocked due to multiple requests in a short period
        '500':
          description: Internal Server Error - Database error or server failure
components:
  securitySchemes:
    ApiKeyQueryAuth:
      type: apiKey
      in: query
      name: api_key