{"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":"Country currencies","description":"Currencies currently legal tender in each country (source: Unicode CLDR). Historical currencies are not provided."},{"name":"Currencies","description":"ISO 4217 currencies (source: iso-codes), including special codes such as funds (BOV), precious metals (XAU) and XXX, with their minor units (source: Unicode CLDR)."}],"paths":{"/api/v1/currencies":{"get":{"tags":["Currencies"],"summary":"List every currency","description":"Ordered by alphabetic code.","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 currency","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CurrencyResponse"}}}}},"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/currencies/{code}":{"get":{"tags":["Currencies"],"summary":"Read one currency","description":"By alphabetic code (case-insensitive) or numeric code.","operationId":"findByCode","parameters":[{"name":"code","in":"path","description":"Alphabetic (EUR) or numeric (978) code","required":true,"schema":{"type":"string","pattern":"^([A-Za-z]{3}|[0-9]{3})$"},"example":"EUR"},{"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":"Currency found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CurrencyResponse"}}}},"400":{"description":"Invalid code or lang (code INVALID_REQUEST)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No currency has this code (code CURRENCY_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/currencies/{code}/countries":{"get":{"tags":["Country currencies"],"summary":"List the countries using a currency","description":"Countries where the currency is currently legal tender, ordered by alpha-2 code.","operationId":"findCountriesOfCurrency","parameters":[{"name":"code","in":"path","description":"Alphabetic (EUR) or numeric (978) code","required":true,"schema":{"type":"string","pattern":"^([A-Za-z]{3}|[0-9]{3})$"},"example":"EUR"},{"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 countries, possibly none (XAU, XDR...)","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CountryOfCurrencyResponse"}}}}},"400":{"description":"Invalid code or lang (code INVALID_REQUEST)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No currency has this code (code CURRENCY_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"}}},"CurrencyResponse":{"type":"object","description":"An ISO 4217 currency","properties":{"alpha3":{"type":"string","description":"ISO 4217 alphabetic code","example":"EUR"},"numeric":{"type":"string","description":"ISO 4217 numeric code, leading zeros kept","example":"978"},"name":{"type":"string","description":"Name, localized when a translation exists","example":"Euro"},"minorUnits":{"type":["integer","null"],"format":"int32","description":"Number of decimal digits (source: Unicode CLDR); absent before the first CLDR synchronization","example":2},"rounding":{"type":["integer","null"],"format":"int32","description":"Rounding increment in minor units, 0 for none","example":0},"cashMinorUnits":{"type":["integer","null"],"format":"int32","description":"Number of decimal digits for cash amounts","example":2},"cashRounding":{"type":["integer","null"],"format":"int32","description":"Rounding increment of cash amounts in minor units (5 for CHF: 0.05)","example":0}}},"CountryOfCurrencyResponse":{"type":"object","description":"A country where the requested currency is currently legal tender (source: Unicode CLDR)","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"},"since":{"type":["string","null"],"format":"date","description":"Date the currency became legal tender in the country","example":"1999-01-01"}}}},"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"}}}}