About this endpoint
What it does
Converts the input number into its word representation for the specified language. The response returns the original inputs along with the generated words string.
Query Parameter(s)
| Attribute | Type | Mandatory | Description |
|---|---|---|---|
| case | ENUM | No | Allowed values: lower (default), upper, sentence, title. |
| form | String | No | Pattern: cardinal (default) or currency:{CURRENCY}.cardinal spells out the number itself.currency:{CURRENCY} spells out a currency amount, including the currency name in the target language.Supported currency codes: ALL, AED, AUD, BAM, BGN, BRL, BYR, CAD, CHF, CYP, CZK, DKK, DZD, EEK, EGP, EUR, GBP, HKD, HRK, HUF, IDR, ILS, ISK, JPY, LTL, LVL, LYD, MAD, MKD, MRO, MTL, MXN, MYR, NGN, NOK, PHP, PLN, RON, RUB, SAR, SEK, SIT, SKK, TMT, TND, TRL, TRY, UAH, USD, XAF, XOF, XPF, YUM, ZAR, UZS. currency:{CURRENCY} is not available for cs, nl, et, it, mk, sv, fr_BE, which only support cardinal. |
| number | String | Yes | Digits with an optional single . followed by digits. No spaces, commas, sign, or exponent are allowed. Whole numbers from 0 up to 999,999,999,999,999 are accepted; a fractional part is only accepted when using the currency:{CURRENCY} form and is limited to up to 2 digits. |
| language | ENUM | Yes | Allowed values: al, fr_BE, pt_BR, bg, cs, dk, nl, en, et, ka, de, fr, hu, it, lt, lv, mk, pl, pt, ro, sr, sk, es, sv, tr, ua. |
Response
Returns a JSON object with number, language, form, case, and words fields. The words field is the generated string representation of the input number, while the other fields echo the request values.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| case | ENUM | Yes | Allowed values: lower, upper, sentence, title. |
| form | String | Yes | Pattern: cardinal or currency:{CURRENCY}.cardinal spells out the number itself.currency:{CURRENCY} spells out a currency amount, including the currency name in the target language.Supported currency codes: ALL, AED, AUD, BAM, BGN, BRL, BYR, CAD, CHF, CYP, CZK, DKK, DZD, EEK, EGP, EUR, GBP, HKD, HRK, HUF, IDR, ILS, ISK, JPY, LTL, LVL, LYD, MAD, MKD, MRO, MTL, MXN, MYR, NGN, NOK, PHP, PLN, RON, RUB, SAR, SEK, SIT, SKK, TMT, TND, TRL, TRY, UAH, USD, XAF, XOF, XPF, YUM, ZAR, UZS. currency:{CURRENCY} is not available for cs, nl, et, it, mk, sv, fr_BE, which only support cardinal. |
| words | String | Yes | The number written out in words. |
| number | String | Yes | Digits with an optional single . followed by digits. No spaces, commas, sign, or exponent are allowed. Whole numbers from 0 up to 999,999,999,999,999 are accepted; a fractional part is only accepted when using the currency:{CURRENCY} form and is limited to up to 2 digits. |
| language | ENUM | Yes | Allowed values: al, fr_BE, pt_BR, bg, cs, dk, nl, en, et, ka, de, fr, hu, it, lt, lv, mk, pl, pt, ro, sr, sk, es, sv, tr, ua. |



