Equities Features
- Ticker mapping: The equities endpoint maps each ticker to its mint.
- Scaled amounts: The response for an equity adds its ticker and scaled amounts.
- Platform fees: Builders collect a platform fee on equity fills.
- Onchain events: The app reads direct fills, escrow fill transitions, and fees from onchain events.
Equities Integration Steps
1
Look Up Equity Mints
Call the equities endpoint to find the equity’s mint.
2
Call the Order Endpoint
Call
/order with the equity mint as the input or output mint. See Equity Fills.3
Sign and Submit
The user signs the returned transaction, and the app submits it for its execution mode.
Supported Equity Pairs
- USDC to or from an equity mint.
- Another token to or from an equity mint, which the order endpoint routes through USDC.
400 with code unsupported_equity_pair. A request with the same mint on both sides returns 400 with code same_input_and_output_mint.
Equity Execution Modes
The app submits each as described in Submitting Equity Transactions. Equity Fills describes which one a request returns.