Nomis API

https://www.nomisweb.co.uk/api/v01/
Admin
The Nomis API is a RESTful API (v01) for structural discovery and data download of official census...
Tokens:105,262
Snippets:345
Trust Score:10
Update:8 months ago
Show doc for...
Tokens:
Raw
### API URI Summary Example

Source: https://www.nomisweb.co.uk/api/v01/help

This example demonstrates how to view a summary of selections made for a Nomis API query. Appending '/summary' to a URI provides a web page detailing the specified dimensions, highlighting any invalid codes, and offering download URIs in various formats.

```uri
/api/v01/dataset/NM_1_1/summary?geography=2092957697&sex=5
```

--------------------------------

### Nomis API Data Cell Access Examples (URN)

Source: https://www.nomisweb.co.uk/api/v01/help

Provides examples of how to directly access individual data cells in the Nomis database using their unique URN. It shows the URL patterns for retrieving data in SDMX (XML), structure documents (XML), JSON, and CSV formats for a single cell.

```text
Example (XML):  SDMX GenericData for a single cell from the Jobseeker's Allowance dataset | /api/v01/datastore/Nm-1d1d32179e1d2038432081d5d1d20100.generic.sdmx.xml  
---|---
SDMX Structure Document for a single cell from the Jobseeker's Allowance dataset | /api/v01/datastore/Nm-1d1d32179e1d2038432081d5d1d20100.structure.sdmx.xml  
Example (JSON):  JSON formatted data for a single cell from the Jobseeker's Allowance dataset | /api/v01/datastore/Nm-1d1d32179e1d2038432081d5d1d20100.json  
---|---
Example - Comma Separated Values (csv):  CSV formatted data for a single cell from the Jobseeker's Allowance dataset | /api/v01/datastore/Nm-1d1d32179e1d2038432081d5d1d20100.csv  
---|---
```

--------------------------------

### Nomis API CORS Request Example

Source: https://www.nomisweb.co.uk/api/v01/help

Demonstrates how to make a cross-origin request to the Nomis API using JavaScript's XMLHttpRequest object. This example fetches data from the Jobseeker's Allowance dataset and alerts the user upon successful retrieval. It requires a web browser environment with JavaScript enabled.

```html
 <html>
  <body>
    <p>This page queries Nomis for some latest data from the Jobseeker's Allowance dataset.</p>
    <p><input type="button" onclick="getData();" value="Click to get data"></p>
    
        <script type="text/javascript">
    //<![CDATA[
    
    var req = new XMLHttpRequest();
    
    function getData(){
        if(req)
        {	
            var url = 'http://www.nomisweb.co.uk/api/v01/dataset/NM_1_1.jsonstat.json?geography=2038432081&sex=7&item=1&measures=20100&time=latest';
            req.open('GET', url, true);
            req.onreadystatechange = handler;
            req.send(); 
        }
    }

    function handler(evt)
    {
        if (req.readyState == 4)
        {
            if (req.status == 200)
            {
                var response = eval('(' + req.responseText + ')');
                window.alert('Got data');
            }
            else window.alert('Error with call');
        }
    }
    //]]>
    
    </script>
  </body>
 </html>
```

--------------------------------

### Get Complete Codelist

Source: https://www.nomisweb.co.uk/api/v01/help

Retrieve a complete codelist by its ID. Codelist IDs are typically found in the KeyFamily document and often start with 'CL_'. Be aware that some codelists, especially Geography, can be very large.

```APIDOC
## GET /api/v01/codelist/{codelist_id}.def.sdmx.xml

### Description
Retrieves a complete codelist in SDMX XML format.

### Method
GET

### Endpoint
`/api/v01/codelist/{codelist_id}.def.sdmx.xml`

### Parameters
#### Path Parameters
- **codelist_id** (string) - Required - The ID of the codelist to retrieve (e.g., `CL_1_1_ITEM`).

### Request Example
```
GET /api/v01/codelist/CL_1_1_ITEM.def.sdmx.xml
```

### Response
#### Success Response (200)
- **sdmx_xml** (string) - The SDMX XML content of the codelist.

#### Response Example
```xml
<!-- SDMX XML content -->
```

## GET /api/v01/codelist/{codelist_id}.def.sdmx.json

### Description
Retrieves a complete codelist in JSON format.

### Method
GET

### Endpoint
`/api/v01/codelist/{codelist_id}.def.sdmx.json`

### Parameters
#### Path Parameters
- **codelist_id** (string) - Required - The ID of the codelist to retrieve (e.g., `CL_1_1_ITEM`).

### Request Example
```
GET /api/v01/codelist/CL_1_1_ITEM.def.sdmx.json
```

### Response
#### Success Response (200)
- **sdmx_json** (string) - The SDMX JSON content of the codelist.

#### Response Example
```json
{
  "example": "SDMX JSON content"
}
```

## GET /api/v01/codelist/{codelist_id}.def.htm

### Description
Retrieves a complete codelist in HTML format.

### Method
GET

### Endpoint
`/api/v01/codelist/{codelist_id}.def.htm`

### Parameters
#### Path Parameters
- **codelist_id** (string) - Required - The ID of the codelist to retrieve (e.g., `CL_1_1_ITEM`).

### Request Example
```
GET /api/v01/codelist/CL_1_1_ITEM.def.htm
```

### Response
#### Success Response (200)
- **html** (string) - The HTML content of the codelist.

#### Response Example
```html
<!-- HTML content -->
```
```

