Skip to content
ChartDeck Developer API docs Account Get an API key

GET /v1/news

#GET /v1/newslistNews

News stories, newest first (one row per story, with the publishers that reported it)

Scopenews:read
Lowest tiersandbox
Weight (units)1
Paginatedyes: follow meta.next_cursor
SDKPython client.news.list ยท JavaScript cd.news.list

Parameters

ParameterInTypeDescription
assetquerystringCoin or asset ticker.
categoryquerystringNews category.
sourcequerystringSource id (see /v1/news/sources).
sincequerystringOnly stories after this time (unix seconds or RFC 3339).
qquerystringWords in the headline.
minqueryintegerLowest importance, 1 to 3.
cursorquerystringmeta.next_cursor of the previous page (opaque; bound to the route).
limitqueryintegerRows per page, at most 100 (default 50).

Answer

data: a list of stories: the lead publisher's title, link and name; other publishers of the same story under `also`. No article text.

Errors

  • 400 invalid_param, invalid_cursor
  • 401 unauthorized: missing, unknown, revoked or expired key
  • 403 insufficient_scope, tier_required
  • 404 not_found, not_available, not_in_sandbox
  • 422 window_too_large
  • 429 rate_limited (per minute) or quota_exhausted (month; X-Quota-* headers, Retry-After = seconds to the next month); see Retry-After
  • 503 api_disabled, overloaded

Example

Shell
curl "https://api.chartdeck.trade/v1/news" \
  -H "Authorization: Bearer $CHARTDECK_API_KEY"
Python
from chartdeck import Client

client = Client()  # reads CHARTDECK_API_KEY
r = client.news.list()
print(r.data, r.meta["attribution"])
JavaScript
import { ChartDeck } from '@chartdeck/api';

const cd = new ChartDeck();  // reads CHARTDECK_API_KEY
const r = await cd.news.list();
console.log(r.data, r.meta.attribution);

The Developer API documentation is in English.