API Reference (beta)
The parsers.dev API is organized around REST with JSON request and responses and uses standard HTTP response codes.
Last updated
Was this helpful?
The parsers.dev API is organized around REST with JSON request and responses and uses standard HTTP response codes.
Last updated
Was this helpful?
The current API status is BETA. Minor changes are possible before leaving this status. After fixing the state, JSON-schemas will be published, with a description of the formats of requests and responses
The parsers.dev API uses API key to authenticate requests. You can view and manage your API key in the Account Settings.
The parsers.dev APIs is a REST-based service. Subsequently, all requests to the APIs require this HTTP header:
x-api-key: Your parsers.dev API keyThe parsers.dev APIs is also a JSON-based service. You have to add Content-Type HTTP header to all your requests:
Content-Type: application/jsonOnly one API version is operating at this time. Use this base URL for your requests:
https://api.parsers.dev/api/v1
All responses are JSON-based and follow one of these formats:
// successful response
{
"status": "OK",
"data": {...}
}
}// error response
{
"status": "ERROR",
"data": {
"code": <http-code>,
"message": "<error-message>",
"details": <mixed-object(optional)>,
}
}Http codes and error message you can find at Errors section
POST https://api.parsers.dev/api/v1/parse/:dialect
This endpoint allows you to get Abstract Syntax Tree represented in your SQL-queries. You can parse any supported syntax (DDL, DML, DCL, TCL, and another specific syntax). :dialect is SQL dialect type (postgresql, snowflake and cypher are supported)
x-api-key
string
Authentication token (your api key from parsers.dev or holistic.dev account settings)
sql
string
SQL source code, separated using semicolon
{
"status": "OK",
"data": {
"compiled": {
"ddl": {
"relations": [
{
"type": "TABLE",
"names": {
"original": {
"schema": "public",
"name": "t"
}
},
"columns": [
{
"names": {
"original": "a"
},
"type": {
"schema": "pg_catalog",
"name": "integer",
"mods": [],
"array": {
"dimension": 0,
"bounds": []
}
},
"kind": "column",
"nullable": "yes",
"sequence": null
}
],
"indexes": [],
"constraints": [
{
"type": "CONSTR_NULL",
"relation": {
"schema": "public",
"name": "t"
},
"name": null,
"columns": [
"a"
],
"constraint": {
"ast": null,
"compiled": null
}
}
],
"partition": null,
"inherit": null
}
],
"types": [],
"functions": [],
"operators": [],
"sequences": [],
"schemas": [],
"extensions": []
},
"dmls": [
[
{
"fields": [
{
"names": {
"original": "a",
"local": "a"
},
"type": {
"schema": "pg_catalog",
"name": "integer",
"mods": [],
"array": {
"dimension": 0,
"bounds": []
}
},
"source": {
"relation": {
"schema": "public",
"name": "t"
},
"field": "a"
},
"aggregate": false,
"over": null,
"value": null,
"kind": "column",
"expressionOf": null,
"nullable": "yes",
"sequence": null,
"locations": [
{
"action": "add",
"place": "inline",
"location": {
"location": {
"from": 16,
"to": null
},
"id": 0,
"filename": ""
}
}
],
"sublink": null
}
],
"constraints": [],
"linesCount": "MANY_OR_NONE",
"linkedWith": {
"relations": [
{
"schema": "public",
"name": "t",
"type": "SELECT"
}
],
"columns": []
},
"error": null
},
{
"fields": [
{
"names": {
"original": "a",
"local": "a"
},
"type": {
"schema": "pg_catalog",
"name": "integer",
"mods": [],
"array": {
"dimension": 0,
"bounds": []
}
},
"source": {
"relation": {
"schema": "public",
"name": "t"
},
"field": "a"
},
"aggregate": false,
"over": null,
"value": null,
"kind": "column",
"expressionOf": null,
"nullable": "yes",
"sequence": null,
"locations": [
{
"action": "add",
"place": "inline",
"location": {
"location": {
"from": 16,
"to": null
},
"id": 0,
"filename": ""
}
}
],
"sublink": null
}
],
"constraints": [],
"linesCount": "MANY_OR_NONE",
"linkedWith": {
"relations": [
{
"schema": "public",
"name": "t",
"type": "SELECT"
}
],
"columns": []
},
"error": null
}
],
[
{
"error": {
"from": 6,
"to": null
}
}
],
[
{
"fields": [
{
"names": {
"original": "a",
"local": "a"
},
"type": {
"schema": "pg_catalog",
"name": "integer",
"mods": [],
"array": {
"dimension": 0,
"bounds": []
}
},
"source": {
"relation": {
"schema": "public",
"name": "t"
},
"field": "a"
},
"aggregate": false,
"over": null,
"value": null,
"kind": "column",
"expressionOf": null,
"nullable": "no",
"sequence": null,
"locations": [
{
"action": "add",
"place": "inline",
"location": {
"location": {
"from": 16,
"to": null
},
"id": 0,
"filename": ""
}
}
],
"sublink": null
}
],
"constraints": [
{
"type": "CONSTR_NOTNULL",
"place": "generated-notnull",
"name": null,
"relation": null,
"columns": [
"a"
],
"constraint": {
"ast": null,
"compiled": null
},
"location": {
"filename": "",
"id": 0,
"location": {
"from": 0,
"to": null
}
}
}
],
"linesCount": "MANY_OR_NONE",
"linkedWith": {
"relations": [
{
"schema": "public",
"name": "t",
"type": "SELECT"
}
],
"columns": []
},
"error": null
}
]
]
},
}
}
}{
"status": "ERROR",
"data": {
"code": 404,
"message": "USER_NOT_FOUND",
"details": {
"api": {
"key": "..."
}
}
}
}Example:
{
"sql": "CREATE TABLE t(); SELECT 1; SELECT 1 FROM ; SELECT 2"
}const axios = require ('axios');
const api_key = '<your-api-key>';
const data = {
sql: 'CREATE TABLE t(); SELECT 1; SELECT 1 FROM ; SELECT 2',
};
axios({
method: 'POST',
headers: {
'Content-Type': 'application/json',
'x-api-key': api_key,
},
data,
url: `https://api.parsers.dev/api/v1/parse/postgresql/`,
}).then((response) => {
console.log(response.data);
})
.catch(function (error) {
console.error('api.parsers.dev error:');
console.error(JSON.stringify(error.response.data, null, 2));
});
PARSERSDEV_API_KEY="<your-api-key>"; \
echo "{\"sql\": \"CREATE TABLE t(); SELECT 1; SELECT 2\"}" | \
curl \
--header "x-api-key: $PARSERSDEV_API_KEY" \
--header "Content-Type: application/json" \
--request POST --data @- https://api.parsers.dev/api/v1/parse/postgresql/POST https://api.parsers.dev/api/v1/compile/:dialect
This endpoint allows you to get a special object compiled based on your DDL or DML query. Because DML strictly depends on database schema (DDL), DML can be compiled to a special object, based on DDL only. :dialect is SQL dialect type (postgresql and snowflake only).
ast
string
any value for AST in result
x-api-key
string
Authentication token (your api key from parsers.dev or holistic.dev account settings)
ddl
string
Database schema (DDL statements) source code, separated using semicolon
dmls
array
An array of DML queries. Each query can consist of many statements, separated using a semicolon
{
"status": "OK",
"data": {
"compiled": {
"ddl": {
"relations": [
{
"type": "TABLE",
"names": {
"original": {
"schema": "public",
"name": "t"
}
},
"columns": [
{
"names": {
"original": "a"
},
"type": {
"schema": "pg_catalog",
"name": "integer",
"mods": [],
"array": {
"dimension": 0,
"bounds": []
}
},
"kind": "column",
"nullable": "yes",
"sequence": null
}
],
"indexes": [],
"constraints": [
{
"type": "CONSTR_NULL",
"relation": {
"schema": "public",
"name": "t"
},
"name": null,
"columns": [
"a"
],
"constraint": {
"ast": null,
"compiled": null
}
}
],
"partition": null,
"inherit": null
}
],
"types": [],
"functions": [],
"operators": [],
"sequences": [],
"schemas": [],
"extensions": []
},
"dmls": [
[
{
"fields": [
{
"names": {
"original": "a",
"local": "a"
},
"type": {
"schema": "pg_catalog",
"name": "integer",
"mods": [],
"array": {
"dimension": 0,
"bounds": []
}
},
"source": {
"relation": {
"schema": "public",
"name": "t"
},
"field": "a"
},
"aggregate": false,
"over": null,
"value": null,
"kind": "column",
"expressionOf": null,
"nullable": "yes",
"sequence": null,
"locations": [
{
"action": "add",
"place": "inline",
"location": {
"location": {
"from": 16,
"to": null
},
"id": 0,
"filename": ""
}
}
],
"sublink": null
}
],
"constraints": [],
"linesCount": "MANY_OR_NONE",
"linkedWith": {
"relations": [
{
"schema": "public",
"name": "t",
"type": "SELECT"
}
],
"columns": []
},
"error": null
},
{
"fields": [
{
"names": {
"original": "a",
"local": "a"
},
"type": {
"schema": "pg_catalog",
"name": "integer",
"mods": [],
"array": {
"dimension": 0,
"bounds": []
}
},
"source": {
"relation": {
"schema": "public",
"name": "t"
},
"field": "a"
},
"aggregate": false,
"over": null,
"value": null,
"kind": "column",
"expressionOf": null,
"nullable": "yes",
"sequence": null,
"locations": [
{
"action": "add",
"place": "inline",
"location": {
"location": {
"from": 16,
"to": null
},
"id": 0,
"filename": ""
}
}
],
"sublink": null
}
],
"constraints": [],
"linesCount": "MANY_OR_NONE",
"linkedWith": {
"relations": [
{
"schema": "public",
"name": "t",
"type": "SELECT"
}
],
"columns": []
},
"error": null
}
],
[
{
"error": {
"from": 6,
"to": null
}
}
],
[
{
"fields": [
{
"names": {
"original": "a",
"local": "a"
},
"type": {
"schema": "pg_catalog",
"name": "integer",
"mods": [],
"array": {
"dimension": 0,
"bounds": []
}
},
"source": {
"relation": {
"schema": "public",
"name": "t"
},
"field": "a"
},
"aggregate": false,
"over": null,
"value": null,
"kind": "column",
"expressionOf": null,
"nullable": "no",
"sequence": null,
"locations": [
{
"action": "add",
"place": "inline",
"location": {
"location": {
"from": 16,
"to": null
},
"id": 0,
"filename": ""
}
}
],
"sublink": null
}
],
"constraints": [
{
"type": "CONSTR_NOTNULL",
"place": "generated-notnull",
"name": null,
"relation": null,
"columns": [
"a"
],
"constraint": {
"ast": null,
"compiled": null
},
"location": {
"filename": "",
"id": 0,
"location": {
"from": 0,
"to": null
}
}
}
],
"linesCount": "MANY_OR_NONE",
"linkedWith": {
"relations": [
{
"schema": "public",
"name": "t",
"type": "SELECT"
}
],
"columns": []
},
"error": null
}
]
]
},
"ast": {
"ddl": [
[
{
"query": {
"CreateStmt": {
"relation": {
"RangeVar": {
"relname": "t",
"inh": true,
"relpersistence": "p",
"location": 13
}
},
"tableElts": [
{
"ColumnDef": {
"colname": "a",
"typeName": {
"TypeName": {
"names": [
{
"String": {
"str": "pg_catalog"
}
},
{
"String": {
"str": "int4"
}
}
],
"typemod": -1,
"location": 18
}
},
"is_local": true,
"location": 16
}
}
],
"oncommit": 0
}
},
"error": null
},
{
"query": null,
"sql": "CREATE",
"error": {
"location": 31
}
}
]
],
"dmls": [
[
{
"query": [
{
"SelectStmt": {
"targetList": [
{
"ResTarget": {
"val": {
"ColumnRef": {
"fields": [
{
"A_Star": {}
}
],
"location": -1
}
},
"location": -1
}
}
],
"fromClause": [
{
"RangeVar": {
"relname": "t",
"inh": true,
"relpersistence": "p",
"location": 6
}
}
],
"op": 0
}
}
],
"error": null
},
{
"query": [
{
"SelectStmt": {
"targetList": [
{
"ResTarget": {
"val": {
"ColumnRef": {
"fields": [
{
"A_Star": {}
}
],
"location": -1
}
},
"location": -1
}
}
],
"fromClause": [
{
"RangeVar": {
"relname": "t1",
"inh": true,
"relpersistence": "p",
"location": 6
}
}
],
"op": 0
}
}
],
"error": null
}
],
[
{
"query": null,
"sql": "table",
"error": {
"location": 6
}
}
],
[
{
"query": [
{
"SelectStmt": {
"targetList": [
{
"ResTarget": {
"val": {
"ColumnRef": {
"fields": [
{
"A_Star": {}
}
],
"location": 7
}
},
"location": 7
}
}
],
"fromClause": [
{
"RangeVar": {
"relname": "t",
"inh": true,
"relpersistence": "p",
"location": 14
}
}
],
"whereClause": {
"A_Expr": {
"kind": 0,
"name": [
{
"String": {
"str": "="
}
}
],
"lexpr": {
"ColumnRef": {
"fields": [
{
"String": {
"str": "a"
}
}
],
"location": 22
}
},
"rexpr": {
"ParamRef": {
"number": 1,
"location": 26
}
},
"location": 24
}
},
"op": 0
}
}
],
"error": null
}
]
]
}
}
}{
"status": "ERROR",
"data": {
"code": 404,
"message": "USER_NOT_FOUND",
"details": {
"api": {
"key": "..."
}
}
}
}Example:
{
"ddl": "CREATE TABLE t (a int); CREATE",
"dmls": [
"table t; table t1",
"table",
"select * FROM t WHERE a = $1"
]
}const axios = require ('axios');
const api_key = '<your-api-key>';
const data = {
ddl: 'CREATE TABLE t (a int); CREATE',
dmls: [
'table t; table t1',
'table',
'select * FROM t WHERE a = $1'
]
};
axios({
method: 'POST',
headers: {
'Content-Type': 'application/json',
'x-api-key': api_key,
},
data,
url: `https://api.parsers.dev/api/v1/compile/postgresql/`,
}).then((response) => {
console.log(response.data);
})
.catch(function (error) {
console.error('api.parsers.dev error:');
console.error(JSON.stringify(error.response.data, null, 2));
});
PARSERSDEV_API_KEY="<your-api-key>"; \
echo "{\"ddl\": \"CREATE TABLE t (a int); CREATE\", dml: [\"table t; table t1\", \"table\", \"select * FROM t WHERE a = $1\"]}" | \
curl \
--header "x-api-key: $PARSERSDEV_API_KEY" \
--header "Content-Type: application/json" \
--request POST --data @- https://api.parsers.dev/api/v1/compile/postgresql/POST https://api.parsers.dev/api/v1/tools/snowflake/getddl-reorder
Fix DDL statements ordering in GET_DDL function result
x-api-key
string
Authentication token (your api key from parsers.dev or holistic.dev account settings)
sql
string
DDL need to reorder
Example:
{
"sql": "create view v1 as select * from t; create table t (a int);"
}const axios = require ('axios');
const api_key = '<your-api-key>';
const data = {
sql: 'create view v1 as select * from t; create table t (a int);'
};
axios({
method: 'POST',
headers: {
'Content-Type': 'application/json',
'x-api-key': api_key,
},
data,
url: `https://api.parsers.dev/api/v1/tools/snowflake/getddl-reorder`,
}).then((response) => {
console.log(response.data);
})
.catch(function (error) {
console.error('api.parsers.dev error:');
console.error(JSON.stringify(error.response.data, null, 2));
});
PARSERSDEV_API_KEY="<your-api-key>"; \
echo "{\"sql\": \"Create view v1 as select * from t; create table t (a int);\"}" | \
curl \
--header "x-api-key: $PARSERSDEV_API_KEY" \
--header "Content-Type: application/json" \
--request POST --data @- https://api.parsers.dev/api/v1/tools/snowflake/getddl-reorder