--------------------------------

### Nomis API JSONP Request Example

Source: https://www.nomisweb.co.uk/api/v01/help

Illustrates how to use JSON with Padding (JSONP) to request data from the Nomis API. This method involves specifying a callback function in the URL, which the API wraps around the JSON response. This is an alternative to CORS for cross-domain requests.

```html
 <html>
  <body>
    <p>This page queries Nomis for some latest data from the Jobseeker's Allowance dataset.</p>
    
    <script type="text/javascript">
       function dataReady(data)
       {
          window.alert('Got callback');
       }
    </script>
    <script src="http://www.nomisweb.co.uk/api/v01/dataset/NM_1_1.jsonstat.json?geography=2038432081&sex=7&item=1&measures=20100&time=latest&callback=dataReady"></script>
  
  </body>
 </html>
```

--------------------------------

### Dataset NM_881_1: Tenure by car or van availability by ethnic group

Source: https://www.nomisweb.co.uk/api/v01/dataset/def_search=keywords-ethnic%2A

Retrieves data on household tenure and car/van availability, broken down by ethnic group.

```APIDOC
## GET /api/v01/dataset/NM_881_1/GEOGRAPHY.def.htm

### Description
This endpoint provides detailed definitions for the GEOGRAPHY dimension within the NM_881_1 dataset.

### Method
GET

### Endpoint
/api/v01/dataset/NM_881_1/GEOGRAPHY.def.htm

### Parameters
#### Path Parameters
- **GEOGRAPHY** (string) - Required - The specific geography to retrieve definitions for.

### Request Example
(No request body for definition endpoints)

### Response
#### Success Response (200)
- **conceptRef** (string) - The reference for the concept.
- **codelist** (string) - The codelist associated with the concept.

#### Response Example
```json
{
  "conceptRef": "GEOGRAPHY",
  "codelist": "CL_881_1_GEOGRAPHY"
}
```
```

--------------------------------

### Discover Available Datasets (HTML)

Source: https://www.nomisweb.co.uk/api/v01/help

View a web page listing all available Nomis datasets with their relevant information. This provides a human-readable overview of the data.

```APIDOC
## GET /api/v01/dataset/def.htm

### Description
Retrieves a web page listing all Nomis datasets available for querying. This provides a human-readable overview of each dataset, including its ID and description.

### Method
GET

### Endpoint
/api/v01/dataset/def.htm

### Parameters
#### Query Parameters
- **search** (string) - Optional - Allows searching for datasets by name, description, or keyword. Supports wildcards (*) and case-insensitive matching. Can be prefixed with `name-`, `description-`, `keywords-`, `contenttype-`, or `units-` for targeted searches. Multiple terms can be searched by separating them with a comma.

### Request Example
```
GET /api/v01/dataset/def.htm?search=*claimant*
```

### Response
#### Success Response (200)
- HTML content - A web page displaying information about each available dataset.

#### Response Example
(HTML content will be rendered in a browser, not shown here as JSON)
```

--------------------------------

### GET /api/v01/dataset/NM_1872_1/GEOGRAPHY.def.htm

Source: https://www.nomisweb.co.uk/api/v01/dataset/def_search=keywords-ethnic%2A

Retrieves the definition for the GEOGRAPHY dimension of the NM_1872_1 dataset, which pertains to Ethnic group by religion.

```APIDOC
## GET /api/v01/dataset/NM_1872_1/GEOGRAPHY.def.htm

### Description
Retrieves the definition for the GEOGRAPHY dimension of the NM_1872_1 dataset. This dataset focuses on Ethnic group by religion.

### Method
GET

### Endpoint
/api/v01/dataset/NM_1872_1/GEOGRAPHY.def.htm

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
Returns a JSON object containing the definition of the GEOGRAPHY dimension for the specified dataset.

#### Response Example
```json
{
  "id": "NM_1872_1",
  "Name": "ST104 - Ethnic group by religion",
  "Dimensions": [
    {
      "conceptRef": "GEOGRAPHY",
      "codelist": "CL_1872_1_GEOGRAPHY"
    },
    {
      "conceptRef": "C_ETHHUK11",
      "codelist": "CL_1872_1_C_ETHHUK11"
    },
    {
      "conceptRef": "C_RELPUK11",
      "codelist": "CL_1872_1_C_RELPUK11"
    },
    {
      "conceptRef": "MEASURES",
      "codelist": "CL_1872_1_MEASURES"
    },
    {
      "conceptRef": "FREQ",
      "codelist": "CL_1872_1_FREQ"
    },
    {
      "conceptRef": "TIME",
      "codelist": "CL_1872_1_TIME"
    }
  ]
}
```
```

