Languages API Reference

List the response languages accepted by the `lang` query parameter on every i18n-aware endpoint. Use to populate language pickers, validate user input, or auto-detect available locales in agent integrations.

Auth: X-API-Key
Languages: en, tr, de, es, hi, pt, fr, ru, zh-Hans, zh-Hant
SDKs: TypeScript, Python, PHP, C#, Go, and Rust

GET /api/v2/languages/field-labels

Get field labels for a language

Returns the display label for every request field name and every selectable option across the API, in the requested language. Use this to build a birth-data form, a chart widget, or an admin picker that reads in your customer language without hardcoding a word: look a field name up in `fields`, and an option up in `enums` under `{fieldName}.{value}`. Values a caller sends stay the canonical English identifier, so a translated form still submits a valid request. Labels a language has not been translated into yet return English, and the whole payload is stable enough to cache for a day.

Request

Show all 1 optional fieldsShow fewer optional fields

lang query, string enum: Response language (BCP 47). Supported: en, tr, de, es, hi, pt, fr, ru, zh-Hans, zh-Hant. Defaults to en. Coverage varies by domain, and a field with no translation in the requested language returns English. One of en, tr, de, es, hi, pt, fr, ru, zh-Hans, zh-Hant. Default en.

Response

lang string enum, required: Language these labels resolved to. Echoes the `lang` query parameter, or `en` when it is omitted. One of en, tr, de, es, hi, pt, fr, ru, zh-Hans, zh-Hant.
fields object, required: Label per request field or parameter name. Keys are the wire names used in request bodies, query parameters and path parameters, such as `birthDate`, `timezone` or `houseSystem`.
enums object, required: Label per selectable option, keyed `{fieldName}.{value}` so the same value can read differently under different fields. For example `nodeType.mean`, `houseSystem.whole-sign` and `id.rat`. An id shared by collections with different display names is omitted. Split on the first dot: the field name is before it, and everything after it is the value you send back unchanged.

Errors

Status	Meaning
`400`	Validation error. `issues[]` lists every failed field.
`401`	Invalid or missing API key
`405`	Method not allowed. The path exists but only responds to the methods listed in `allow[]` and the `Allow` response header.
`429`	Monthly rate limit exceeded
`500`	Internal server error

GET /languages/field-labels

TypeScript

import { createRoxy } from '@roxyapi/sdk'

const roxy = createRoxy(process.env.ROXY_API_KEY!)
const { data } = await roxy.languages.getFieldLabels()

Install: npm install @roxyapi/sdk

Python

from roxy_sdk import create_roxy

roxy = create_roxy("YOUR_API_KEY")
result = roxy.languages.get_field_labels()

Install: pip install roxy-sdk

PHP

use function RoxyAPI\Sdk\createRoxy;

$roxy = createRoxy(getenv('ROXY_API_KEY'));
$result = $roxy->languages->getFieldLabels();

Install: composer require roxyapi/sdk

using RoxyApi;

var roxy = new RoxyClient(Environment.GetEnvironmentVariable("ROXY_API_KEY")!);
var result = await roxy.Languages.FieldLabels.GetAsync();

Install: dotnet add package RoxyApi.Sdk

import roxyapi "github.com/RoxyAPI/sdk-go"

roxy, _ := roxyapi.NewRoxy(os.Getenv("ROXY_API_KEY"))
resp, _ := roxy.Languages.GetFieldLabels(ctx, nil)

Install: go get github.com/RoxyAPI/sdk-go

Rust

use roxyapi::{Roxy, types};

async fn call(roxy: &Roxy, params: &types::GetFieldLabelsParams) -> Result<(), roxyapi::Error> {
    let result = roxy.languages().get_field_labels(params).await?;
    println!("{result:?}");
    Ok(())
}

Install: cargo add roxyapi

cURL

curl "https://roxyapi.com/api/v2/languages/field-labels" \
  -H "X-API-Key: YOUR_KEY"

GET /api/v2/languages

List supported response languages

Returns the language codes accepted by the `lang` query parameter on every i18n-aware endpoint. Use this to populate language pickers, validate user input before calling chart or reading endpoints, or auto-detect which languages an agent integration can offer. Codes follow ISO 639-1. Endpoints without a translation for the requested language fall back to English silently.