Skip to navigation
API ReferenceQuery Execution

Execute SQL statement (GET method)

View as Markdown

Alternative GET method for executing SQL statements. Parameters are passed as URL query parameters. Does not support the params field.

The database can be specified in the query parameters, or defaults to the database from the authentication token or system settings.

This method is most suitable for simple, read-only queries where the statement can be safely included in a URL. For complex queries or those with parameters, use the POST method instead.

Example

GET /v1/execute?statement=SELECT%20*%20FROM%20customers%20LIMIT%2010&database=retail&format=collection

Limitations

  • URL length restrictions may limit the complexity of queries
  • No support for parameterized queries
  • Less secure for queries containing sensitive data

Authentication

AuthorizationBearer
Access token obtained from the login endpoint
OR
AuthorizationBasic
HTTP Basic authentication with username and password

Headers

Accept-EncodingstringOptional

Supported compression algorithms for responses. Multiple algorithms can be specified as a comma-separated list. Common values include ‘gzip’, ‘deflate’, ‘br’ (Brotli), or combinations like ‘gzip, br’.

Note that for large result sets, compression may produce suboptimal results. Without compression the result sets can be chunks of rows and processed in a streaming fashion. With compression the entire result set must be compressed before it is returned to the client. Thus the entire result set will be decompressed on the client before any rows can be processed

AcceptenumOptionalDefaults to application/json
Supported response media types. Note that regardless of the Accept header, large queries results will always be returned via chunked encoding. Also see the note about compression in the AcceptEncoding section.
Allowed values:
Preferred-EncodingenumOptional

Indicates the preferred encoding type from those specified in Accept-Encoding. This header provides fine-grained control when Accept-Encoding contains multiple values, allowing the client to explicitly specify which encoding is preferred for this specific request.

Allowed values:
Preferred-Compression-LevelintegerOptional

Specifies the desired compression level for the selected encoding algorithm. Values typically range from 1 (fastest, least compression) to 9 (slowest, maximum compression). The exact behavior depends on the specific compression algorithm being used.

Query parameters

statementstringRequired

SQL statement to execute. The statement must be URL-encoded.

Example: SELECT * FROM customers LIMIT 10

databasestringOptional
Target database name to execute the query against. If not specified, the database from authentication will be used.
formatenumOptionalDefaults to array

Response format:

  • array - Returns schema and data as arrays (more efficient for large datasets)
  • collection - Returns data as JSON objects (more convenient for client processing)
Allowed values:
fetch_sizeintegerOptional>=1Defaults to 100

Number of rows to return in each chunk for streaming responses.

  • For interactive applications: Use smaller values (100-1000)
  • For batch processing: Use larger values (5000-10000)

Response headers

X-QueryIdstringOptional
Unique identifier for the query
X-SQLStatestringOptional
SQL state result of the operation
X-SQLCodestringOptional
SQL code result of the operation

Response

Query executed successfully
object
OR
object

Errors

401
Unauthorized Error
404
Not Found Error
500
Internal Server Error