--------------------------------

### JSON with padding (JSONP)

Source: https://www.nomisweb.co.uk/api/v01/help

Explains how to use JSONP to request data from the Nomis server from a different domain by specifying a callback function.

```APIDOC
## JSON with padding (JSONP)

### Description
This is a complement to the JSON data format and an older alternative to using CORS. It allows you to request data from our server from a different domain. When requesting JSON output, you may specify a callback function in your request by adding "&callback=x" where x is the name of a function on your web page. Our JSON response will be wrapped in this function call, causing your browser to call your callback function with the data as a parameter to that function.

### Method
GET

### Endpoint
`/api/v01/dataset/{dataset_id}.jsonstat.json`

### Query Parameters
- **geography** (string) - Required - The geography code for the data.
- **sex** (string) - Required - The sex code for the data.
- **item** (string) - Required - The item code for the data.
- **measures** (string) - Required - The measures code for the data.
- **time** (string) - Required - The time period for the data (e.g., 'latest').
- **callback** (string) - Required - The name of the JavaScript function to wrap the JSON response.

### Request Example
```html
<html>
 <body>
  <p>This page queries Nomis for some latest data from the Jobseeker's Allowance dataset.</p>
  
  <script type="text/javascript">
       function dataReady(data)
       {
          window.alert('Got callback');
       }
    </script>
    <script src="http://www.nomisweb.co.uk/api/v01/dataset/NM_1_1.jsonstat.json?geography=2038432081&sex=7&item=1&measures=20100&time=latest&callback=dataReady"></script>
  
  </body>
 </html>
```
```

--------------------------------

### SDMX CompactData Download

Source: https://www.nomisweb.co.uk/api/v01/help

Provides data in the SDMX CompactData document format. Supports XML. Has a 25000 cell limit.

```APIDOC
## GET /api/v01/dataset/{dataset_id}.compact.sdmx.xml

### Description
Downloads data in SDMX CompactData XML format.

### Method
GET

### Endpoint
/api/v01/dataset/{dataset_id}.compact.sdmx.xml

### Query Parameters
- **geography** (string) - Required - The geography code.
- **sex** (string) - Required - The sex code.
- **item** (string) - Required - The item code.
- **measures** (string) - Required - The measures code.
- **time** (string) - Required - The time period.

### Response
#### Success Response (200)
- **XML Document** - The data in SDMX CompactData XML format.

### Response Example
```xml
<message:CompactData ...>
  ...
</message:CompactData>
```
```

--------------------------------

### GET /api/v01/dataset/NM_1880_1/GEOGRAPHY.def.htm

Source: https://www.nomisweb.co.uk/api/v01/dataset/def_search=keywords-ethnic%2A

Retrieves the definition for the GEOGRAPHY dimension of the NM_1880_1 dataset, which pertains to Sex and NS-SeC by ethnic group.

```APIDOC
## GET /api/v01/dataset/NM_1880_1/GEOGRAPHY.def.htm

### Description
Retrieves the definition for the GEOGRAPHY dimension of the NM_1880_1 dataset. This dataset focuses on Sex and NS-SeC by ethnic group.

### Method
GET

### Endpoint
/api/v01/dataset/NM_1880_1/GEOGRAPHY.def.htm

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
Returns a JSON object containing the definition of the GEOGRAPHY dimension for the specified dataset.

#### Response Example
```json
{
  "id": "NM_1880_1",
  "Name": "ST112 - Sex and NS-SeC by ethnic group",
  "Dimensions": [
    {
      "conceptRef": "GEOGRAPHY",
      "codelist": "CL_1880_1_GEOGRAPHY"
    },
    {
      "conceptRef": "C_SEX",
      "codelist": "CL_1880_1_C_SEX"
    },
    {
      "conceptRef": "C_NSSEC",
      "codelist": "CL_1880_1_C_NSSEC"
    },
    {
      "conceptRef": "C_ETHPUK11",
      "codelist": "CL_1880_1_C_ETHPUK11"
    },
    {
      "conceptRef": "MEASURES",
      "codelist": "CL_1880_1_MEASURES"
    },
    {
      "conceptRef": "FREQ",
      "codelist": "CL_1880_1_FREQ"
    },
    {
      "conceptRef": "TIME",
      "codelist": "CL_1880_1_TIME"
    }
  ]
}
```
```

--------------------------------

### Discover Available Datasets (SDMX XML)

Source: https://www.nomisweb.co.uk/api/v01/help

Retrieve a complete list of available Nomis datasets in SDMX XML format. This provides an outline of data structures, including KeyFamily names and descriptions.

