Statistics Navigator on the GPT Store

{
  "openapi": "3.0.0",
  "info": {
    "title": "Office for National Statistics API",
    "description": "Provides access to datasets, with the ability to filter and create custom datasets for Census 2021 data.",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://api.beta.ons.gov.uk/v1",
      "description": "Office for National Statistics API Server"
    }
  ],
  "paths": {
    "/datasets": {
      "get": {
        "operationId": "listDatasets",
        "summary": "Get a list of datasets with optional filters",
        "parameters": [
          {
            "name": "is_based_on",
            "in": "query",
            "required": false,
            "description": "A population type to search on to return datasets associated with that type, applicable to Census 2021 datasets.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "description": "Maximum number of items to return. Default is 20, maximum is 1000.",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "offset",
            "in": "query",
            "required": false,
            "description": "Starting index of the items array to return. Default is 0.",
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A list of datasets",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DatasetListResponse"
                }
              }
            }
          }
        }
      }
    },
    "/population-types": {
      "get": {
        "operationId": "listPopulationTypes",
        "summary": "Retrieve a list of available population types for creating custom datasets.",
        "responses": {
          "200": {
            "description": "An array of population types",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/population-types/{population-type-name}/area-types": {
      "get": {
        "operationId": "listAreaTypesForPopulation",
        "summary": "Get a list of available area types for the specified population.",
        "parameters": [
          {
            "name": "population-type-name",
            "in": "path",
            "required": true,
            "description": "The name of the selected population type.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "An array of area types",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "DatasetListResponse": {
        "description": "A response containing a list of datasets",
        "type": "object",
        "properties": {
          "count": {
            "description": "The number of datasets returned",
            "type": "integer",
            "readOnly": true
          },
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Dataset"
            }
          },
          "limit": {
            "description": "The number of datasets requested",
            "type": "integer"
          },
          "offset": {
            "description": "The first row of datasets to retrieve, starting at 0.",
            "type": "integer"
          },
          "total_count": {
            "description": "The total number of datasets",
            "type": "integer",
            "readOnly": true
          }
        }
      },
      "Dataset": {
        "type": "object",
        "properties": {
          "id": {
            "description": "An unique id for a dataset",
            "type": "string",
            "readOnly": true
          }
        }
      }
    }
  }
}