Skip to Content
HTTP APIService

API version, build and limits

Build your request

Change the values and the command follows. The token is never typed here: the command reads it from the SPECTRE_LOCAL_API_TOKEN environment variable. Run it in your own terminal.

Command
curl 'http://127.0.0.1:48180/v1/meta' \
  -H "Authorization: Bearer $SPECTRE_LOCAL_API_TOKEN"
GET
/meta

The version of the API, the build of the terminal, the scopes of the token, the limits and the topics of the stream. A terminal built without market data lists only workspace and settings in topics. Market topics and market operations answer unsupported then.

Authorization

bearerToken
headerAuthorizationBearer <token>

The Local API token: spt_ and 64 hex characters. Copy it from Settings App → General → Local API. It is accepted only in the Authorization header. The names listed with an operation are the scopes it requires. The token of the terminal carries all of them.

Response Body

The description of this terminal.

application/json
  1. response
api_version*string

Always 1 in v1.

app_version*string

The version of the terminal.

build_hash*string
build_env*string

production or development.

features*string

Cargo features of the build, as one string.

scopes*array<>

The scopes of the token.

limits*
topics*array<string>

Topics of the stream this build serves.

Example Request
curl 'http://127.0.0.1:48180/v1/meta' \  -H "Authorization: Bearer $SPECTRE_LOCAL_API_TOKEN"
Example Response
{  "api_version": "1",  "app_version": "2.0.0",  "build_hash": "3f1c2ab",  "build_env": "production",  "features": "local-api",  "scopes": [    "market:read",    "connections:read",    "account:read",    "trading:write",    "workspace:read",    "workspace:write",    "settings:read",    "settings:write"  ],  "limits": {    "ws_connections_per_token": 8,    "subscriptions_per_connection": 100,    "api_only_instruments": 50,    "exchange_subscriptions_per_second": 5,    "commands_per_second": 10,    "workspace_commands_per_second": 5,    "settings_commands_per_second": 5  },  "topics": [    "trades",    "ticker",    "mark_price",    "book.top",    "clusters",    "account.orders",    "account.positions",    "account.balances",    "account.fills",    "workspace",    "settings"  ]}