Open Data API

Overview

The Open Data API provides access to global standard reference data including countries, languages, currencies, units, HS codes, zones, platforms, and other standard classification data.

Base Endpoint: /open

API Endpoints

1. Country List

Get list of all countries with detailed information.

Endpoint: POST /open/country/list or GET /open/country/list

Request:

curl -X GET "https://api.alaikis.com/std/open/country/list" \
  -H "X-API-Key: your_api_key" \
  -H "X-API-Secret: your_api_secret"

Response:

{
  "code": 200,
  "msg": "Request successful",
  "data": [
    {
      "id": 1,
      "code": "US",
      "name": "United States",
      "iso3": "USA",
      "phoneCode": "+1",
      "currencyCode": "USD"
    }
  ]
}

2. Special Country Search

Search for country details by country code or name.

Endpoint: POST /open/country/special

Parameters:

Parameter	Type	Required	Description
bizContent	String	Yes	JSON containing search parameters
- ccode	String	Yes	ISO 3166-1 alpha-2 country code
- country	String	No	Country name filter
- shipCountry	String	No	Shipping country filter

Request:

curl -X POST "https://api.alaikis.com/std/open/country/special" \
  -H "X-API-Key: your_api_key" \
  -H "X-API-Secret: your_api_secret" \
  -d "bizContent={\"ccode\": \"JP\"}"

3. Zone List

Get all administrative zone entries.

Endpoint: POST /open/zone/list

Parameters:

Parameter	Type	Required	Description
bizContent	String	Yes	Empty JSON object

Request:

curl -X POST "https://api.alaikis.com/std/open/zone/list" \
  -H "X-API-Key: your_api_key" \
  -H "X-API-Secret: your_api_secret" \
  -d "bizContent={}"

4. Zone Query

Query zones by name, code, or parent ID.

Endpoint: POST /open/zone/query

Parameters:

Parameter	Type	Required	Description
bizContent	String	Yes	JSON containing query parameters
- name	String	No	Zone name filter
- code	String	No	Zone code filter
- parsent	Integer	No	Parent zone ID filter
- name_en	String	No	English name filter

Request:

curl -X POST "https://api.alaikis.com/std/open/zone/query" \
  -H "X-API-Key: your_api_key" \
  -H "X-API-Secret: your_api_secret" \
  -d "bizContent={\"name\": \"California\", \"parsent\": 1}"

5. Unit List

Query measurement units by type, name, or code.

Endpoint: POST /open/unit/list

Parameters:

Parameter	Type	Required	Description
bizContent	String	Yes	JSON containing query parameters
- origin	String	No	Unit type (default: base)
- ref_unit_id	Integer	No	Reference unit ID
- name	String	No	Unit name filter
- code	String	No	Unit code filter
- name_zh	String	No	Chinese name filter
- id	Integer	No	Unit ID filter

Request:

curl -X POST "https://api.alaikis.com/std/open/unit/list" \
  -H "X-API-Key: your_api_key" \
  -H "X-API-Secret: your_api_secret" \
  -d "bizContent={\"origin\": \"weight\", \"name\": \"kilogram\"}"

6. HS Code List

Query Harmonized System codes.

Endpoint: POST /open/hs-code/list

Parameters:

Parameter	Type	Required	Description
bizContent	String	Yes	JSON containing query parameters
- version	String	No	HS version (default: 2022)
- type	String	No	HS type (default: base)
- keywords	String	No	HS code search keyword
- level	Integer	No	Hierarchy level
- parent	String	No	Parent HS code

Request:

curl -X POST "https://api.alaikis.com/std/open/hs-code/list" \
  -H "X-API-Key: your_api_key" \
  -H "X-API-Secret: your_api_secret" \
  -d "bizContent={\"keywords\": \"8517\", \"level\": 4}"

Get all supported languages with optional sub-language filter.

Endpoint: POST /open/language/list

Parameters:

Parameter	Type	Required	Description
bizContent	String	Yes	JSON containing query parameters
- subLanguage	Boolean	No	Filter for sub-languages (default: false)

Request:

curl -X POST "https://api.alaikis.com/std/open/language/list" \
  -H "X-API-Key: your_api_key" \
  -H "X-API-Secret: your_api_secret" \
  -d "bizContent={\"subLanguage\": true}"

8. Special Language Search

Search for language by code.

Endpoint: POST /open/language/special

Parameters:

Parameter	Type	Required	Description
bizContent	String	Yes	JSON containing search parameters
- code	String	Yes	Language code (e.g., en, zh, ja)

Request:

curl -X POST "https://api.alaikis.com/std/open/language/special" \
  -H "X-API-Key: your_api_key" \
  -H "X-API-Secret: your_api_secret" \
  -d "bizContent={\"code\": \"zh\"}"

