# Broker-Radar (propfirms) v1.1.0 Prop-firm spreads feed. Live and periodic spread data across a broad set of prop firms, returned in a stable JSON cell shape you can integrate directly. Base: https://api2.broker-radar.com Generated: 2026-11-21T12:58:15.183Z > AI agents: prefer GET /help?format=json — same content as this page in structured form. ## Agent quickstart 1. GET /public/propfirms → array of {broker, account, name, source}. Cache the slug list; it changes rarely. 2. For ONE broker: GET /public/propfirms-spreads/{broker}/{account}?symbols=EURUSD,XAUUSD → JSON cell envelope. For MANY brokers do NOT loop this — GET /public/propfirms-spreads-bulk?brokers=slug1,slug2,...&symbols=EURUSD,XAUUSD instead (one snapshot read, never rate-limits). See the /public/propfirms-spreads-bulk endpoint + filterRules.brokers. 3. Inspect each cell.market_status — "open" or "Typical_Spread" means usable numerics; any other value (Weekend_Market_Closed / Rollover / Holiday_Market_Close) means bid/ask/spread are status strings, not numbers. 4. Inspect each cell.source — it labels which Broker-Radar feed produced the cell (see the sources section for the values and how to interpret each). 5. Poll /healthz to check liveness (ok=true) and data freshness. Treat data older than ~5 min during open market as degraded. ## Endpoints ### GET /help This page. Returns markdown by default; add ?format=json for the structured payload (preferred for AI agents). Query: - format: md (default) | json Example: https://api2.broker-radar.com/help?format=json ### GET /healthz Feed liveness + freshness snapshot. Returns 200 even when degraded; check the body fields (ok, market.status, and the recency of the data) to decide if the feed is usable. May include additional operator-only fields not listed here — ignore them; they can change without notice. Response shape: { ok:boolean, uptimeMs, brokerCount, cellCount, market:{status:"open"|"closed", symbols:[{symbolId, code, lastChangeAt, idle}]}, ... } Example: https://api2.broker-radar.com/healthz ### GET /public/propfirms Full catalog list of every prop firms pair the feed knows about. Built from the static catalog (NOT the live snapshot) so list is stable across weekends and market closures. Response shape: { success:true, total:, data:[{ broker, account, name, source:"realtime"|"typical"|"both" }], timestamp } Example: https://api2.broker-radar.com/public/propfirms ### GET /public/propfirms-spreads/:propfirm/:account Spread cells for one prop firm/account pair. Stable JSON payload shape. Use the symbols query to limit response size. Path params: - :propfirm: Slug from /public/propfirms (case-insensitive). funding-pips and fundingpips both resolve. - :account: Account label (e.g. FundingPips). The server returns the canonical account_type when it has one, so passing 'live' is also fine. Query: - symbols: Optional. Comma-separated symbol codes WITHOUT slash (e.g. EURUSD,XAUUSD,US30). See filterRules.symbols for full rules. Response shape: { success:true, broker, account, total:, data:[{ symbol, common_suffix, time, time_msc, bid, ask, spread, spread_points, spread_raw, market_status, digits, point, contract_size, volume_min, volume_max, leverage, broker_name, account_type, source }], timestamp } Example: https://api2.broker-radar.com/public/propfirms-spreads/fundingpips/FundingPips?symbols=EURUSD,XAUUSD ### GET /public/propfirms-spreads-bulk BULK: spread cells for MANY prop firms in ONE request, served from a single snapshot read. Use this instead of calling the per-prop firm endpoint in a loop — it never rate-limits, no matter how many prop firms you ask for. Each entry in `results` is byte-for-byte the same envelope the single endpoint returns. Query: - brokers: REQUIRED. Comma-separated prop firm specs. Each spec is: [+accountType...][:SYM|SYM...]. '+' appends a case-insensitive account-type include-filter (e.g. pepperstone+ecn keeps the row only if the prop firm's account_type contains "ecn"; omit to keep regardless). ':' gives that one prop firm its own symbol list (members separated by '|', since ',' separates prop firms), overriding the shared symbols param. Up to 80 prop firms per request. See filterRules.brokers. - symbols: Optional. Shared symbol list applied to every spec that has no per-spec ':' override. Same codes/rules as the single endpoint — see filterRules.symbols. Response shape: { success:true, count:, timestamp, results:{ "": , ... }, skipped?:{ "": "unknown_broker"|"no_data"|"account_type_mismatch" } } Example: https://api2.broker-radar.com/public/propfirms-spreads-bulk?brokers=fundingpips+ecn,ftmo:EURUSD|XAUUSD&symbols=EURUSD,XAUUSD ### WS /ws/spreads WebSocket: live spread cells for the prop firms you subscribe to, pushed whenever they change (looked at every second). Send {"op":"subscribe","brokers":["fundingpips"],"symbols":["EURUSD","XAUUSD"]} (symbols optional, up to 50 prop firms a connection); {"op":"unsubscribe","brokers":[...]} stops one. A browser passes the key as ?key=. A prop firm outside your plan gets an error frame with status 402; a revoked, narrowed or lapsed key closes the stream with 4001, 4003 or 4002. Response shape: { kind:"snapshot"|"update", broker, data: } | { kind:"error", broker?, status?, message } | { kind:"unsubscribed", brokers } Example: wss://api2.broker-radar.com/ws/spreads?key=YOUR_API_KEY ## Payload fields - `symbol` (string) — Canonical symbol code, no slash (e.g. "EURUSD", "XAUUSD", "US30"). - `common_suffix` (string) — Duplicate of `symbol`; kept for backward compatibility. - `time` (number) — Tick timestamp in Unix SECONDS (UTC). On Typical_Spread or closed cells this is the time of the last live observation, not now. - `time_msc` (number) — Tick timestamp in Unix MILLISECONDS (UTC). 1000× of `time`. - `bid` (number | string) — Mid price minus half-spread, in price units. STRING when market_status != "open" (collapses to the status label) OR when the cell carries a typical spread with no published mid price. - `ask` (number | string) — Mid price plus half-spread, in price units. Same string-collapse rules as bid. - `spread` (number | string) — Spread in PRICE UNITS (i.e. spread_points × point). For EURUSD at 0.4 pips: spread=0.00004. Same string-collapse rules. - `spread_points` (number | string) — Spread in POINTS (= 10 × pips on 5-digit pairs). For EURUSD at 0.4 pips: spread_points=4. Integer. Same string-collapse rules. - `spread_raw` (number | string) — Identical to spread_points; kept for backward compatibility. - `market_status` (string) (one of: open, Typical_Spread, Weekend_Market_Closed, Rollover, Holiday_Market_Close) — One of the enum values in marketStatusLabels (e.g. "open", "Typical_Spread", "Weekend_Market_Closed"). When != "open", numeric fields collapse to this same string. - `digits` (number) — Decimal precision the symbol quotes at (5 for EURUSD, 3 for USDJPY, 2 for XAUUSD). Always populated. - `point` (number) — Size of one point in price units (= 10^-digits). - `contract_size` (number) — Standard lot size (100,000 for FX majors, 100 for XAUUSD, 5,000 for XAGUSD, 1 for indices/crypto). - `volume_min / volume_max` (number) — Min / max tradeable lot size. - `leverage` (number) — Typical retail leverage for the symbol class. Indicative, not broker-specific. - `broker_name` (string) — Display name (e.g. "FundingPips"). - `account_type` (string) — Canonical account label (e.g. "Alpari-Pro.ECN"). The server returns this in place of whatever you passed in the URL when it has the canonical value. - `source` (string) (one of: Broker-Radar.com Liquidity Solution, Broker-Radar.com Typical Spreads) — Which Broker-Radar feed produced this cell. See the sources section for the full list of values and their freshness. ## market_status enum - `open` — Market is live and the cell holds real numeric bid/ask/spread. _(when: Weekday during the symbol's session, realtime source only.)_ - `Typical_Spread` — Periodic typical-spread value, not a live tick. Spread fields hold numbers; bid/ask are undefined (no mid price published). _(when: Always for cells from the typical-spread source. Refreshes approximately every 30 minutes.)_ - `Weekend_Market_Closed` — Numeric fields collapse to this string. time/time_msc retain the last real tick. _(when: Saturday / Sunday / Friday after the symbol's last session-end (UTC).)_ - `Rollover` — Numeric fields collapse to this string during the daily rollover window. _(when: Weekday ~21:00–22:00 UTC for FX.)_ - `Holiday_Market_Close` — Numeric fields collapse to this string. Likely a public holiday or a temporary data outage. _(when: Weekday where no broker has reported a tick for the symbol in ~5 minutes.)_ ## Data sources - `source = "Broker-Radar.com Liquidity Solution"` - Live feed with full bid/ask + spread. - Freshness: Sub-second live ticks while the market is open; reflected by the freshness fields in /healthz. - Bid/ask populated: yes - `source = "Broker-Radar.com Typical Spreads"` - Periodic typical-spread values (not live ticks) across major symbols such as EURUSD, USDJPY, GBPUSD, XAUUSD, US30, BTCUSD. - Freshness: Refreshed periodically; reflected by the freshness fields in /healthz. - Bid/ask populated: no — only spread fields ## Filter / query rules - `?symbols` — Comma-separated list of symbol codes to keep in the response. Omit to get all symbols. - Format: Codes are case-insensitive, NO SLASH, no spaces (EURUSD not EUR/USD). Server canonicalizes to uppercase-no-slash internally. - Example: `?symbols=EURUSD,XAUUSD,US30` - Notes: Up to 9 symbols today. Unknown symbol codes are silently dropped (no error). - `?brokers` — Bulk endpoint only (/public/propfirms-spreads-bulk). Comma-separated list of prop firm specs to fetch in one shot. - Format: Per spec: [+type][+type][:SYM|SYM]. ',' separates specs, '+' separates account-type filter tokens, ':' starts a per-spec symbol override whose members are '|'-separated. Slugs/types case-insensitive; symbols uppercased no-slash. ('+' decodes to a space in query strings; the server treats space and '+' identically here, so both `slug+ecn` and a literal space work.) - Example: `?brokers=pepperstone+ecn,icmarkets+raw:GBPUSD|EURUSD,fxpro&symbols=EURUSD,XAUUSD` - Notes: Account-type is a single fixed label per prop firm (there is no ECN/Standard variant set) — '+type' acts purely as an include-if-match filter; a spec that matches nothing lands in 'skipped' with reason "account_type_mismatch". Unknown slug → "unknown_broker"; recognised slug with no live cells → "no_data". Unlike the single endpoint, the bulk endpoint does not fetch unknown slugs on demand. Max 80 specs; duplicates collapse (last wins). ## Freshness contract Live source: treat as stale if the data hasn't advanced in >60s during open market. Typical-spread source: treat as stale after ~60 minutes without a refresh. The two sources fail-soft independently — if one is unavailable, the other still serves its slugs. ## Error responses 4xx/5xx responses ALWAYS carry success:false plus either `message` or `error`. Some routing misses return plain text/HTML instead — treat any non-2xx with non-JSON body as a 404. Example: {"success":false,"message":"no snapshot yet, feed still priming","data":[]} ## Notes - Closed cells: when market_status is not "open" or "Typical_Spread", numeric fields (bid/ask/spread/spread_points/spread_raw) collapse to the same status string. time/time_msc retain the last real tick. Static fields (digits/point/contract_size/leverage) stay populated. - Listing dedup: /public/propfirms lists each firm once. The source field on the listing entry shows "realtime" / "typical" / "both"; for a "both" firm, realtime values win for the symbols they cover and typical values fill the rest (typically US30 / BTCUSD). - CORS: requests with an Origin header outside the configured allowlist receive a 403. Server-to-server requests (no Origin header, e.g. curl from a backend) always pass. - Rate limits: this service has no built-in per-request rate limit.