GET /v1/screener

#`GET /v1/screener`getScreener

The Market Screener's metrics table

Scope	analytics:read
Lowest tier	sandbox
Weight (units)	2
Paginated	yes: follow meta.next_cursor
SDK	Python client.screener.get · JavaScript cd.screener.get

Parameters

Parameter	In	Type	Description
`venue`	query	`string`	Only this venue.
`type`	query	`"perp" \| "spot"`	Market type.
`base`	query	`string`	Base coin.
`sort`	query	`string`	Column to sort by.
`order`	query	`"asc" \| "desc"`	Sort order.
`limit`	query	`integer`	Rows per page, at most 500 (default 100).
`cursor`	query	`string`	`meta.next_cursor` of the previous page (opaque; bound to the route).

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/screener" \
  -H "Authorization: Bearer $CHARTDECK_API_KEY"

Python

from chartdeck import Client

client = Client()  # reads CHARTDECK_API_KEY
r = client.screener.get()
print(r.data, r.meta["attribution"])

JavaScript

import { ChartDeck } from '@chartdeck/api';

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

GET /v1/screener

#GET /v1/screenergetScreener

#`GET /v1/screener`getScreener