9. Currency List

Get all currencies with symbols.

Endpoint: POST /open/currency/list or GET /open/currency/list

Request:

curl -X GET "https://api.alaikis.com/std/open/currency/list" \
  -H "X-API-Key: your_api_key" \
  -H "X-API-Secret: your_api_secret"

10. Special Currency Search

Search for currency by currency code.

Endpoint: POST /open/currency/special

Parameters:

Parameter	Type	Required	Description
bizContent	String	Yes	JSON containing search parameters
- currency	String	Yes	Currency code (e.g., USD, EUR)

Request:

curl -X POST "https://api.alaikis.com/std/open/currency/special" \
  -H "X-API-Key: your_api_key" \
  -H "X-API-Secret: your_api_secret" \
  -d "bizContent={\"currency\": \"USD\"}"

11. Get All Manufacturers/Platforms

Get all available platform/manufacturer entries.

Endpoint: POST /open/manufacturer/all

Request:

curl -X POST "https://api.alaikis.com/std/open/manufacturer/all" \
  -H "X-API-Key: your_api_key" \
  -H "X-API-Secret: your_api_secret"

12. Special Manufacturer Search

Search for platform/manufacturer by code.

Endpoint: POST /open/manufacturer/special

Parameters:

Parameter	Type	Required	Description
bizContent	String	Yes	JSON containing search parameters
- code	String	Yes	Platform code

Request:

curl -X POST "https://api.alaikis.com/std/open/manufacturer/special" \
  -H "X-API-Key: your_api_key" \
  -H "X-API-Secret: your_api_secret" \
  -d "bizContent={\"code\": \"amazon\"}"

13. Get Manufacturer Purchase Fields

Get custom purchase fields for a platform via RPC service.

Endpoint: POST /open/manufacturer/purchase/fields

Parameters:

Parameter	Type	Required	Description
bizContent	String	Yes	JSON containing platform parameters
- platform	String	Yes	Platform identifier

Request:

curl -X POST "https://api.alaikis.com/std/open/manufacturer/purchase/fields" \
  -H "X-API-Key: your_api_key" \
  -H "X-API-Secret: your_api_secret" \
  -d "bizContent={\"platform\": \"amazon\"}"

Data Types Available

Country Data Fields

Field	Type	Description
id	Integer	Unique identifier
code	String	ISO 3166-1 alpha-2 country code
name	String	Country name
iso3	String	ISO 3166-1 alpha-3 code
phoneCode	String	International dialing code
currencyCode	String	ISO 4217 currency code

Currency Data Fields

Field	Type	Description
id	Integer	Unique identifier
code	String	ISO 4217 currency code
name	String	Currency name
symbol	String	Currency symbol

Language Data Fields

Field	Type	Description
id	Integer	Unique identifier
code	String	ISO 639-1 language code
name	String	Language name
nameEn	String	English name

Zone Data Fields

Field	Type	Description
id	Integer	Unique identifier
name	String	Zone name
nameEN	String	English name
code	String	Zone code
parsent	Integer	Parent zone ID

Unit Data Fields

Field	Type	Description
id	Integer	Unique identifier
code	String	Unit code
name	String	Unit name
nameZH	String	Chinese name
origin	String	Unit type/origin
refUnit	Integer	Reference unit ID

Rate Limiting

All endpoints: 1000 requests/hour

Data Update Frequency

Country/Language/Currency data: Monthly
HS Code data: Quarterly
Zone data: As updated by governments

Support

Contact: support@alaikis.com

Overview​

API Endpoints​

1. Country List​

2. Special Country Search​

3. Zone List​

4. Zone Query​

5. Unit List​

6. HS Code List​

7. Language List​

8. Special Language Search​

9. Currency List​

10. Special Currency Search​

11. Get All Manufacturers/Platforms​

12. Special Manufacturer Search​

13. Get Manufacturer Purchase Fields​

Data Types Available​

Country Data Fields​

Currency Data Fields​

Language Data Fields​

Zone Data Fields​

Unit Data Fields​

Rate Limiting​

Data Update Frequency​

Support​

Overview

API Endpoints

1. Country List

2. Special Country Search

3. Zone List

4. Zone Query

5. Unit List

6. HS Code List

7. Language List

8. Special Language Search

9. Currency List

10. Special Currency Search

11. Get All Manufacturers/Platforms

12. Special Manufacturer Search

13. Get Manufacturer Purchase Fields

Data Types Available

Country Data Fields

Currency Data Fields

Language Data Fields

Zone Data Fields

Unit Data Fields

Rate Limiting

Data Update Frequency

Support