```APIDOC
## GET /api/v01/dataset/def.sdmx.xml

### Description
Retrieves a complete list of all Nomis datasets available for querying in SDMX XML format. Each dataset is represented by a "structure:KeyFamily" node containing its name and description.

### Method
GET

### Endpoint
/api/v01/dataset/def.sdmx.xml

### Parameters
#### Query Parameters
- **search** (string) - Optional - Allows searching for datasets by name, description, or keyword. Supports wildcards (*) and case-insensitive matching. Can be prefixed with `name-`, `description-`, `keywords-`, `contenttype-`, or `units-` for targeted searches. Multiple terms can be searched by separating them with a comma.

### Request Example
```
GET /api/v01/dataset/def.sdmx.xml?search=*claimant*
```

### Response
#### Success Response (200)
- **structure:KeyFamily** (array) - Contains a list of "structure:Keyfamily" nodes, each detailing a dataset.

#### Response Example
```xml
<message:Structure xmlns:message="http://www.sdmx.org/resources/sdmx30/message" xmlns:structure="http://www.sdmx.org/resources/sdmx30/structure">
  <structure:KeyFamilies>
    <structure:Keyfamily id="NM_1_1">
      <structure:Name xml:lang="en">Jobseeker's Allowance with Rates and Proportions</structure:Name>
      <structure:Description xml:lang="en">Description of the dataset</structure:Description>
      <structure:Components>
        <structure:Dimension conceptRef="TIME_PERIOD"/>
        <structure:Dimension conceptRef="OBS_STATUS"/>
      </structure:Components>
    </structure:Keyfamily>
    </structure:KeyFamilies>
</message:Structure>
```
```

--------------------------------

### GET /api/v01/dataset/NM_1878_1/GEOGRAPHY.def.htm

Source: https://www.nomisweb.co.uk/api/v01/dataset/def_search=keywords-ethnic%2A

Retrieves the definition for the GEOGRAPHY dimension of the NM_1878_1 dataset, which pertains to Sex and industry by ethnic group.

```APIDOC
## GET /api/v01/dataset/NM_1878_1/GEOGRAPHY.def.htm

### Description
Retrieves the definition for the GEOGRAPHY dimension of the NM_1878_1 dataset. This dataset focuses on Sex and industry by ethnic group.

### Method
GET

### Endpoint
/api/v01/dataset/NM_1878_1/GEOGRAPHY.def.htm

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
Returns a JSON object containing the definition of the GEOGRAPHY dimension for the specified dataset.

#### Response Example
```json
{
  "id": "NM_1878_1",
  "Name": "ST110 - Sex and industry by ethnic group",
  "Dimensions": [
    {
      "conceptRef": "GEOGRAPHY",
      "codelist": "CL_1878_1_GEOGRAPHY"
    },
    {
      "conceptRef": "C_SEX",
      "codelist": "CL_1878_1_C_SEX"
    },
    {
      "conceptRef": "C_INDGPUK11",
      "codelist": "CL_1878_1_C_INDGPUK11"
    },
    {
      "conceptRef": "C_ETHPUK11",
      "codelist": "CL_1878_1_C_ETHPUK11"
    },
    {
      "conceptRef": "MEASURES",
      "codelist": "CL_1878_1_MEASURES"
    },
    {
      "conceptRef": "FREQ",
      "codelist": "CL_1878_1_FREQ"
    },
    {
      "conceptRef": "TIME",
      "codelist": "CL_1878_1_TIME"
    }
  ]
}
```
```

--------------------------------

### GET /api/v01/dataset/NM_1877_1/GEOGRAPHY.def.htm

Source: https://www.nomisweb.co.uk/api/v01/dataset/def_search=keywords-ethnic%2A

Retrieves the definition for the GEOGRAPHY dimension of the NM_1877_1 dataset, which pertains to Sex and occupation by ethnic group.

```APIDOC
## GET /api/v01/dataset/NM_1877_1/GEOGRAPHY.def.htm

### Description
Retrieves the definition for the GEOGRAPHY dimension of the NM_1877_1 dataset. This dataset focuses on Sex and occupation by ethnic group.

### Method
GET

### Endpoint
/api/v01/dataset/NM_1877_1/GEOGRAPHY.def.htm

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
Returns a JSON object containing the definition of the GEOGRAPHY dimension for the specified dataset.

#### Response Example
```json
{
  "id": "NM_1877_1",
  "Name": "ST109 - Sex and occupation by ethnic group",
  "Dimensions": [
    {
      "conceptRef": "GEOGRAPHY",
      "codelist": "CL_1877_1_GEOGRAPHY"
    },
    {
      "conceptRef": "C_SEX",
      "codelist": "CL_1877_1_C_SEX"
    },
    {
      "conceptRef": "C_OCCPUK11_1",
      "codelist": "CL_1877_1_C_OCCPUK11_1"
    },
    {
      "conceptRef": "C_ETHPUK11",
      "codelist": "CL_1877_1_C_ETHPUK11"
    },
    {
      "conceptRef": "MEASURES",
      "codelist": "CL_1877_1_MEASURES"
    },
    {
      "conceptRef": "FREQ",
      "codelist": "CL_1877_1_FREQ"
    },
    {
      "conceptRef": "TIME",
      "codelist": "CL_1877_1_TIME"
    }
  ]
}
```
```

