Documentation

The API, in outline.

A preview of how the BrokerMeta API is shaped. Full reference documentation is published to early-access partners alongside their keys.

Request a key See the schema

Docs preview

Endpoint paths, parameter names and field names on this page are indicative while the API is in early access. They may change before general availability, and every value shown is an illustrative example rather than real broker data.

Getting started

Base URL and authentication.

Every request is authenticated with a bearer token issued per account. Keys are scoped to the properties and coverage agreed for that account.

Base URL

https://api.brokermeta.ai/v1

Authentication

Authorization:Bearer <your-api-key>

Endpoints

Five resources.

Method	Path	Returns
GET	/brokers	List brokers, filtered by country, client type or asset class.
GET	/brokers/{broker}	A single broker with its legal entities and licences.
GET	/brokers/{broker}/offerings	What the broker offers a given client type in a given jurisdiction.
GET	/brokers/{broker}/changes	Version history for a broker, with previous values and effective dates.
GET	/schema	The machine-readable field reference for the current schema version.

Example request

GETRequest

/brokers/example-broker/offerings
  ?country=AE&client_type=retail

Example response

200 OK

{
  "broker": "example-broker",
  "legal_entity": "Example Broker (UAE) Ltd",
  "licence": "ABC123",
  "client_type": "retail",
  "country": "AE",
  "offering": {
    "average_spread": 0.7,
    "minimum_deposit": 0,
    "max_leverage": "1:200",
    "instruments": 980
  },
  "updated_at": "2026-08-31T09:14:00Z"
}

Query parameters

countryiso_3166_1: Jurisdiction the client is resident in.
client_typeretail | professional: Client classification.
fieldsstring[]: Restrict the response to named fields.
as_ofdate: Return values effective on a given date.
versioninteger: Pin to a specific record version.

Error codes

400: Invalid parameter, unknown field or malformed filter.
401: Missing or invalid API key.
403: Key is valid but not provisioned for the requested resource.
404: No broker, entity or offering matches the request.
429: Request rate exceeded for the account.

Versioning

Values change. History does not.

Every record carries a version number and an effective date.
Previous values remain retrievable through the changes endpoint.
Pass as_of to reconstruct what a page should have said on a given date.
Schema versions are namespaced in the URL, so a breaking change never lands silently.

Request an API key.

Early-access partners get the full reference, a sandbox account and direct support during integration.

Join early access Talk to us