{"openapi":"3.1.0","info":{"title":"AXITAM Public API","description":"Reference data (ISO, CLDR), Belgian enterprises, annual accounts and addresses, Peppol participants - built on community-maintained and official sources. See the data-sources API for each source's version and license. Beta.","version":"0.10.0"},"servers":[{"url":"/","description":"This server"}],"tags":[{"name":"Regions","description":"Geographic UN M49 regions - World, continents and sub-regions (source: Unicode CLDR). Political groupings (European Union, euro area, United Nations) are not provided."}],"paths":{"/api/v1/regions":{"get":{"tags":["Regions"],"summary":"List every region","description":"Ordered by code; parentCode rebuilds the tree.","operationId":"findAll","parameters":[{"name":"lang","in":"query","description":"Language of the returned names: a language code optionally followed by a region, script or gettext modifier (fr, fr-BE, pt-BR, zh-Hant, sr@latin). Falls back to the bare language (fr-BE -> fr), then to English, field by field. Omitted: English.","required":false,"schema":{"type":"string","pattern":"^[A-Za-z]{2,3}([-_][A-Za-z0-9]{2,8})?(@[A-Za-z]{1,20})?$"},"example":"fr"}],"responses":{"200":{"description":"Every region","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RegionResponse"}}}}},"400":{"description":"Invalid lang (code INVALID_REQUEST)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"The X-API-Key header carries an unknown, revoked or malformed key (code INVALID_API_KEY). Leave the header out to call anonymously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too many requests from this client: the code is RATE_LIMITED, Retry-After says in how many seconds a request will pass again.","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Sustained requests per second allowed on this path","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in the current burst","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{},{"apiKey":[]}]}},"/api/v1/regions/{code}":{"get":{"tags":["Regions"],"summary":"Read one region","description":"By three-digit UN M49 code.","operationId":"findByCode","parameters":[{"name":"code","in":"path","description":"Three-digit UN M49 code","required":true,"schema":{"type":"string","pattern":"^[0-9]{3}$"},"example":155},{"name":"lang","in":"query","description":"Language of the returned names: a language code optionally followed by a region, script or gettext modifier (fr, fr-BE, pt-BR, zh-Hant, sr@latin). Falls back to the bare language (fr-BE -> fr), then to English, field by field. Omitted: English.","required":false,"schema":{"type":"string","pattern":"^[A-Za-z]{2,3}([-_][A-Za-z0-9]{2,8})?(@[A-Za-z]{1,20})?$"},"example":"fr"}],"responses":{"200":{"description":"Region found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RegionResponse"}}}},"400":{"description":"Invalid code or lang (code INVALID_REQUEST)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No region has this code (code REGION_NOT_FOUND)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"The X-API-Key header carries an unknown, revoked or malformed key (code INVALID_API_KEY). Leave the header out to call anonymously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too many requests from this client: the code is RATE_LIMITED, Retry-After says in how many seconds a request will pass again.","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Sustained requests per second allowed on this path","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in the current burst","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{},{"apiKey":[]}]}},"/api/v1/regions/{code}/countries":{"get":{"tags":["Regions"],"summary":"List the countries of a region","description":"Countries of the region and of all its sub-regions (150 Europe returns every European country), ordered by alpha-2 code.","operationId":"findCountries","parameters":[{"name":"code","in":"path","description":"Three-digit UN M49 code","required":true,"schema":{"type":"string","pattern":"^[0-9]{3}$"},"example":150},{"name":"lang","in":"query","description":"Language of the returned names: a language code optionally followed by a region, script or gettext modifier (fr, fr-BE, pt-BR, zh-Hant, sr@latin). Falls back to the bare language (fr-BE -> fr), then to English, field by field. Omitted: English.","required":false,"schema":{"type":"string","pattern":"^[A-Za-z]{2,3}([-_][A-Za-z0-9]{2,8})?(@[A-Za-z]{1,20})?$"},"example":"fr"}],"responses":{"200":{"description":"The region's countries","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RegionCountryResponse"}}}}},"400":{"description":"Invalid code or lang (code INVALID_REQUEST)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No region has this code (code REGION_NOT_FOUND)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"The X-API-Key header carries an unknown, revoked or malformed key (code INVALID_API_KEY). Leave the header out to call anonymously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too many requests from this client: the code is RATE_LIMITED, Retry-After says in how many seconds a request will pass again.","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Sustained requests per second allowed on this path","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in the current burst","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{},{"apiKey":[]}]}}},"components":{"schemas":{"ErrorResponse":{"type":"object","properties":{"code":{"type":"string"},"correlationId":{"type":"string"}}},"RegionResponse":{"type":"object","description":"A geographic UN M49 region (source: Unicode CLDR)","properties":{"code":{"type":"string","description":"UN M49 numeric code, leading zeros kept","example":"155"},"name":{"type":"string","description":"Name, localized when a translation exists","example":"Western Europe"},"parentCode":{"type":["string","null"],"description":"Code of the enclosing region; absent for World (001)","example":"150"}}},"RegionCountryResponse":{"type":"object","description":"A country within the requested region","properties":{"alpha2":{"type":"string","description":"ISO 3166-1 alpha-2 code","example":"BE"},"alpha3":{"type":"string","description":"ISO 3166-1 alpha-3 code","example":"BEL"},"name":{"type":"string","description":"Name, localized when a translation exists","example":"Belgium"},"regionCode":{"type":"string","description":"UN M49 code of the sub-region directly containing the country","example":"155"}}}},"securitySchemes":{"apiKey":{"type":"apiKey","description":"Optional. A key of a registered developer (portal: /account/) raises the request rate of the client from the anonymous per-IP limit to the plan's. Without it the request is anonymous; an unknown or revoked key is refused (401 INVALID_API_KEY).","name":"X-API-Key","in":"header"}}}}