Skip to main content
POST
/
api
/
v1
/
data_sources
/
{data_source_id}
/
query
Execute a SQL query against a data source
curl --request POST \
  --url https://app.datafold.com/api/v1/data_sources/{data_source_id}/query \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "params": [
    "<string>"
  ]
}
'
{
  "rows": [
    {}
  ],
  "columns": [
    {
      "name": "<string>",
      "db_type": "<string>",
      "description": "<string>",
      "is_nullable": true,
      "number": 123,
      "type": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Use the 'Authorization' header with the format 'Key '

Headers

​
X-Stream-Response
string | null

Path Parameters

​
data_source_id
integer
required

Query Parameters

​
stream
boolean
default:false

Stream results as JSON

Body

application/json
​
query
string
required

SQL query to execute

​
params
string[] | null

Positional parameters for parameterized queries

Response

Successful Response

​
rows
Rows · object[]
required
​
columns
ApiQueryColumn · object[] | null