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
GET https://nirmata.biyond.co/agent/v1/tools/get_atlas_history?symbol=BTC&index=cycle

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 v2 scorecard (all / per period / per cell, live rows; the backtest block apart).
get_atlas_regime-Biyond Atlas Cycle index (BTC/ETH): current reading, 7-day history and dashboard regime read. Inverse index. Use get_atlas_history for the full series.
get_atlas_historysymbol, index, start, limitFull daily history of one Atlas index (Cycle, Swing or Pulse) for BTC or ETH: date, value and zone per day, the live zone thresholds, coverage dates and the revision policy. Inverse index.
get_vanguard_statesymbolVanguard trend colors per timeframe for one symbol.
get_cannonade-Current Cannonade signal list (all periods) + the live v2 scorecard (all / per period / per cell; the backtest block apart).
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).

Atlas history

get_atlas_history returns the complete daily series of one Atlas index - Cycle, Swing or Pulse - for BTC or ETH: date, value and zone per day (momentum, consolidation, value_state, extreme_oversold), the live thresholds that define the zones, and the coverage dates. Cycle reaches back to 2014 (BTC) and 2016 (ETH); Swing and Pulse are younger series and start between 2021 and 2024 - the payload's coverage block is authoritative.

Revisions. The trailing 7 days are recomputed daily and should be treated as preliminary. Older values change only when our data vendor revises input history (audited weekly; the affected span is regenerated) or when a methodology update regenerates the full series, which we announce to API subscribers. A good cache pattern: refresh the last 30 days daily, full refresh after an announced update.

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.