# Polygon on Onekey

> 4 endpoints for Polygon (0 stable, 4 beta), 1 to 5 credits each. Category: Finance & markets. One key, one JSON shape.

Base URL: https://api.onekey.dev
Auth: header `x-api-key: <key>`. Call shape: `GET /v1/{platform}/{endpoint}?{params}`.
Every response is `{success, data, metadata, error}`; check `success` first. Cost is in `metadata.credits_charged`. Free when served from cache (0.2 credit for a cached response over 100 KB). Failed and not-found calls are refunded.
Status: stable = verified against the live source; beta = not yet verified, fields may be missing.

Page: https://onekey.dev/platforms/polygon
Reference (Markdown): https://onekey.dev/docs/api/polygon.md
All docs: https://onekey.dev/llms.txt

## Canonical fields returned

Unified-schema fields (same names on every platform), with how many of the 4 mapped Polygon endpoints return each:

- `market.symbol` (string): 3
- `entity.category` (string): 2
- `entity.date` (ISO 8601 date): 2
- `entity.name` (string): 2
- `entity.type` (string): 2
- `market.close` (number): 2
- `market.exchange` (string): 2
- `market.high` (number): 2
- `market.low` (number): 2
- `market.open` (number): 2
- `market.volume` (number): 2
- `entity.createdAt` (ISO 8601 date): 1
- `entity.description` (string): 1
- `entity.url` (URL): 1
- `market.marketCap` (number): 1
- plus 2 platform-specific fields under `ext.`

## Endpoints

### polygon.aggregates

Daily OHLCV bars for a ticker between two dates.
- Price: 5 credits per fresh call. Status: beta. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/polygon/aggregates?ticker=AAPL&from_date=2026-09-01&to_date=2026-09-26` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `ticker` (string, required): Ticker, e.g. AAPL
  - `from_date` (string, required): From YYYY-MM-DD
  - `to_date` (string, required): To YYYY-MM-DD
- Fields returned: `entity.date`, `market.open`, `market.high`, `market.low`, `market.close`, `market.volume`, `ext.vwap`
- Reference: https://onekey.dev/docs/api/polygon/aggregates.md

### polygon.previous_close

Previous trading day OHLCV for a ticker.
- Price: 1 credit per fresh call. Status: beta. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/polygon/previous_close?ticker=AAPL` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `ticker` (string, required): Ticker, e.g. AAPL
- Fields returned: `market.symbol`, `market.open`, `market.high`, `market.low`, `market.close`, `market.volume`, `entity.date`, `ext.vwap`
- Reference: https://onekey.dev/docs/api/polygon/previous_close.md

### polygon.ticker_details

Reference details for a ticker.
- Price: 1 credit per fresh call. Status: beta. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/polygon/ticker_details?ticker=AAPL` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `ticker` (string, required): Ticker, e.g. AAPL
- Fields returned: `market.symbol`, `entity.name`, `entity.description`, `entity.category`, `market.exchange`, `entity.type`, `market.marketCap`, `entity.url`, `entity.createdAt`, `ext.employees`
- Reference: https://onekey.dev/docs/api/polygon/ticker_details.md

### polygon.ticker_search

Search reference tickers.
- Price: 5 credits per fresh call. Status: beta. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/polygon/ticker_search?q=apple` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `q` (string, required): Search text
- Fields returned: `market.symbol`, `entity.name`, `entity.category`, `market.exchange`, `entity.type`
- Reference: https://onekey.dev/docs/api/polygon/ticker_search.md

## Sample request

```bash
curl "https://api.onekey.dev/v1/polygon/previous_close?ticker=AAPL" \
  -H "x-api-key: YOUR_API_KEY"
```