Datasourceforcryptocurrency-4 / docs /active /SHORT_HUNTER_DATASOURCE_CONTRACT.md
Really-amin's picture
Preserve Short Hunter datasource gateway compatibility and fixes
ec64180 verified
|
Raw
History Blame Contribute Delete
1.28 kB

Short Hunter Datasource Contract

Primary base path:

/api/short-hunter

Primary operational endpoints:

  • GET /api/short-hunter/health
  • GET /api/short-hunter/capabilities
  • GET /api/short-hunter/providers/status
  • GET /api/short-hunter/universe
  • GET /api/short-hunter/market/{symbol}
  • GET /api/short-hunter/ohlcv/{symbol}
  • GET /api/short-hunter/orderbook/{symbol}
  • GET /api/short-hunter/funding/{symbol}
  • GET /api/short-hunter/open-interest/{symbol}
  • GET /api/short-hunter/indicators/{symbol}
  • GET /api/short-hunter/sentiment/{symbol}
  • GET /api/short-hunter/snapshot/{symbol}
  • POST /api/short-hunter/batch-snapshot

Contract rules:

  • Public data only.
  • No order placement.
  • No private exchange endpoints.
  • No fabricated live market data.
  • If usable live data is unavailable, return DEGRADED, CACHED, or UNAVAILABLE state honestly and activate noTradeGuard where needed.
  • Provider rotation is capability-based, not global.

Critical capabilities for trustworthy Short Hunter scanning:

  • futures contract validation
  • ticker / mark price
  • OHLCV
  • orderbook
  • funding
  • open interest
  • source health
  • freshness

If any critical capability is missing, the gateway must set noTradeGuard=true and explain why.