Public API • stable external surface

Use the Synapse SAP Explorer API as live docs, reference, and test console.

This page is designed for external integrators. It explains authentication, rate limits, response envelopes, standard headers, and every route under /api/v1. You can also run each request live against any environment by changing the base URL above.

JSON over HTTPS 17 documented endpoints Live try-it support Rate limited by tier

Public routes

Complete coverage of the current /api/v1 surface.

HTTP methods

GET

Current public API is read-only and safe to explore.

Public rate limit

30/min

Without API key. Free and Pro tiers raise this cap.

Envelope

Stable

Success uses data + meta, errors use error.

Quick start

Minimal request

curl

Authentication

Optional API key via header

Send x-api-key to move from the default public tier to a configured free or pro tier. No key is required for basic reads.

public: 30 req/min
free: 120 req/min
pro: 600 req/min

Standard response headers

Observability built in

X-Request-Id — request correlation id
X-Data-Source — db | cache | rpc | mixed | internal
X-Data-Age — server-reported data age in ms
X-RateLimit-Limit / Remaining / Reset — request window telemetry

Success envelope

Every successful response has the same outer shape

JSON

Error envelope

Errors are stable and easy to branch on

JSON

Common integration notes

How to consume the API safely

Prefer reading pagination data from meta instead of inferring it client-side.
Use X-Request-Id for support/debugging and optionally send your own x-request-id.
Dynamic path parameters such as wallet, address, and pda are validated as Solana public keys by the server.
For /api/v1/transactions, the query key is perPage (camelCase), not per_page.
Numeric query parameters are clamped to server-side maximums instead of failing when above the cap, but invalid negative numbers still return INVALID_PARAM.
All currently documented public endpoints are read-only GET requests.

Endpoint reference

Select an endpoint from the left

Use the navigation to inspect parameters, copy example requests, and run live tests.

The reference panel below updates for the selected endpoint and doubles as a playground.

What it returns

Endpoint purpose

Choose an endpoint to see its documented output shape and usage constraints.

Parameters

Path and query contract

No endpoint selected.

Request builder

Try it live

GET

—

Select an endpoint to build a request.

Live response

Response payload & headers

                Body
                No request sent yet
              

Select an endpoint and click “Send request”.

Example request

Ready-to-run curl

curl

Select an endpoint to generate a ready-to-run request.

Example response

Shape you can expect

JSON

Select an endpoint to inspect a representative success payload.

Known error cases

What to handle client-side

Select an endpoint to view its common failure modes.