mock-fintrade/docs
concepts · api · examples

mock-fintrade exists so you can drive StarClear's v2 API the way a real OMS would — without a real OMS. These docs cover both sides of the work: the securities concepts a newcomer needs (what a trade is, what settlement means, why a CUSIP matters), and the technical reference for every endpoint mock-fintrade calls.

01
Securities primer

Concepts

What the field names in a trade actually mean. Read first if you're new to brokerage post-trade flow.

  • What is a trade?
  • How the 10 OMS gates work
  • Settlement, T+1, holidays
  • CUSIP, ISIN, symbol-of-record
  • Reg SHO + locates
  • PDT + cash-account day-trading
  • Reg T + margin calls
02
Live tech docs

API Reference

Scalar-rendered API explorer over StarClear's v2 OpenAPI spec. Servers point at the staging URL mock-fintrade is configured for.

03
Copy-paste workflows

Examples

End-to-end walkthroughs with curl + UI screenshots. Each one is a story: get a token, dry-run, observe.

  • Your first trade
  • Day-trade replay
  • Debugging a rejection
  • Idempotent retry on POST