--------------------------------

### Dataset NM_883_1: Occupancy rating (rooms) by ethnic group of Household Reference Person (HRP)

Source: https://www.nomisweb.co.uk/api/v01/dataset/def_search=keywords-ethnic%2A

Retrieves data on household occupancy rating (based on rooms) by the ethnic group of the Household Reference Person.

```APIDOC
## GET /api/v01/dataset/NM_883_1/GEOGRAPHY.def.htm

### Description
This endpoint provides detailed definitions for the GEOGRAPHY dimension within the NM_883_1 dataset.

### Method
GET

### Endpoint
/api/v01/dataset/NM_883_1/GEOGRAPHY.def.htm

### Parameters
#### Path Parameters
- **GEOGRAPHY** (string) - Required - The specific geography to retrieve definitions for.

### Request Example
(No request body for definition endpoints)

### Response
#### Success Response (200)
- **conceptRef** (string) - The reference for the concept.
- **codelist** (string) - The codelist associated with the concept.

#### Response Example
```json
{
  "conceptRef": "GEOGRAPHY",
  "codelist": "CL_883_1_GEOGRAPHY"
}
```
```

--------------------------------

### GET /api/v01/dataset/NM_1869_1/GEOGRAPHY.def.htm

Source: https://www.nomisweb.co.uk/api/v01/dataset/def_search=keywords-ethnic%2A

Retrieves the definition for the GEOGRAPHY dimension of the NM_1869_1 dataset, which pertains to Sex and age by ethnic group.

```APIDOC
## GET /api/v01/dataset/NM_1869_1/GEOGRAPHY.def.htm

### Description
Retrieves the definition for the GEOGRAPHY dimension of the NM_1869_1 dataset. This dataset focuses on Sex and age by ethnic group.

### Method
GET

### Endpoint
/api/v01/dataset/NM_1869_1/GEOGRAPHY.def.htm

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
Returns a JSON object containing the definition of the GEOGRAPHY dimension for the specified dataset.

#### Response Example
```json
{
  "id": "NM_1869_1",
  "Name": "ST101 - Sex and age by ethnic group",
  "Dimensions": [
    {
      "conceptRef": "GEOGRAPHY",
      "codelist": "CL_1869_1_GEOGRAPHY"
    },
    {
      "conceptRef": "C_SEX",
      "codelist": "CL_1869_1_C_SEX"
    },
    {
      "conceptRef": "C_AGE",
      "codelist": "CL_1869_1_C_AGE"
    },
    {
      "conceptRef": "C_ETHPUK11",
      "codelist": "CL_1869_1_C_ETHPUK11"
    },
    {
      "conceptRef": "MEASURES",
      "codelist": "CL_1869_1_MEASURES"
    },
    {
      "conceptRef": "FREQ",
      "codelist": "CL_1869_1_FREQ"
    },
    {
      "conceptRef": "TIME",
      "codelist": "CL_1869_1_TIME"
    }
  ]
}
```
```

--------------------------------

### Dataset NM_869_1: Number of persons per room in household by ethnic group of household reference person (HRP)

Source: https://www.nomisweb.co.uk/api/v01/dataset/def_search=keywords-ethnic%2A

Retrieves data on the number of persons per room in households, broken down by the ethnic group of the household reference person.

```APIDOC
## GET /api/v01/dataset/NM_869_1/GEOGRAPHY.def.htm

### Description
This endpoint provides detailed definitions for the GEOGRAPHY dimension within the NM_869_1 dataset.

### Method
GET

### Endpoint
/api/v01/dataset/NM_869_1/GEOGRAPHY.def.htm

### Parameters
#### Path Parameters
- **GEOGRAPHY** (string) - Required - The specific geography to retrieve definitions for.

### Request Example
(No request body for definition endpoints)

### Response
#### Success Response (200)
- **conceptRef** (string) - The reference for the concept.
- **codelist** (string) - The codelist associated with the concept.

#### Response Example
```json
{
  "conceptRef": "GEOGRAPHY",
  "codelist": "CL_869_1_GEOGRAPHY"
}
```
```

--------------------------------

### GET /api/v01/dataset/NM_1786_1/GEOGRAPHY.def.htm

Source: https://www.nomisweb.co.uk/api/v01/dataset/def_search=keywords-ethnic%2A

Retrieves the definition for the GEOGRAPHY dimension of the NM_1786_1 dataset, which pertains to Sex and age by ethnic group.

