{"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":"Scripts","description":"ISO 15924 scripts, i.e. writing systems (source: iso-codes), including special codes such as Zyyy (undetermined) and Zzzz (uncoded)."}],"paths":{"/api/v1/scripts":{"get":{"tags":["Scripts"],"summary":"List every script","description":"Ordered by alpha-4 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 script","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ScriptResponse"}}}}},"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/scripts/{code}":{"get":{"tags":["Scripts"],"summary":"Read one script","description":"By alpha-4 code (case-insensitive) or numeric code.","operationId":"findByCode","parameters":[{"name":"code","in":"path","description":"Alpha-4 (Latn) or numeric (215) code","required":true,"schema":{"type":"string","pattern":"^([A-Za-z]{4}|[0-9]{3})$"},"example":"Latn"},{"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":"Script found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ScriptResponse"}}}},"400":{"description":"Invalid code or lang (code INVALID_REQUEST)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No script has this code (code SCRIPT_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"}}},"ScriptResponse":{"type":"object","description":"An ISO 15924 script (writing system)","properties":{"alpha4":{"type":"string","description":"ISO 15924 code, in its official case","example":"Latn"},"numeric":{"type":"string","description":"ISO 15924 numeric code","example":"215"},"name":{"type":"string","description":"Name, localized when a translation exists","example":"Latin"}}}},"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"}}}}