> ## 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.

# API reference

> Explore the paid Rangler API contract and test requests against live or sandbox.

The API reference is generated from Rangler's curated customer OpenAPI contract.

## Base URLs

| Environment | Base URL | Key prefix |
| - | - | - |
| Live | `https://api.rangler.co` | `rgl_live_` |
| Sandbox | `https://sandbox-api.rangler.co` | `rgl_test_` |

## Authentication

Customer API endpoints use an organization API key:

```http theme={null}
X-API-Key: rgl_live_your_key_here
```

Portal management endpoints use a bearer token and are published under `/developer/v1`.

## Company identifiers

Most company-specific endpoints use the stable company `id` in the path. First call `GET /v1/companies` to find a company by ticker or name, then pass its `id` to routes such as `GET /v1/companies/{company_id}/estimates/grid`.

Financial statement and ratio routes accept a ticker or company UUID through the `company` query parameter. Start with `GET /v1/company/financials/income-statement/standardized`. The chart route also accepts either an NGX ticker or company UUID: `GET /v1/companies/{company_ref}/chart`.

## Paid data

The customer reference covers financial statements, estimates, analyst recommendations, compact NGX equity and ETF snapshots, one company-and-fund price-chart contract, company calendars and meeting media, board changes, dividends, insider dealings, company mentions, news, upcoming events, and the NGX market clock. Routes that require paid access are labeled in the reference.

Forecast endpoints are read-only for API-key consumers. API keys cannot submit, revise, or withdraw forecasts.

<Note>
  The NGX clock reports regular weekday hours and returns `holiday_adjusted: false`. Do not treat it as an exchange-holiday calendar.
</Note>

<Warning>
  Keep live API keys on your server. Do not expose them in browsers, mobile applications, public repositories, or client-side environment variables.
</Warning>

## Using the playground

Choose an endpoint from the navigation, select live or sandbox, enter the appropriate credential, and send the request. Mintlify proxies playground requests so browser CORS policy does not block the test.

For integration guidance, start with [Authentication](/authentication), [Response conventions](/responses), and [Errors](/errors).


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