```APIDOC
## GET /api/v01/dataset/NM_1786_1/GEOGRAPHY.def.htm

### Description
Retrieves the definition for the GEOGRAPHY dimension of the NM_1786_1 dataset. This dataset focuses on Sex and age by ethnic group.

### Method
GET

### Endpoint
/api/v01/dataset/NM_1786_1/GEOGRAPHY.def.htm

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
Returns a JSON object containing the definition of the GEOGRAPHY dimension for the specified dataset.

#### Response Example
```json
{
  "id": "NM_1786_1",
  "Name": "ST101 - Sex and age by ethnic group",
  "Dimensions": [
    {
      "conceptRef": "GEOGRAPHY",
      "codelist": "CL_1869_1_GEOGRAPHY"
    },
    {
      "conceptRef": "C_SEX",
      "codelist": "CL_1869_1_C_SEX"
    },
    {
      "conceptRef": "C_AGE",
      "codelist": "CL_1869_1_C_AGE"
    },
    {
      "conceptRef": "C_ETHPUK11",
      "codelist": "CL_1869_1_C_ETHPUK11"
    },
    {
      "conceptRef": "MEASURES",
      "codelist": "CL_1869_1_MEASURES"
    },
    {
      "conceptRef": "FREQ",
      "codelist": "CL_1869_1_FREQ"
    },
    {
      "conceptRef": "TIME",
      "codelist": "CL_1869_1_TIME"
    }
  ]
}
```
```

--------------------------------

### GET /api/v01/dataset/NM_659_1/GEOGRAPHY.def.htm

Source: https://www.nomisweb.co.uk/api/v01/dataset/def_search=keywords-ethnic%2A

Retrieves the definition of the GEOGRAPHY dimension for the NM_659_1 dataset, which pertains to 'National identity by ethnic group'.

```APIDOC
## GET /api/v01/dataset/NM_659_1/GEOGRAPHY.def.htm

### Description
This endpoint provides the definition and codelist for the GEOGRAPHY dimension within the NM_659_1 dataset. The NM_659_1 dataset is titled 'DC2202EW - National identity by ethnic group'.

### Method
GET

### Endpoint
/api/v01/dataset/NM_659_1/GEOGRAPHY.def.htm

### Parameters
This endpoint does not have path or query parameters.

### Request Body
This endpoint does not accept a request body.

### Response
#### Success Response (200)
- **id** (string) - The ID of the dataset.
- **Name** (string) - The name of the dataset.
- **Dimensions** (object) - An object containing details about the dimensions available for the dataset.
  - **GEOGRAPHY** (object) - Details for the GEOGRAPHY dimension.
    - **conceptRef** (string) - Reference to the concept.
    - **codelist** (string) - The codelist associated with the GEOGRAPHY dimension.
  - Other dimensions like NATID_ALL, C_ETHPUK11, MEASURES, FREQ, TIME will also be listed with their respective conceptRef and codelist.

#### Response Example
```json
{
  "id": "NM_659_1",
  "Name": "DC2202EW - National identity by ethnic group",
  "Dimensions": {
    "GEOGRAPHY": {
      "conceptRef": "GEOGRAPHY",
      "codelist": "CL_659_1_GEOGRAPHY"
    },
    "NATID_ALL": {
      "conceptRef": "NATID_ALL",
      "codelist": "CL_659_1_NATID_ALL"
    },
    "C_ETHPUK11": {
      "conceptRef": "C_ETHPUK11",
      "codelist": "CL_659_1_C_ETHPUK11"
    },
    "MEASURES": {
      "conceptRef": "MEASURES",
      "codelist": "CL_659_1_MEASURES"
    },
    "FREQ": {
      "conceptRef": "FREQ",
      "codelist": "CL_659_1_FREQ"
    },
    "TIME": {
      "conceptRef": "TIME",
      "codelist": "CL_659_1_TIME"
    }
  }
}
```
```

--------------------------------

### Dataset NM_884_1: Occupancy rating (bedrooms) by ethnic group of Household Reference Person (HRP)

Source: https://www.nomisweb.co.uk/api/v01/dataset/def_search=keywords-ethnic%2A

Retrieves data on household occupancy rating (based on bedrooms) by the ethnic group of the Household Reference Person.

```APIDOC
## GET /api/v01/dataset/NM_884_1/GEOGRAPHY.def.htm

### Description
This endpoint provides detailed definitions for the GEOGRAPHY dimension within the NM_884_1 dataset.

### Method
GET

### Endpoint
/api/v01/dataset/NM_884_1/GEOGRAPHY.def.htm

### Parameters
#### Path Parameters
- **GEOGRAPHY** (string) - Required - The specific geography to retrieve definitions for.

### Request Example
(No request body for definition endpoints)

### Response
#### Success Response (200)
- **conceptRef** (string) - The reference for the concept.
- **codelist** (string) - The codelist associated with the concept.

#### Response Example
```json
{
  "conceptRef": "GEOGRAPHY",
  "codelist": "CL_884_1_GEOGRAPHY"
}
```
```

--------------------------------

### Get Content Type Metadata

Source: https://www.nomisweb.co.uk/api/v01/help

Retrieves metadata for a specific content type.

