Skip to main content
GET
Get Chart Data

Authorizations

X-Blockworks-API-Key
string
header
required

API key sent in the X-Blockworks-API-Key header. Send it on its own: the charts endpoints reject a request that carries a second credential.

Path Parameters

visualizationId
integer
required

The chart id from List Charts.

Query Parameters

page
integer
default:1

Page number, starting at 1.

Required range: x >= 1
limit
integer
default:10000

Rows per page.

Required range: 1 <= x <= 100000

Keeps only rows where some value, in any column, contains this term (case-insensitive). Applied before paging.

select
string[]

Comma-separated column names to keep in each row. Omit to return every column.

order_by
string

Column to sort the rows by. Without it, rows come back in the order the chart's query produced them.

order_dir
enum<string>
default:asc

Sort direction, used with order_by.

Available options:
asc,
desc

Response

One page of the chart's rows.

page
integer
required

The page returned.

total
integer
required

Number of rows matching the request across all pages, after search is applied.

data
object[]
required

One object per row. The keys are the columns of the chart's query, narrowed by select when it is passed.