Skip to main content
POST
/
db
/
query
// Named parameters example
const response = await fetch('https://api.worqhat.com/db/query', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_API_KEY'
  },
  body: JSON.stringify({
    query: "SELECT * FROM likes_data WHERE slug = {slug}",
    params: { slug: "summer-vacation-tips" },
    environment: "production"
  })
});
const data = await response.json();
console.log(data);
{
  "success": true,
  "data": [
    {}
  ],
  "query": "SELECT * FROM users WHERE slug = $1",
  "executionTime": 42
}

Authorizations

​
Authorization
string
header
required

API key authentication. Format - "Bearer YOUR_API_KEY"

Body

application/json
​
query
string
required

SQL query to execute. Supports both named parameters ({param}) and positional parameters ($1, $2)

Example:

"SELECT * FROM users WHERE slug = {slug}"

​
params

Named parameters for queries with {param} syntax

Example:
{ "slug": "summer-vacation-tips" }
​
environment
enum<string>

Environment to query (development, staging, production)

Available options:
development,
staging,
production
Example:

"production"

Response

Query executed successfully

​
success
boolean
Example:

true

​
data
object[]
​
query
string

The executed SQL query

Example:

"SELECT * FROM users WHERE slug = $1"

​
executionTime
integer

Query execution time in milliseconds

Example:

42