```APIDOC
## GET /api/v01/contenttype/{content_type}.{format}

### Description
Retrieves metadata for a specific content type (e.g., sources, taxonomy, classifications).

### Method
GET

### Endpoint
/api/v01/contenttype/{content_type}.{format}

### Parameters
#### Path Parameters
- **content_type** (string) - Required - The type of content (e.g., 'sources').
- **format** (string) - Required - The desired format (e.g., 'xml', 'json').

### Request Example
None

### Response
#### Success Response (200)
- **contentType** (object) - Metadata related to the specified content type.

#### Response Example
```xml
<ContentType>
  <Name>Sources</Name>
  <Description>Information about data sources.</Description>
</ContentType>
```
```

--------------------------------

### SDMX GenericData Download

Source: https://www.nomisweb.co.uk/api/v01/help

Provides data in the SDMX GenericData document format. Supports XML and JSON. Has a 25000 cell limit.

```APIDOC
## GET /api/v01/dataset/{dataset_id}.generic.sdmx.xml

### Description
Downloads data in SDMX GenericData XML format.

### Method
GET

### Endpoint
/api/v01/dataset/{dataset_id}.generic.sdmx.xml

### Query Parameters
- **geography** (string) - Required - The geography code.
- **sex** (string) - Required - The sex code.
- **item** (string) - Required - The item code.
- **measures** (string) - Required - The measures code.
- **time** (string) - Required - The time period.

### Response
#### Success Response (200)
- **XML Document** - The data in SDMX GenericData XML format.

### Response Example
```xml
<message:GenericData ...>
  ...
</message:GenericData>
```
```

```APIDOC
## GET /api/v01/dataset/{dataset_id}.generic.sdmx.json

### Description
Downloads data in SDMX GenericData JSON format.

### Method
GET

### Endpoint
/api/v01/dataset/{dataset_id}.generic.sdmx.json

### Query Parameters
- **geography** (string) - Required - The geography code.
- **sex** (string) - Required - The sex code.
- **item** (string) - Required - The item code.
- **measures** (string) - Required - The measures code.
- **time** (string) - Required - The time period.

### Response
#### Success Response (200)
- **JSON Object** - The data in SDMX GenericData JSON format.

### Response Example
```json
{
  "header": { ... },
  "data": [ ... ]
}
```
```

--------------------------------

### Get Geography Definitions

Source: https://www.nomisweb.co.uk/api/v01/help

Retrieves top-level geographical areas available for a dataset.

```APIDOC
## GET /api/v01/dataset/NM_1_1/geography.def.htm

### Description
Retrieves a list of top-level geographical areas available for the specified dataset.

### Method
GET

### Endpoint
/api/v01/dataset/NM_1_1/geography.def.htm

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **geographies** (array) - A list of top-level geographical areas.

#### Response Example
```html
<ul>
  <li>Area 1</li>
  <li>Area 2</li>
</ul>
```
```

--------------------------------

### Dataset NM_879_1: Tenure by ethnic group by age - Household Reference Persons

Source: https://www.nomisweb.co.uk/api/v01/dataset/def_search=keywords-ethnic%2A

Retrieves data on household tenure, broken down by ethnic group and age of the Household Reference Person.

```APIDOC
## GET /api/v01/dataset/NM_879_1/GEOGRAPHY.def.htm

### Description
This endpoint provides detailed definitions for the GEOGRAPHY dimension within the NM_879_1 dataset.

### Method
GET

### Endpoint
/api/v01/dataset/NM_879_1/GEOGRAPHY.def.htm

### Parameters
#### Path Parameters
- **GEOGRAPHY** (string) - Required - The specific geography to retrieve definitions for.

### Request Example
(No request body for definition endpoints)

### Response
#### Success Response (200)
- **conceptRef** (string) - The reference for the concept.
- **codelist** (string) - The codelist associated with the concept.

#### Response Example
```json
{
  "conceptRef": "GEOGRAPHY",
  "codelist": "CL_879_1_GEOGRAPHY"
}
```
```

--------------------------------

### GET /api/v01/dataset/NM_1870_1/GEOGRAPHY.def.htm

Source: https://www.nomisweb.co.uk/api/v01/dataset/def_search=keywords-ethnic%2A

Retrieves the definition for the GEOGRAPHY dimension of the NM_1870_1 dataset, which pertains to Sex and country of birth by ethnic group.

