# finance.markets

**stable** **Standard**

Market movers for the day (biggest gainers, biggest losers or most active stocks).

`GET /v1/finance/markets`

## What you get

A list of Finance results in Onekey's unified shape, in `data` (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free `404 not_found` instead.

## What it costs

- **Standard · 1 credit** for a fresh fetch, charged only when it succeeds.
- **Free when served from cache (0.2 credit for a cached response over 100 KB).**
- **Free** if the request is invalid (never charged) or the source fails or reports not found (refunded).

## Parameters

| Name | Type | Required | Default | What it is | Constraints |
| --- | --- | --- | --- | --- | --- |
| `screen` | string | no | `day_gainers` | Which list: day_gainers, day_losers or most_actives | max 12 chars; must match `day_gainers\|day_losers\|most_actives`; trimmed, lowercased |
| `n` | string | no | `25` | Rows (1-50) | max 2 chars; must match `[1-9]\|[1-4]\d\|50`; trimmed |

## Request

```bash
curl "https://api.onekey.dev/v1/finance/markets?screen=day_gainers" \
  -H "x-api-key: YOUR_API_KEY"
```

```python
import requests

res = requests.get(
    "https://api.onekey.dev/v1/finance/markets",
    params={"screen": "day_gainers"},
    headers={"x-api-key": "YOUR_API_KEY"},
)
body = res.json()

if body["success"]:
    print(body["data"])
else:
    print(body["error"]["code"], body["error"]["message"])
```

```javascript
const params = new URLSearchParams({ screen: "day_gainers" });
const res = await fetch(`https://api.onekey.dev/v1/finance/markets?${params}`, {
  headers: { "x-api-key": "YOUR_API_KEY" },
});
const body = await res.json();

if (body.success) console.log(body.data);
else console.error(body.error.code, body.error.message);
```

## Recorded response

A real Finance response, recorded and returned in Onekey's shape. Fields the platform does not provide are `null`.

```json
{
  "success": true,
  "data": [
    {
      "market": {
        "symbol": "MAT",
        "exchange": "NasdaqGS",
        "currency": "USD",
        "price": 14.855,
        "volume": 26208857,
        "marketCap": 4244073472
      },
      "entity": {
        "name": "Mattel, Inc.",
        "category": "EQUITY",
        "date": "2026-10-01T19:41:04Z"
      },
      "ext": {
        "change": 2.1949997,
        "changePercent": 17.33807
      }
    },
    {
      "market": {
        "symbol": "ACN",
        "exchange": "NYSE",
        "currency": "USD",
        "price": 214.65,
        "volume": 23639619,
        "marketCap": 131353362432
      },
      "entity": {
        "name": "Accenture plc",
        "category": "EQUITY",
        "date": "2026-10-01T19:41:03Z"
      },
      "ext": {
        "change": 31.279999,
        "changePercent": 17.058407
      }
    }
  ],
  "metadata": {
    "platform": "finance",
    "endpoint": "markets",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 1,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}
```

## Field mapping

How this endpoint's source fields become Onekey's [unified schema](https://onekey.dev/docs/schema.md). Fields the source lacks come back as `null`.

| Source path | Onekey field | Transform |
| --- | --- | --- |
| `symbol` | `market.symbol` | - |
| `longName` | `entity.name` | - |
| `quoteType` | `entity.category` | - |
| `fullExchangeName` | `market.exchange` | - |
| `currency` | `market.currency` | - |
| `regularMarketPrice` | `market.price` | `toNumber` |
| `regularMarketChange` | `ext.change` | `toNumber` |
| `regularMarketChangePercent` | `ext.changePercent` | `toNumber` |
| `regularMarketVolume` | `market.volume` | `toNumber` |
| `marketCap` | `market.marketCap` | `toNumber` |
| `regularMarketTime` | `entity.date` | `toIsoDate` |

## Caching and freshness

- Fresh for about 30 seconds. Repeat calls in that window are served from cache and are free.
- Between 30 seconds and 5 minutes the cached copy is still served instantly and marked `stale: true` while Onekey refreshes it in the background.
- If the source is down when a refresh is needed, the last copy can be served for up to 1 hour more (marked stale).
- A "not found" is remembered for 1 minute and is free.
- The cache is shared across all customers, which is what keeps repeat calls cheap.

## What can go wrong

| Status | Code | What to do |
| --- | --- | --- |
| 401 | `unauthorized` | Check the `x-api-key` header. |
| 402 | `insufficient_credits` | [Add credits](https://onekey.dev/pricing); your balance must cover the price. |
| 404 | `not_found` | Unknown endpoint path. |
| 422 | `invalid_params` | Fix the parameters using the table above. Free. |
| 429 | `rate_limited` | Wait `Retry-After` seconds, then retry. |
| 502 | `upstream_error` | The source failed. Refunded; retry with backoff. |

See [Errors](https://onekey.dev/docs/errors.md) for the full list and retry guidance.

Status: stable (verified against the live source).