UN Numbers API
Overview
The UN Numbers API provides access to United Nations dangerous goods classification data including hazard classes, chemical names, material names, label codes, and transport categories.
Note: This API provides read-only access to UN Numbers data. Data synchronization is managed internally by scheduled tasks.
Base Endpoint: /api/un-numbers
API Endpoints
1. List All UN Numbers (Paginated)
Retrieve a paginated list of all UN Numbers records.
Endpoint: GET /api/un-numbers
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| page | Integer | No | Page number, starting from 0 (default: 0) |
| size | Integer | No | Page size (default: 10) |
| sortBy | String | No | Sort field (default: id) |
| direction | String | No | Sort direction: asc or desc (default: asc) |
Request:
curl "https://api.alaikis.com/std/api/un-numbers?page=0&size=10&sortBy=id&direction=asc" \
-H "X-API-Key: your_api_key" \
-H "X-API-Secret: your_api_secret"Response:
{
"code": 200,
"msg": "Request successful",
"data": {
"results": [
{
"id": 1,
"unNumberId": 1203,
"unNumber": "1203",
"chemicalName": "Gasoline",
"materialName": "Gasoline or Petrol or Motor spirit",
"unClass": "3",
"code": "3",
"unDigit": "1203",
"label1": "3",
"label2": null,
"limitedQuantity": "1 L",
"transportCategory": "2",
"kemlerNumber": "33",
"specialProvisions": "1B,10",
"flashPoint": null
}
],
"currentPage": 0,
"totalItems": 2500,
"totalPages": 250
}
}2. Get UN Number by ID
Retrieve a single UN Number record by its database ID.
Endpoint: GET /api/un-numbers/{id}
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| id | Integer | Yes | Record ID |
Request:
curl "https://api.alaikis.com/std/api/un-numbers/1" \
-H "X-API-Key: your_api_key" \
-H "X-API-Secret: your_api_secret"3. Search by UN Number
Search records by UN number (e.g., 1203).
Endpoint: GET /api/un-numbers/by-un-number
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| unNumber | String | Yes | UN number |
Request:
curl "https://api.alaikis.com/std/api/un-numbers/by-un-number?unNumber=1203" \
-H "X-API-Key: your_api_key" \
-H "X-API-Secret: your_api_secret"4. Search by Chemical Name
Search records by chemical name (fuzzy match).
Endpoint: GET /api/un-numbers/by-chemical-name
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| chemicalName | String | Yes | Chemical name keyword |
Request:
curl "https://api.alaikis.com/std/api/un-numbers/by-chemical-name?chemicalName=Gasoline" \
-H "X-API-Key: your_api_key" \
-H "X-API-Secret: your_api_secret"5. Search by Material Name
Search records by material name (fuzzy match).
Endpoint: GET /api/un-numbers/by-material-name
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| materialName | String | Yes | Material name keyword |
Request:
curl "https://api.alaikis.com/std/api/un-numbers/by-material-name?materialName=Petrol" \
-H "X-API-Key: your_api_key" \
-H "X-API-Secret: your_api_secret"6. Search by UN Class
Search records by UN hazard class.
Endpoint: GET /api/un-numbers/by-un-class
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| unClass | String | Yes | UN class code (1-9) |
Request:
curl "https://api.alaikis.com/std/api/un-numbers/by-un-class?unClass=3" \
-H "X-API-Key: your_api_key" \
-H "X-API-Secret: your_api_secret"7. Search by UN Number ID
Search records by the unNumberId field (exact match).
Endpoint: GET /api/un-numbers/by-un-number-id
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| unNumberId | Integer | Yes | UN Number ID |
Request:
curl "https://api.alaikis.com/std/api/un-numbers/by-un-number-id?unNumberId=1203" \
-H "X-API-Key: your_api_key" \
-H "X-API-Secret: your_api_secret"8. Get All UN Classes
Retrieve a list of all available UN hazard class codes.
Endpoint: GET /api/un-numbers/un-classes
Request:
curl "https://api.alaikis.com/std/api/un-numbers/un-classes" \
-H "X-API-Key: your_api_key" \
-H "X-API-Secret: your_api_secret"Response:
{
"code": 200,
"msg": "Request successful",
"data": ["1", "1.1", "1.2", "1.3", "1.4", "1.5", "1.6", "2", "2.1", "2.2", "2.3", "3", "4.1", "4.2", "4.3", "5.1", "5.2", "6.1", "6.2", "7", "8", "9"]
}Data Model
UNNumbers Fields
| Field | Type | Description |
|---|---|---|
| id | Integer | Record ID |
| unNumberId | Integer | UN Number ID |
| unNumber | String | UN Number |
| version | Integer | Data version |
| chemicalName | String | Chemical name |
| materialName | String | Material name |
| unClass | String | UN hazard class |
| code | String | Class code |
| unDigit | String | UN digit code |
| label1 | String | Label 1 |
| label2 | String | Label 2 |
| label3 | String | Label 3 |
| label4 | String | Label 4 |
| limitedQuantity | String | Limited quantity |
| transportCategory | String | Transport category |
| kemlerNumber | String | Kemler number |
| specialProvisions | String | Special provisions |
| changedOn | DateTime | Change date |
| changedBy | String | Changed by |
| flashPoint | String | Flash point |
| noSEntrie | String | NOS entry |
Hazard Classes Reference
| Class | Description |
|---|---|
| Class 1 | Explosives |
| Class 2 | Gases (flammable, non-flammable, toxic) |
| Class 3 | Flammable liquids |
| Class 4.1 | Flammable solids |
| Class 4.2 | Spontaneously combustible substances |
| Class 4.3 | Substances which emit flammable gases |
| Class 5.1 | Oxidizing substances |
| Class 5.2 | Organic peroxides |
| Class 6.1 | Toxic substances |
| Class 6.2 | Infectious substances |
| Class 7 | Radioactive material |
| Class 8 | Corrosive substances |
| Class 9 | Miscellaneous dangerous substances |
Data Update Frequency
UN Numbers data is automatically synchronized on a monthly basis. You can check the sync task status via the Scheduler Status API.