# GDELT on Onekey

> 3 endpoints for GDELT (3 stable, 0 beta), 5 credits each. Category: News & publishing. 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/gdelt
Reference (Markdown): https://onekey.dev/docs/api/gdelt.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 GDELT endpoints return each:

- `entity.date` (ISO 8601 date): 2
- `author.displayName` (string): 1
- `content.createdAt` (ISO 8601 date): 1
- `content.language` (string): 1
- `content.title` (string): 1
- `content.url` (URL): 1
- `entity.category` (string): 1
- `media.thumbnailUrl` (URL): 1
- plus 2 platform-specific fields under `ext.`

## Endpoints

### gdelt.articles

News articles matching a query (last 3 months, newest first).
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/gdelt/articles?q=climate&n=5` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `q` (string, required): GDELT query (supports quotes and operators)
  - `n` (string, optional, default 20): Rows (1-75)
- Fields returned: `content.url`, `content.title`, `content.createdAt`, `author.displayName`, `content.language`, `entity.category`, `media.thumbnailUrl`
- Reference: https://onekey.dev/docs/api/gdelt/articles.md

### gdelt.tone_timeline

Average news tone over time for a query.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/gdelt/tone_timeline?q=climate` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `q` (string, required): GDELT query (supports quotes and operators)
- Fields returned: `entity.date`, `ext.avgTone`
- Reference: https://onekey.dev/docs/api/gdelt/tone_timeline.md

### gdelt.volume_timeline

Share of news coverage over time for a query (volume intensity).
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/gdelt/volume_timeline?q=climate` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `q` (string, required): GDELT query (supports quotes and operators)
- Fields returned: `entity.date`, `ext.volumeIntensity`
- Reference: https://onekey.dev/docs/api/gdelt/volume_timeline.md

## Sample request

```bash
curl "https://api.onekey.dev/v1/gdelt/articles?q=climate&n=5" \
  -H "x-api-key: YOUR_API_KEY"
```