InstantDB

InstantDB (Instant) is a realtime client-side database and Firebase alternative that gives apps a sync engine with multiplayer, offline mode, and optimistic updates by default. It exposes an HTTP Admin API (api.instantdb.com) for server-side InstaQL queries and InstaML transactions, plus auth, storage, presence, and a realtime WebSocket sync layer.

6 APIs 0 Features

DatabaseRealtimeSyncBackendLocal First

APIs

InstantDB Admin HTTP API

Server-side HTTP Admin API at api.instantdb.com, authenticated with a Bearer admin token and an App-Id header, that bypasses permissions to run InstaQL queries, InstaML transact...

InstantDB Query (InstaQL) API

Reads data with InstaQL, Instant's relational GraphQL-like query language, via POST /admin/query - returning nested entities in a single round trip with optional rule parameters.

InstantDB Transactions (InstaML) API

Writes, updates, links, and deletes data with InstaML transaction steps via POST /admin/transact, applied atomically as an admin that bypasses permission rules.

InstantDB Auth API

Server-side auth - mint refresh tokens, create/send/verify magic codes, look up and delete users, and sign users out - over /admin/refresh_tokens, /admin/magic_code, /admin/user...

InstantDB Storage API

Uploads, lists, and deletes files in Instant's object storage via PUT /admin/storage/upload, the $files query namespace, and the storage delete endpoints, with files surfaced as...

InstantDB Realtime Sync API

The realtime sync transport - a persistent WebSocket at wss://api.instantdb.com/runtime/session over which the client Reactor sends init, add-query, transact, and presence ops a...

Collections

InstantDB Admin HTTP API

OPEN

Pricing Plans

Instantdb Plans Pricing

4 plans

PLANS

Rate Limits

Instantdb Rate Limits

5 limits

RATE LIMITS

FinOps

Instantdb Finops

FINOPS

Event Specifications

InstantDB Realtime Sync (WebSocket)

AsyncAPI 2.6 description of InstantDB's **realtime sync** surface. Unlike a request/response REST API, InstantDB is a sync engine. The client SDK's **Reactor** opens a persisten...

ASYNCAPI

Resources

👥

GitHubOrganization

Sources

opencollection: 1.0.0
info:
  name: InstantDB Admin HTTP API
  version: '1.0'
request:
  auth:
    type: bearer
    token: '{{adminToken}}'
items:
- info:
    name: Data
    type: folder
  items:
  - info:
      name: Run an InstaQL query
      type: http
    http:
      method: POST
      url: https://api.instantdb.com/admin/query
      body:
        type: json
        data: "{\n  \"query\": {\n    \"goals\": {\n      \"todos\": {}\n    }\n  }\n}"
    docs: Executes an InstaQL read query as an admin and returns nested entities.
  - info:
      name: Apply InstaML transaction steps
      type: http
    http:
      method: POST
      url: https://api.instantdb.com/admin/transact
      body:
        type: json
        data: "{\n  \"steps\": [\n    [\"update\", \"goals\", \"8aa64e4c-64f9-472e-8a61-3fa28870e6cb\", { \"title\": \"Get\
          \ fit\" }]\n  ]\n}"
    docs: Atomically applies InstaML transaction steps as an admin.
- info:
    name: Auth
    type: folder
  items:
  - info:
      name: Create refresh token
      type: http
    http:
      method: POST
      url: https://api.instantdb.com/admin/refresh_tokens
      body:
        type: json
        data: "{\n  \"email\": \"alyssa_p_hacker@instantdb.com\"\n}"
    docs: Generates an auth token for a user, creating the user if needed.
  - info:
      name: Create magic code
      type: http
    http:
      method: POST
      url: https://api.instantdb.com/admin/magic_code
      body:
        type: json
        data: "{\n  \"email\": \"alyssa_p_hacker@instantdb.com\"\n}"
    docs: Creates a magic code without sending it.
  - info:
      name: Send magic code
      type: http
    http:
      method: POST
      url: https://api.instantdb.com/admin/send_magic_code
      body:
        type: json
        data: "{\n  \"email\": \"alyssa_p_hacker@instantdb.com\"\n}"
    docs: Creates and sends a magic code via Instant's provider.
  - info:
      name: Verify magic code
      type: http
    http:
      method: POST
      url: https://api.instantdb.com/admin/verify_magic_code
      body:
        type: json
        data: "{\n  \"email\": \"alyssa_p_hacker@instantdb.com\",\n  \"code\": \"123456\"\n}"
    docs: Verifies a magic code and returns the user.
  - info:
      name: Verify refresh token
      type: http
    http:
      method: POST
      url: https://api.instantdb.com/runtime/auth/verify_refresh_token
      body:
        type: json
        data: "{\n  \"app-id\": \"{{appId}}\",\n  \"refresh-token\": \"{{refreshToken}}\"\n}"
    docs: Validates a refresh token for an app.
  - info:
      name: Get user
      type: http
    http:
      method: GET
      url: https://api.instantdb.com/admin/users?email=alyssa_p_hacker@instantdb.com
    docs: Fetches an app user by email, id, or refresh_token.
  - info:
      name: Delete user
      type: http
    http:
      method: DELETE
      url: https://api.instantdb.com/admin/users?email=alyssa_p_hacker@instantdb.com
    docs: Permanently deletes an app user.
  - info:
      name: Sign out
      type: http
    http:
      method: POST
      url: https://api.instantdb.com/admin/sign_out
      body:
        type: json
        data: "{\n  \"email\": \"alyssa_p_hacker@instantdb.com\"\n}"
    docs: Invalidates a user's sessions / refresh tokens.
- info:
    name: Storage
    type: folder
  items:
  - info:
      name: Upload file
      type: http
    http:
      method: PUT
      url: https://api.instantdb.com/admin/storage/upload
      body:
        type: binary
        data: ''
    docs: Uploads a file; destination set via the Path header, body is binary content.
  - info:
      name: Delete single file
      type: http
    http:
      method: DELETE
      url: https://api.instantdb.com/admin/storage/files?filename=images/cat.png
    docs: Deletes one file by storage path.
  - info:
      name: Delete multiple files
      type: http
    http:
      method: POST
      url: https://api.instantdb.com/admin/storage/files/delete
      body:
        type: json
        data: "{\n  \"filenames\": [\"images/cat.png\", \"docs/readme.txt\"]\n}"
    docs: Deletes multiple files in one request.
- info:
    name: Presence
    type: folder
  items:
  - info:
      name: Get room presence
      type: http
    http:
      method: GET
      url: https://api.instantdb.com/admin/rooms/presence?room-type=chat&room-id=room-123
    docs: Returns users currently present in a realtime room.