Skip to content

FYERS Mapping Overview

This page summarizes FYERS REST and WS mappings used by fyers-store. It aligns with docs/fyers_mapping.md and adds operator-facing notes.

REST Endpoints (High Level)

  • get_profile()
  • funds()
  • market_status()
  • quotes()
  • depth()
  • history()
  • orderbook()
  • tradebook()
  • positions()
  • holdings()
  • place_order()
  • modify_order()
  • cancel_order()

WebSocket Channels (High Level)

  • Market Data WS: SymbolUpdate / DepthUpdate
  • Order WS: Orders, Trades, Positions, General

Known Quirks

  • No client-provided idempotency keys for order placement.
  • Sessions expire daily and can be invalidated by another login.
  • Some REST endpoints return no_data instead of explicit auth errors.

Scenario Example

Scenario: You see no_data for history during market hours. - Treat it as a possible auth failure. - Refresh token and retry after validation.

References

  • Detailed REST payloads: docs/fyers/rest-payloads.md
  • Detailed WS payloads: docs/fyers/ws-payloads.md
  • Legacy mapping reference: docs/fyers_mapping.md