Docs
Accounts

Search broker servers

GET
/v1/brokers/servers

MT5 servers matching what someone typed — a broker's name (vantage), the start of a server name (JustMarkets-De), with or without dashes and spaces. Built for a typeahead in your connect form: call it as the person types (debounced, from 2 characters) and let them pick.

Servers accounts on fxapis have logged in to come first (proven: true), then names starting with what was typed, then the kind asked for (demo/live), then the broker's main server. With fewer than five matches for 3+ characters, the broker search is asked once and its servers added, so a broker nobody here has used yet is found too — that call can take a second or two.

A server that is not listed can still be connected: always let people use exactly what they typed. Without q, the servers used most here.

Authorization

apiKey
AuthorizationBearer <token>

Authorization: Bearer fx_live_<id>_<secret>.

A key is shown once, at creation. We cannot show it again or recover it for you. Keys carry a label (live or test) in the key itself, so each configuration is easy to tell apart. Both reach real brokers: test with a broker demo account.

Scopes are per key. A key without accounts:write can read accounts and nothing else.

In: header

Query Parameters

q?string
Lengthlength <= 64
limit?integer
Range1 <= value <= 50
Default20

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/brokers/servers?q=justmarkets"
{  "data": [    {      "name": "JustMarkets-Demo",      "company": "JustMarkets Ltd",      "kind": "demo",      "proven": true    }  ]}