On-chain Data SQL Query

Schema

If you want to leverage LLM to generate sql queries, you can refer to below schemas as prompt to the LLM:

POST /ai-agent-backend/sql_query

This endpoint allows you to send SQL queries to the CARV backend to fetch on-chain data.

Request Parameters

Name
Location
Type
Required
Description

sql_content

Body

string

Yes

The SQL query to be executed.

Example Request

curl -X POST https://interface.carv.io/ai-agent-backend/sql_query \
     -H "Content-Type: application/json" \
     -H "Authorization: <YOUR_AUTH_TOKEN>" \
     -d '{"sql_content":"WITH address_activity AS (SELECT from_address AS address, COUNT(*) AS tx_count FROM eth.transactions WHERE date_parse(date, '\''%Y-%m-%d'\'') >= date_add('\''month'\'', -3, current_date) GROUP BY from_address UNION ALL SELECT to_address AS address, COUNT(*) AS tx_count FROM eth.transactions WHERE date_parse(date, '\''%Y-%m-%d'\'') >= date_add('\''month'\'', -3, current_date) GROUP BY to_address) SELECT address, SUM(tx_count) AS total_transactions FROM address_activity GROUP BY address ORDER BY total_transactions DESC LIMIT 1;"}'

Example Response

200 OK Response

{
    "code": 0,
    "msg": "Success",
    "data": {
        "column_infos": [
            "address",
            "total_transactions"
        ],
        "rows": [
            {
                "items": [
                    "0xdac17f958d2ee523a2206206994597c13d831ec7",
                    "11021156"
                ]
            }
        ]
    }
}

400 Bad Request Response

{
  "error": "Invalid SQL query."
}

Response Status Codes

Status Code
Description
Data Model

200

OK

Inline

400

Bad Request

Inline

Response Data Structure

200 OK

Field
Type
Required
Constraints
Description

code

integer

Yes

None

Status code.

msg

string

Yes

None

Response message.

data

object

Yes

None

Data from the query.

column_infos

array

Yes

None

Column headers of data.

rows

array

Yes

None

Query result rows.

400 Bad Request

Field
Type
Required
Constraints
Description

error

string

Yes

None

Error message.

Last updated