Get Execution Result

Given an execution ID, returns result of a an execution request

You must pass the execution_id obtained from making an execute query POST request.

Result returns the status, metadata, and query results (in JSON) from a query execution.

• Results data from an execution are stored for 90 days. This is visible on the API response on the “expires_at” field in the execution status and results body.
• Dune internally has a maximum query result size limit (which currently is 8GB, but subject to increase in the future). If your query yields more than 8GB of data, the result will be truncated in storage. In such cases, pulling the result data (using pagination) but without specifying allow_partial_results set to true will trigger an error message: “error”: “Partial Result, please request with ‘allows_partial_results=true’“. If you wish to retrieve partial results, you can pass the parameter allow_partial_results=true. But please make sure you indeed want to fetch the truncated result.
• We recommend reading about Pagination to get the most out of the API and handle large results.

Execute query and get result in one call

If you are using the Python SDK or community Typescript SDK, you can directly execute and fetch a result in one function call, like below:

• Python SDK
• Typescript SDK

import dotenv, os, json
from dune_client.types import QueryParameter
from dune_client.client import DuneClient
from dune_client.query import QueryBase

# change the current working directory where .env file lives
os.chdir("/Users/abc/local-Workspace/python-notebook-examples")
# load .env file
dotenv.load_dotenv(".env")
# setup Dune Python client
dune = DuneClient.from_env()

Use run_query to get result in JSON, run_query_csv to get result in CSV format, and run_query_dataframe to get result in Pandas dataframe

result = dune.run_query(
    query=query # pass in query to run 
    , performance = 'large' # optionally define which tier to run the execution on (default is "medium")
    )

Headers

X-DUNE-API-KEY

string

required

API Key for the service

Path Parameters

execution_id

string

required

unique identifier of the execution

Query Parameters

api_key

string

API Key for the service, alternative to using the HTTP header X-DUNE-API-KEY.

limit

integer

required

Limit number of rows to return. This together with 'offset' allows easy pagination through results in an incremental and efficient way. This parameter is incompatible with sampling (sample_count).

offset

integer

Offset row number to start (inclusive, first row means offset=0) returning results from. This together with 'limit' allows easy pagination through results in an incremental and efficient way. This parameter is incompatible with sampling (sample_count).

sample_count

integer

Number of rows to return from the result by sampling the data. This is useful when you want to get a uniform sample instead of the entire result. If the result has less than the sample count, the entire result is returned. Note that this will return a randomized sample, so not every call will return the same result. This parameter is incompatible with offset, limit, and filters parameters.

filters

string

Expression to filter out rows from the results to return. This expression is similar to a SQL WHERE clause. More details about it in the Filtering section of the doc. This parameter is incompatible with sample_count.

sort_by

string

Expression to define the order in which the results should be returned. This expression is similar to a SQL ORDER BY clause. More details about it in the Sorting section of the doc.

columns

string

Specifies a comma-separated list of column names to return. If omitted, all columns are included. Tip: use this to limit the result to specific columns, reducing datapoints cost of the call.

ignore_max_datapoints_per_request

boolean

There is a default 250,000 datapoints limit to make sure you don't accidentally spend all your credits in one call. To ignore the max limit, you can add ignore_max_datapoints_per_request=true

allow_partial_results

boolean

This enables returning a query result that was too large and only a partial result is available. By default allow_partial_results is set to false and a failed state is returned.

Response

200 - application/json

execution_id

string

required

Unique identifier for the execution of the query.

query_id

integer

required

Unique identifier of the query.

state

string

required

The state of the query execution.

submitted_at

string

required

Timestamp of when the query was submitted.

is_execution_finished

boolean

Whether the state of the query execution is terminal. This can be used for polling purposes.

expires_at

string

Timestamp of when the query result expires.

execution_started_at

string

Timestamp of when the query execution started.

execution_ended_at

string

Timestamp of when the query execution ended.

cancelled_at

string

Timestamp of when the query execution was cancelled, if applicable.

next_offset

integer

Offset that can be used to retrieve the next page of results.

next_uri

string

URI that can be used to fetch the next page of results.

result

object

Show child attributes

error

object

Show child attributes