```APIDOC
## GET /api/v01/dataset/NM_1870_1/GEOGRAPHY.def.htm

### Description
Retrieves the definition for the GEOGRAPHY dimension of the NM_1870_1 dataset. This dataset focuses on Sex and country of birth by ethnic group.

### Method
GET

### Endpoint
/api/v01/dataset/NM_1870_1/GEOGRAPHY.def.htm

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
Returns a JSON object containing the definition of the GEOGRAPHY dimension for the specified dataset.

#### Response Example
```json
{
  "id": "NM_1870_1",
  "Name": "ST102 - Sex and country of birth by ethnic group",
  "Dimensions": [
    {
      "conceptRef": "GEOGRAPHY",
      "codelist": "CL_1870_1_GEOGRAPHY"
    },
    {
      "conceptRef": "C_SEX",
      "codelist": "CL_1870_1_C_SEX"
    },
    {
      "conceptRef": "C_COB",
      "codelist": "CL_1870_1_C_COB"
    },
    {
      "conceptRef": "C_ETHPUK11",
      "codelist": "CL_1870_1_C_ETHPUK11"
    },
    {
      "conceptRef": "MEASURES",
      "codelist": "CL_1870_1_MEASURES"
    },
    {
      "conceptRef": "FREQ",
      "codelist": "CL_1870_1_FREQ"
    },
    {
      "conceptRef": "TIME",
      "codelist": "CL_1870_1_TIME"
    }
  ]
}
```
```

--------------------------------

### Get Dataset Overview (XML)

Source: https://www.nomisweb.co.uk/api/v01/help

Retrieves a comprehensive overview of a specific dataset in XML format. The 'select' parameter can be used to filter the returned information to include only specific metadata components.

```text
/api/v01/dataset/nm_1_1.overview.xml
/api/v01/dataset/nm_1_1.overview.xml?select=DateMetadata,DatasetMetadata,Dimensions,DimensionMetadata
```

--------------------------------

### Specific Dataset Details

Source: https://www.nomisweb.co.uk/api/v01/dataset/def_search=keywords-ethnic%2A

This section provides details for specific datasets, including their child links for further exploration.

```APIDOC
## Specific Dataset Details

### Description
This endpoint allows retrieval of detailed information for a specific KeyFamily dataset, including its child link for accessing dimension-specific data.

### Method
GET

### Endpoint
/api/v01/dataset/[dataset_id]/[dimension_name].def.htm

### Parameters
#### Path Parameters
- **dataset_id** (string) - Required - The unique identifier for the dataset.
- **dimension_name** (string) - Required - The name of the dimension for which to retrieve details.

### Response
#### Success Response (200)
- **Child link** (string) - A URL to access further details about the specified dimension within the dataset.

#### Response Example
```json
{
  "Child link": "/api/v01/dataset/NM_17_1/GEOGRAPHY.def.htm"
}
```
```

--------------------------------

### GET /api/v01/dataset/NM_677_1/GEOGRAPHY.def.htm

Source: https://www.nomisweb.co.uk/api/v01/dataset/def_search=keywords-ethnic%2A

Retrieves the definition of the GEOGRAPHY dimension for the NM_677_1 dataset, which pertains to 'NS-SeC by ethnic group by sex by age'.

```APIDOC
## GET /api/v01/dataset/NM_677_1/GEOGRAPHY.def.htm

### Description
This endpoint provides the definition and codelist for the GEOGRAPHY dimension within the NM_677_1 dataset. The NM_677_1 dataset is titled 'DC6206EW - NS-SeC by ethnic group by sex by age'.

### Method
GET

### Endpoint
/api/v01/dataset/NM_677_1/GEOGRAPHY.def.htm

### Parameters
This endpoint does not have path or query parameters.

### Request Body
This endpoint does not accept a request body.

### Response
#### Success Response (200)
- **id** (string) - The ID of the dataset.
- **Name** (string) - The name of the dataset.
- **Dimensions** (object) - An object containing details about the dimensions available for the dataset.
  - **GEOGRAPHY** (object) - Details for the GEOGRAPHY dimension.
    - **conceptRef** (string) - Reference to the concept.
    - **codelist** (string) - The codelist associated with the GEOGRAPHY dimension.
  - Other dimensions like C_SEX, C_AGE, C_NSSEC, C_ETHPUK11, MEASURES, FREQ, TIME will also be listed with their respective conceptRef and codelist.

#### Response Example
```json
{
  "id": "NM_677_1",
  "Name": "DC6206EW - NS-SeC by ethnic group by sex by age",
  "Dimensions": {
    "GEOGRAPHY": {
      "conceptRef": "GEOGRAPHY",
      "codelist": "CL_677_1_GEOGRAPHY"
    },
    "C_SEX": {
      "conceptRef": "C_SEX",
      "codelist": "CL_677_1_C_SEX"
    },
    "C_AGE": {
      "conceptRef": "C_AGE",
      "codelist": "CL_677_1_C_AGE"
    },
    "C_NSSEC": {
      "conceptRef": "C_NSSEC",
      "codelist": "CL_677_1_C_NSSEC"
    },
    "C_ETHPUK11": {
      "conceptRef": "C_ETHPUK11",
      "codelist": "CL_677_1_C_ETHPUK11"
    },
    "MEASURES": {
      "conceptRef": "MEASURES",
      "codelist": "CL_677_1_MEASURES"
    },
    "FREQ": {
      "conceptRef": "FREQ",
      "codelist": "CL_677_1_FREQ"
    },
    "TIME": {
      "conceptRef": "TIME",
      "codelist": "CL_677_1_TIME"
    }
  }
}
```
```
Tokens:
Raw