> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rangler.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Response Conventions

> Understand Rangler JSON, paginated collections, financial metric maps, binary source responses, and errors.

Rangler does not add generic `status`, `message`, and `data` fields around successful responses.

## Resource responses

Detail endpoints return the resource directly:

```json theme={null}
{
  "id": "efa534f5-3b01-4f12-a33b-3c797b05beee",
  "name": "ACCESS HOLDINGS PLC",
  "ticker": "ACCESSCORP",
  "country_code": "NG"
}
```

## Collection responses

Collections that return results in pages use:

```json theme={null}
{
  "data": [],
  "next_cursor": null
}
```

Pass `next_cursor` back as the next request's `cursor`. Use these values exactly as returned; do not parse or construct them.

Smaller collections that do not split results into pages return `data` and may include `count` when the total is useful to the integration. Follow each endpoint's API reference instead of assuming every list uses the same format.

## Financial responses

Standardized statement responses use consistent fields and groups of values:

* `periods` and `trailing_periods` are arrays ordered by reporting period
* `metrics` maps standard metric names to base-unit numeric values
* `ratios` maps ratio keys to decimal values; `0.18` means 18%
* `metric_origins` identifies whether each value was reported or derived
* `sources` maps each metric name to the filing where the value came from
* `catalog_version` identifies the exact set of metric definitions and formulas used by the response

Unknown metric or metadata keys may be added without a version change. Clients should ignore keys they do not yet use.

See [Financial data](/financials/overview) for the full contract.

## Dates, timestamps, and numbers

* calendar dates use ISO `YYYY-MM-DD`
* timestamps use ISO 8601 with a timezone
* currencies use ISO 4217 codes where available
* standardized statement amounts are returned in base units unless the endpoint explicitly documents another scale
* missing values are `null` or absent; they are never represented by display strings such as `—`

Do not parse formatted UI labels to recover numbers.

## Binary responses

Statement source-render endpoints return `image/png`. Filing downloads may return a document response or redirect depending on the endpoint. Check `Content-Type` before decoding a response as JSON.

## Compression

Send `Accept-Encoding: br, gzip`. HTTP clients normally decompress responses automatically. Compression changes transfer size, not the JSON contract.

## Errors

Failures use the error format documented in [Errors](/errors). Always log the returned `request_id`; Rangler uses it to trace a request across the API and delivery infrastructure.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.