API Reference

Languages

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.

SDKs in 6 languages

Your API keyKept in this tab only. Without a key, a small daily allowance still answers every request on this page.

Get field labels for a language

GET

https://roxyapi.com/api/v2/languages/field-labels

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.

Call it

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"

Typed SDKs in 6 languages.

Parameters

Response fields

Field	Type	Description
`lang` required	`string enum`	Language these labels resolved to. Echoes the `lang` query parameter, or `en` when it is omitted.
`fields` required	`object`	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` required	`object`	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.

Example response

200 OK

{
  "lang": "es",
  "fields": {},
  "enums": {}
}

Try it

Live

List supported response languages

GET

https://roxyapi.com/api/v2/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.