Skip to main content
GET
/
v1
/
datasets
/
{dataset_id}
/
query
Query dataset
curl --request GET \
  --url https://api.gridcertainty.com/v1/datasets/{dataset_id}/query \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {}
  ],
  "meta": {
    "page": 123,
    "limit": 123,
    "page_size": 123,
    "hasNextPage": true,
    "cursor": "<string>"
  },
  "dataset_metadata": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.gridcertainty.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
dataset_id
string
required

Dataset identifier.

Query Parameters

​
order
enum<string>
default:asc

Sort order.

Available options:
asc,
desc
​
filter_column
string

Column name to filter on.

​
filter_value
string

Filter value for the selected filter column.

​
filter_operator
string
default:eq

Filter operator.

​
limit
integer

Optional limit for returned rows.

​
page
integer
default:1

Page number.

​
page_size
integer
default:500

Page size.

​
columns
string

Comma-separated list of columns to return.

​
cursor
string

Cursor for pagination.

​
timezone
string
default:UTC

Timezone for localized datetime output.

​
time
string

Single timestamp filter value.

​
time_comparison
string
default:=

Comparison operator for time.

​
start_time
string

Start of time range filter.

​
end_time
string

End of time range filter.

​
publish_time
string

Single publish time filter.

​
publish_time_start
string

Start of publish time range filter.

​
publish_time_end
string

End of publish time range filter.

​
resample_frequency
string

Resample interval such as 5min or 1h.

​
resample_by
string

Comma-separated grouping columns for resampling.

​
resample_function
string
default:mean

Aggregation function used during resampling.

​
return_format
enum<string>
default:json

Return response as JSON or CSV.

Available options:
json,
csv
​
download
boolean
default:false

Set true to request a downloadable attachment response.

​
json_schema
string
default:array_of_objects

Optional JSON schema output mode.

Response

Query results

​
data
object[]
​
meta
object
​
dataset_metadata
object