Skip to content

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:

ParameterTypeRequiredDescription
pageIntegerNoPage number, starting from 0 (default: 0)
sizeIntegerNoPage size (default: 10)
sortByStringNoSort field (default: id)
directionStringNoSort direction: asc or desc (default: asc)

Request:

bash
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:

json
{
  "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:

ParameterTypeRequiredDescription
idIntegerYesRecord ID

Request:

bash
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:

ParameterTypeRequiredDescription
unNumberStringYesUN number

Request:

bash
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:

ParameterTypeRequiredDescription
chemicalNameStringYesChemical name keyword

Request:

bash
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:

ParameterTypeRequiredDescription
materialNameStringYesMaterial name keyword

Request:

bash
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:

ParameterTypeRequiredDescription
unClassStringYesUN class code (1-9)

Request:

bash
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:

ParameterTypeRequiredDescription
unNumberIdIntegerYesUN Number ID

Request:

bash
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:

bash
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:

json
{
  "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

FieldTypeDescription
idIntegerRecord ID
unNumberIdIntegerUN Number ID
unNumberStringUN Number
versionIntegerData version
chemicalNameStringChemical name
materialNameStringMaterial name
unClassStringUN hazard class
codeStringClass code
unDigitStringUN digit code
label1StringLabel 1
label2StringLabel 2
label3StringLabel 3
label4StringLabel 4
limitedQuantityStringLimited quantity
transportCategoryStringTransport category
kemlerNumberStringKemler number
specialProvisionsStringSpecial provisions
changedOnDateTimeChange date
changedByStringChanged by
flashPointStringFlash point
noSEntrieStringNOS entry

Hazard Classes Reference

ClassDescription
Class 1Explosives
Class 2Gases (flammable, non-flammable, toxic)
Class 3Flammable liquids
Class 4.1Flammable solids
Class 4.2Spontaneously combustible substances
Class 4.3Substances which emit flammable gases
Class 5.1Oxidizing substances
Class 5.2Organic peroxides
Class 6.1Toxic substances
Class 6.2Infectious substances
Class 7Radioactive material
Class 8Corrosive substances
Class 9Miscellaneous 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.