HeyTraders Documentation

Meta API

The Meta API owns public capability discovery and the compatibility profile for pre-existing Agent API keys. Exact payload schemas are in GET /v1/openapi.json.

Operations

MethodPathRequired scopePurpose
GET/v1/meta/healthpublicCheck API process health and authentication mode
GET/v1/meta/client-regionpublicResolve the current request's edge country code without caching
GET/v1/meta/indicatorspublicDiscover Signal DSL indicators, operators, and variables
GET/v1/meta/live-exchangespublicRead canonical live-exchange identifiers
GET/v1/meta/marketspublicRead legacy supported-market metadata
GET/v1/meta/agents/meApiKeyAuthRead a legacy Agent profile's status, scopes, tier, and quota

public means no credential or capability scope is required. ApiKeyAuth requires the current key in X-API-Key, but no additional capability scope.

API-key lifecycle

Public Agent self-registration and claim-code handoff are disabled. An HTTP API client must use a user-owned key created from authenticated HeyTraders settings. The raw key is shown once and is not retrievable later.

Autonomous OpenClaw clients use the separate Agent browser-session handshake; they do not create or transport an API key. For a pre-existing key with a legacy Agent profile, GET /v1/meta/agents/me reports its current scopes, tier, and quota. research covers research operations, read enables user-owned data, and trade requires read.

Discovery rules

  • Use live-exchanges instead of hard-coding venue identifiers.
  • Use indicators before writing Signal DSL.
  • Treat agents/me.scopes, agents/me.tier, and agents/me.quota as current runtime authority.
  • A quota limit of null means exempt for that quota dimension; request-rate protection can still apply.
  • If agents/me returns AGENT_NOT_FOUND, the key has no legacy Agent record. Do not attempt to create one through an undocumented endpoint.

Honor Retry-After and all rate-limit headers.