Biyond API & Agent Access

Give your AI agent Biyond's scored model outputs - calibrated liquidation levels, live out-of-sample scorecards, Atlas regime, Vanguard trend state, Cannonade signals and options analytics. Every response carries the producing model's current score and a disclaimer: these are model estimates, scored in public weekly - not exchange ground truth, not investment advice.

Authentication

Requests carry your key (issued by Biyond) as a bearer token:

Authorization: Bearer byk_...

MCP (Claude and other agents)

claude mcp add --transport http biyond   https://nirmata.biyond.co/agent/v1/mcp   --header "Authorization: Bearer byk_..."

Any MCP client works: streamable-HTTP endpoint POST /agent/v1/mcp (initialize, tools/list, tools/call).

REST

GET https://nirmata.biyond.co/agent/v1/tools
GET https://nirmata.biyond.co/agent/v1/tools/get_scorecards
GET https://nirmata.biyond.co/agent/v1/tools/get_liquidation_levels?symbol=ETH

Tools

ToolParamsDescription
get_market_snapshot-Biyond's full market snapshot: Atlas index + regime, Vanguard colors, Cannonade signals + live scorecard, liquidation capture record, GEX+, market score, season index, 24h movers.
get_liquidation_levelssymbol, venueCalibrated liquidation clusters + touch probabilities for one symbol, with the current out-of-sample capture rate.
get_scorecards-The live out-of-sample records: liquidation capture rates and the Cannonade per-period scorecard.
get_atlas_regime-Biyond Atlas index (BTC/ETH), 7-day history and dashboard regime read. Inverse index.
get_vanguard_statesymbolVanguard trend colors per timeframe for one symbol.
get_cannonade-Current Cannonade signal list (all periods) + the live per-period scorecard.
get_optionscurrencyGEX+ dealer-gamma summary for BTC or ETH: spot, flip level, net gamma, DVOL, commentary.
get_blotter_summary-Biyond's live discretionary + quant trade blotter (active signals, paper track record).

Response envelope

{"data": ..., "model_score": ..., "disclaimer": "...", "as_of": "..."}

Limits

60 calls/minute per key; monthly allowance per your plan (default 10,000 calls). Past a limit you receive HTTP 429.

Model outputs only - Biyond does not resell raw market data.

Getting a key

API & Agent Access is an add-on to any Biyond plan. Subscribe and issue your key under Settings → API & Agent Access at app.biyond.co - the key is shown once at issuance; if you lose it, revoke it there and issue a new one. Manage or cancel the add-on under Settings → Plan.