Turso Databases can be accessed via HTTP. The API enable developers to perform SQL operations using the Hrana over HTTP protocol, retrieve server version information, and monitor the health status.

It’s recommended you use a native SDK.

​
Base URL

Simply replace your database URL protocol libsql:// with https://:

https://[databaseName]-[organizationName].turso.io

You can obtain your database base URL from the Turso CLI:

​
Authentication

Turso uses Bearer authentication, and requires your API token to be passed with all protected requests in the Authorization header:

Authorization: Bearer TOKEN

​
Endpoints

Your database has the endpoints available below:

​
POST /v2/pipeline

You can use the /v2/pipeline endpoint to query a database. The endpoint accepts a series of operations to perform against a database connection. The supported operation types are:

  • execute: execute a statement on the connection.
  • close: close the connection.

​
Simple query

{
  "requests": [
    { "type": "execute", "stmt": { "sql": "CREATE TABLE users (name)" } },
    { "type": "close" }
  ]
}

Connections are left open until they timeout, unless you close them explicitly in the request (as shown above). Every request made on a connection bumps the timeout. You should close the connection when it’s no longer needed.

​
Parameter binding

Queries with bound parameters come in two types:

  1. Positional query parameters, bound by their position in the parameter list, and prefixed ?. If the query uses positional parameters, the values should be provided as an array to the args field.
{
  "requests": [
    {
      "type": "execute",
      "stmt": {
        "sql": "SELECT * FROM users WHERE name = ?",
        "args": [
          {
            "type": "text",
            "value": "Turso"
          }
        ]
      }
    },
    {
      "type": "close"
    }
  ]
}

  1. Named bound parameters, where the parameter is referred to by a name and is prefixed with a :, a @ or a $. If the query uses named parameters, then the named_args field of the query should be an array of objects mapping parameters to their values.
{
  "requests": [
    {
      "type": "execute",
      "stmt": {
        "sql": "SELECT * FROM users WHERE name = :name OR name = $second_name OR name = @third_name",
        "named_args": [
          {
            "name": "name",
            "value": {
              "type": "text",
              "value": "Turso"
            }
          },
          {
            "name": "second_name",
            "value": {
              "type": "text",
              "value": "Not Turso"
            }
          },
          {
            "name": "third_name",
            "value": {
              "type": "text",
              "value": "Maybe Turso"
            }
          }
        ]
      }
    },
    {
      "type": "close"
    }
  ]
}

The name property of each named_args can match the prefix or omit the prefix. They were omitted in the example above, but both versions are valid.

The type field within each arg corresponds to the column datatype and can be one of the following: null, integer, float, text, or blob.

If using the blob type, replace the value property with base64 and encode the argument into base64 before sending the request.

In JSON, the value is a String to avoid losing precision, because some JSON implementations treat all numbers as 64-bit floats.

​
Interactive query

Sometimes, it may be desirable to perform multiple operation on the same connection, in multiple roundtrips. We can do this by not closing the connection right away:

{
  "requests": [{ "type": "execute", "stmt": { "sql": "BEGIN" } }]
}

We can see that we have received a baton back. This is because we haven’t closed the connection. We can now use this baton to perform more queries on the same connection:

Body
{
  "baton": "m7lVVgEvknpf1P1irxHsHqrAqH7BLiwO4DQIAwr93PdZWGvdBNugLSokSsCZNkry",
  "requests": [
    { "type": "execute", "stmt": { "sql": "CREATE TABLE users (name)" } },
    {
      "type": "execute",
      "stmt": { "sql": "INSERT INTO users VALUES (\"iku\")" }
    },
    { "type": "execute", "stmt": { "sql": "COMMIT" } },
    { "type": "close" }
  ]
}

Note that both transactions and connections have timeouts. Transaction have a 5 seconds window to complete, while connections get closed after 10 seconds of idle time.

​
Response types

The response from Hrana contains the following fields:

FieldTypeDescription
batonstringThe baton is used to identify a connection with the server so that it can be reused.
base_urlstringThe base URL of the server that handled the request. This URL can be reused for subsequent requests to force routing to that server.
resultsarrayThe results for each of the requests made in the pipeline.

The results array contains the results for each of the requests made in the pipeline. Each result has the following fields:

FieldTypeDescription
colsarrayThe list of columns for the returned rows.
rowsarrayThe rows returned for the query.
affected_row_countintegerThe number of rows affected by the query.
last_insert_rowidintegerThe ID of the last inserted row.
replication_indexstringThe replication timestamp at which this query was executed.

​
GET /version

To obtain the current version of the server running your database you can use the /version endpoint:

curl -L -X GET 'https://[databaseName]-[organizationName].turso.io/version' \
  -H 'Authorization: Bearer TOKEN'

​
GET /health

To check the health of your database, you can use the /health endpoint which returns an empty body with an HTTP status:

curl -L -X GET 'https://[databaseName]-[organizationName].turso.io/health' \
  -H 'Authorization: Bearer TOKEN'

Was this page helpful?

QuickstartFlutter