# Alpha Vantage on Onekey

> 3 endpoints for Alpha Vantage (0 stable, 3 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/alphavantage
Reference (Markdown): https://onekey.dev/docs/api/alphavantage.md
All docs: https://onekey.dev/llms.txt

## Canonical fields returned

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

- `entity.category` (string): 2
- `market.symbol` (string): 2
- `author.displayName` (string): 1
- `content.createdAt` (ISO 8601 date): 1
- `content.text` (string): 1
- `content.title` (string): 1
- `content.url` (URL): 1
- `entity.description` (string): 1
- `entity.name` (string): 1
- `market.exchange` (string): 1
- `market.marketCap` (number): 1
- `market.price` (number): 1
- `market.volume` (number): 1
- plus 10 platform-specific fields under `ext.`

## Endpoints

### alphavantage.news_sentiment

Market news with sentiment scores (optionally filtered by ticker).
- Price: 5 credits per fresh call. Status: beta. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/alphavantage/news_sentiment?ticker=AAPL` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `ticker` (string, required): Ticker, e.g. AAPL
- Fields returned: `content.title`, `content.text`, `content.url`, `content.createdAt`, `author.displayName`, `entity.category`, `ext.sentimentScore`
- Reference: https://onekey.dev/docs/api/alphavantage/news_sentiment.md

### alphavantage.overview

Company overview and fundamentals for a US ticker.
- Price: 1 credit per fresh call. Status: beta. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/alphavantage/overview?symbol=IBM` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `symbol` (string, required): Ticker, e.g. IBM
- Fields returned: `market.symbol`, `entity.name`, `entity.description`, `entity.category`, `market.exchange`, `market.marketCap`, `ext.industry`, `ext.country`, `ext.peRatio`, `ext.eps`, `ext.dividendYield`, `ext.high52w`, `ext.low52w`
- Reference: https://onekey.dev/docs/api/alphavantage/overview.md

### alphavantage.top_movers

US market top gainers, losers and most active.
- Price: 5 credits per fresh call. Status: beta. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/alphavantage/top_movers` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `market.symbol`, `market.price`, `market.volume`, `ext.change`, `ext.changePct`
- Reference: https://onekey.dev/docs/api/alphavantage/top_movers.md

## Sample request

```bash
curl "https://api.onekey.dev/v1/alphavantage/overview?symbol=IBM" \
  -H "x-api-key: YOUR_API_KEY"
```