> ## Documentation Index > Fetch the complete documentation index at: https://docs.engine.usesophic.com/llms.txt > Use this file to discover all available pages before exploring further. # Get an order quote > Issues a quote for a prospective order. The quote captures the fees and estimated price/quantity that would apply, is persisted, and carries an `id` and `expires_at`; pass the `id` as `quote_id` at order placement to reference the previewed terms. Placement rejects expired quotes. ## OpenAPI ````yaml /openapi.json post /accounts/{account_id}/order-quotes openapi: 3.1.0 info: title: Sophic Engine API version: 0.1.0 servers: - url: https://api.engine.usesophic.com security: [] tags: - description: Retrieve accounts, statements, and account documents. name: accounts x-group: Accounts - description: Read the audit trail of platform activity. name: activity x-group: Activity - description: Obtain OAuth access tokens for the Engine API. name: auth x-group: Authentication - description: Inspect the authenticated user or service actor. name: identity x-group: Identity - description: Retrieve fee schedules and billing information. name: billing x-group: Billing - description: Browse instruments and tradable products. name: catalog x-group: Catalog - description: Track onboarding applications through completion. name: onboarding x-group: Onboarding - description: Manage customer records and related person data. name: customers x-group: Customers - description: List platform events and inspect individual occurrences. name: events x-group: Events - description: Read positions, transactions, and account holdings. name: holdings x-group: Holdings - description: Retrieve legal agreements and required disclosures. name: legal-documents x-group: Legal Documents - description: Access prices and market data for instruments. name: market-data x-group: Market Data - description: Manage deposits, withdrawals, and funding accounts. name: payments x-group: Payments - description: Retrieve returns, earnings, and performance metrics. name: performance x-group: Performance - description: Place and manage orders, quotes, and trades. name: trading x-group: Trading - description: Read position and account valuations over time. name: valuation x-group: Valuation - description: Configure webhook endpoints and inspect deliveries. name: webhooks x-group: Webhooks - description: Upload files and retrieve stored documents. name: files x-group: Files paths: /accounts/{account_id}/order-quotes: post: tags: - trading summary: Get an order quote description: >- Issues a quote for a prospective order. The quote captures the fees and estimated price/quantity that would apply, is persisted, and carries an `id` and `expires_at`; pass the `id` as `quote_id` at order placement to reference the previewed terms. Placement rejects expired quotes. operationId: create_order_quote_accounts__account_id__order_quotes_post parameters: - in: path name: account_id required: true schema: title: Account Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/OrderQuoteRequest' required: true responses: '200': content: application/json: schema: discriminator: mapping: amc_market_cash: $ref: '#/components/schemas/AmcMarketCashQuote' bill_market_cash: $ref: '#/components/schemas/BillMarketCashQuote' bond_fixed_coupon_market_cash: $ref: '#/components/schemas/BondFixedCouponMarketCashQuote' bond_zero_coupon_market_cash: $ref: '#/components/schemas/BondZeroCouponMarketCashQuote' etf_limit_cash: $ref: '#/components/schemas/EtfLimitCashQuote' etf_limit_quantity: $ref: '#/components/schemas/EtfLimitQuantityQuote' etf_market_cash: $ref: '#/components/schemas/EtfMarketCashQuote' etf_market_quantity: $ref: '#/components/schemas/EtfMarketQuantityQuote' mmf_market_cash: $ref: '#/components/schemas/MmfMarketCashQuote' sell: $ref: '#/components/schemas/SellQuote' propertyName: quote_type oneOf: - $ref: '#/components/schemas/EtfMarketCashQuote' - $ref: '#/components/schemas/EtfLimitCashQuote' - $ref: '#/components/schemas/EtfMarketQuantityQuote' - $ref: '#/components/schemas/EtfLimitQuantityQuote' - $ref: '#/components/schemas/BillMarketCashQuote' - $ref: '#/components/schemas/BondZeroCouponMarketCashQuote' - $ref: '#/components/schemas/BondFixedCouponMarketCashQuote' - $ref: '#/components/schemas/MmfMarketCashQuote' - $ref: '#/components/schemas/AmcMarketCashQuote' - $ref: '#/components/schemas/SellQuote' title: >- Response 200 Create Order Quote Accounts Account Id Order Quotes Post description: Successful Response '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad Request security: - HTTPBearer: [] components: schemas: OrderQuoteRequest: properties: cash_amount: anyOf: - type: number - type: string - type: 'null' description: The cash amount for a buy order. examples: - '1000.00' title: Cash Amount instrument_id: description: ID of the instrument to quote. title: Instrument Id type: string limit_price: anyOf: - anyOf: - type: number - type: string gt: 0 - type: 'null' description: >- Optional limit price. When set, the quote is a deterministic bound: `estimated_price` echoes the limit, a cash buy returns affordable quantity and `max_cost`, a sell returns `min_proceeds`. examples: - '25.7500' title: Limit Price quantity: anyOf: - type: number - type: string - type: 'null' description: The unit quantity for a sell order. examples: - '12.5000' title: Quantity return_only_fees: default: false description: Whether to return only applicable fees. title: Return Only Fees type: boolean side: allOf: - $ref: '#/components/schemas/OrderSide' description: The order side, buy or sell. required: - instrument_id - side title: OrderQuoteRequest type: object AmcMarketCashQuote: properties: cash_amount: description: Cash the user chose to invest (before fees). examples: - '150000.00' title: Cash Amount type: string created_at: description: When the quote was issued. format: date-time title: Created At type: string currency: allOf: - $ref: '#/components/schemas/Currency' description: The currency every cash amount in this quote is given in. estimate: allOf: - $ref: '#/components/schemas/AmcMarketCashEstimate' description: Estimated economics at the latest price. expires_at: description: When the quote expires. format: date-time title: Expires At type: string id: description: Quote ID, redeemable via `quote_id` at order placement. title: Id type: string instrument: anyOf: - $ref: '#/components/schemas/Bill' - $ref: '#/components/schemas/CurrencyPair' - $ref: '#/components/schemas/Bond' - $ref: '#/components/schemas/MoneyMarketFund' - $ref: '#/components/schemas/AMC' - $ref: '#/components/schemas/ETF' description: The full instrument being quoted. title: Instrument is_binding: description: >- Whether the quoted price is binding at execution. Always false for security quotes; binding FX quotes are issued via /order-quotes/fx. title: Is Binding type: boolean order_type: allOf: - $ref: '#/components/schemas/OrderType' description: Market or limit. quote_type: const: amc_market_cash default: amc_market_cash description: >- The kind of order quote returned, which determines the set of fields present in this response. title: Quote Type reservation: $ref: '#/components/schemas/OrderQuoteReservation' side: allOf: - $ref: '#/components/schemas/OrderSide' description: Buy or sell. required: - id - created_at - expires_at - is_binding - instrument - side - order_type - currency - reservation - cash_amount - estimate title: AmcMarketCashQuote type: object BillMarketCashQuote: properties: cash_amount: description: Cash the user chose to invest (before fees). examples: - '10000.00' title: Cash Amount type: string created_at: description: When the quote was issued. format: date-time title: Created At type: string currency: allOf: - $ref: '#/components/schemas/Currency' description: The currency every cash amount in this quote is given in. estimate: allOf: - $ref: '#/components/schemas/BillMarketCashEstimate' description: Estimated economics at the latest price. expires_at: description: When the quote expires. format: date-time title: Expires At type: string id: description: Quote ID, redeemable via `quote_id` at order placement. title: Id type: string instrument: anyOf: - $ref: '#/components/schemas/Bill' - $ref: '#/components/schemas/CurrencyPair' - $ref: '#/components/schemas/Bond' - $ref: '#/components/schemas/MoneyMarketFund' - $ref: '#/components/schemas/AMC' - $ref: '#/components/schemas/ETF' description: The full instrument being quoted. title: Instrument is_binding: description: >- Whether the quoted price is binding at execution. Always false for security quotes; binding FX quotes are issued via /order-quotes/fx. title: Is Binding type: boolean order_type: allOf: - $ref: '#/components/schemas/OrderType' description: Market or limit. quote_type: const: bill_market_cash default: bill_market_cash description: >- The kind of order quote returned, which determines the set of fields present in this response. title: Quote Type reservation: $ref: '#/components/schemas/OrderQuoteReservation' side: allOf: - $ref: '#/components/schemas/OrderSide' description: Buy or sell. required: - id - created_at - expires_at - is_binding - instrument - side - order_type - currency - reservation - cash_amount - estimate title: BillMarketCashQuote type: object BondFixedCouponMarketCashQuote: properties: cash_amount: description: Cash the user chose to invest (before fees). examples: - '10000.00' title: Cash Amount type: string created_at: description: When the quote was issued. format: date-time title: Created At type: string currency: allOf: - $ref: '#/components/schemas/Currency' description: The currency every cash amount in this quote is given in. estimate: allOf: - $ref: '#/components/schemas/BondFixedCouponMarketCashEstimate' description: Estimated economics at the latest price. expires_at: description: When the quote expires. format: date-time title: Expires At type: string id: description: Quote ID, redeemable via `quote_id` at order placement. title: Id type: string instrument: anyOf: - $ref: '#/components/schemas/Bill' - $ref: '#/components/schemas/CurrencyPair' - $ref: '#/components/schemas/Bond' - $ref: '#/components/schemas/MoneyMarketFund' - $ref: '#/components/schemas/AMC' - $ref: '#/components/schemas/ETF' description: The full instrument being quoted. title: Instrument is_binding: description: >- Whether the quoted price is binding at execution. Always false for security quotes; binding FX quotes are issued via /order-quotes/fx. title: Is Binding type: boolean order_type: allOf: - $ref: '#/components/schemas/OrderType' description: Market or limit. quote_type: const: bond_fixed_coupon_market_cash default: bond_fixed_coupon_market_cash description: >- The kind of order quote returned, which determines the set of fields present in this response. title: Quote Type reservation: $ref: '#/components/schemas/OrderQuoteReservation' side: allOf: - $ref: '#/components/schemas/OrderSide' description: Buy or sell. required: - id - created_at - expires_at - is_binding - instrument - side - order_type - currency - reservation - cash_amount - estimate title: BondFixedCouponMarketCashQuote type: object BondZeroCouponMarketCashQuote: properties: cash_amount: description: Cash the user chose to invest (before fees). examples: - '10000.00' title: Cash Amount type: string created_at: description: When the quote was issued. format: date-time title: Created At type: string currency: allOf: - $ref: '#/components/schemas/Currency' description: The currency every cash amount in this quote is given in. estimate: allOf: - $ref: '#/components/schemas/BondZeroCouponMarketCashEstimate' description: Estimated economics at the latest price. expires_at: description: When the quote expires. format: date-time title: Expires At type: string id: description: Quote ID, redeemable via `quote_id` at order placement. title: Id type: string instrument: anyOf: - $ref: '#/components/schemas/Bill' - $ref: '#/components/schemas/CurrencyPair' - $ref: '#/components/schemas/Bond' - $ref: '#/components/schemas/MoneyMarketFund' - $ref: '#/components/schemas/AMC' - $ref: '#/components/schemas/ETF' description: The full instrument being quoted. title: Instrument is_binding: description: >- Whether the quoted price is binding at execution. Always false for security quotes; binding FX quotes are issued via /order-quotes/fx. title: Is Binding type: boolean order_type: allOf: - $ref: '#/components/schemas/OrderType' description: Market or limit. quote_type: const: bond_zero_coupon_market_cash default: bond_zero_coupon_market_cash description: >- The kind of order quote returned, which determines the set of fields present in this response. title: Quote Type reservation: $ref: '#/components/schemas/OrderQuoteReservation' side: allOf: - $ref: '#/components/schemas/OrderSide' description: Buy or sell. required: - id - created_at - expires_at - is_binding - instrument - side - order_type - currency - reservation - cash_amount - estimate title: BondZeroCouponMarketCashQuote type: object EtfLimitCashQuote: properties: cash_amount: description: Cash the user chose to invest (before fees). examples: - '10000.00' title: Cash Amount type: string created_at: description: When the quote was issued. format: date-time title: Created At type: string currency: allOf: - $ref: '#/components/schemas/Currency' description: The currency every cash amount in this quote is given in. estimate: allOf: - $ref: '#/components/schemas/EtfLimitCashEstimate' description: Estimated economics at the limit price. expires_at: description: When the quote expires. format: date-time title: Expires At type: string id: description: Quote ID, redeemable via `quote_id` at order placement. title: Id type: string instrument: anyOf: - $ref: '#/components/schemas/Bill' - $ref: '#/components/schemas/CurrencyPair' - $ref: '#/components/schemas/Bond' - $ref: '#/components/schemas/MoneyMarketFund' - $ref: '#/components/schemas/AMC' - $ref: '#/components/schemas/ETF' description: The full instrument being quoted. title: Instrument is_binding: description: >- Whether the quoted price is binding at execution. Always false for security quotes; binding FX quotes are issued via /order-quotes/fx. title: Is Binding type: boolean limit_price: description: Worst-case price per unit the order is bounded by. examples: - '700.0000' title: Limit Price type: string order_type: allOf: - $ref: '#/components/schemas/OrderType' description: Market or limit. quote_type: const: etf_limit_cash default: etf_limit_cash description: >- The kind of order quote returned, which determines the set of fields present in this response. title: Quote Type reservation: $ref: '#/components/schemas/OrderQuoteReservation' side: allOf: - $ref: '#/components/schemas/OrderSide' description: Buy or sell. required: - id - created_at - expires_at - is_binding - instrument - side - order_type - currency - reservation - cash_amount - limit_price - estimate title: EtfLimitCashQuote type: object EtfLimitQuantityQuote: properties: created_at: description: When the quote was issued. format: date-time title: Created At type: string currency: allOf: - $ref: '#/components/schemas/Currency' description: The currency every cash amount in this quote is given in. estimate: allOf: - $ref: '#/components/schemas/EtfLimitQuantityEstimate' description: Estimated economics at the limit price. expires_at: description: When the quote expires. format: date-time title: Expires At type: string id: description: Quote ID, redeemable via `quote_id` at order placement. title: Id type: string instrument: anyOf: - $ref: '#/components/schemas/Bill' - $ref: '#/components/schemas/CurrencyPair' - $ref: '#/components/schemas/Bond' - $ref: '#/components/schemas/MoneyMarketFund' - $ref: '#/components/schemas/AMC' - $ref: '#/components/schemas/ETF' description: The full instrument being quoted. title: Instrument is_binding: description: >- Whether the quoted price is binding at execution. Always false for security quotes; binding FX quotes are issued via /order-quotes/fx. title: Is Binding type: boolean limit_price: description: Worst-case price per unit the order is bounded by. examples: - '86.1750' title: Limit Price type: string order_type: allOf: - $ref: '#/components/schemas/OrderType' description: Market or limit. quantity: description: Units the user chose to buy. examples: - '14' title: Quantity type: string quote_type: const: etf_limit_quantity default: etf_limit_quantity description: >- The kind of order quote returned, which determines the set of fields present in this response. title: Quote Type reservation: $ref: '#/components/schemas/OrderQuoteReservation' side: allOf: - $ref: '#/components/schemas/OrderSide' description: Buy or sell. required: - id - created_at - expires_at - is_binding - instrument - side - order_type - currency - reservation - quantity - limit_price - estimate title: EtfLimitQuantityQuote type: object EtfMarketCashQuote: properties: cash_amount: description: Cash the user chose to invest (before fees). examples: - '10000.00' title: Cash Amount type: string created_at: description: When the quote was issued. format: date-time title: Created At type: string currency: allOf: - $ref: '#/components/schemas/Currency' description: The currency every cash amount in this quote is given in. estimate: allOf: - $ref: '#/components/schemas/EtfMarketCashEstimate' description: Estimated economics at the latest price. expires_at: description: When the quote expires. format: date-time title: Expires At type: string id: description: Quote ID, redeemable via `quote_id` at order placement. title: Id type: string instrument: anyOf: - $ref: '#/components/schemas/Bill' - $ref: '#/components/schemas/CurrencyPair' - $ref: '#/components/schemas/Bond' - $ref: '#/components/schemas/MoneyMarketFund' - $ref: '#/components/schemas/AMC' - $ref: '#/components/schemas/ETF' description: The full instrument being quoted. title: Instrument is_binding: description: >- Whether the quoted price is binding at execution. Always false for security quotes; binding FX quotes are issued via /order-quotes/fx. title: Is Binding type: boolean order_type: allOf: - $ref: '#/components/schemas/OrderType' description: Market or limit. quote_type: const: etf_market_cash default: etf_market_cash description: >- The kind of order quote returned, which determines the set of fields present in this response. title: Quote Type reservation: $ref: '#/components/schemas/OrderQuoteReservation' side: allOf: - $ref: '#/components/schemas/OrderSide' description: Buy or sell. required: - id - created_at - expires_at - is_binding - instrument - side - order_type - currency - reservation - cash_amount - estimate title: EtfMarketCashQuote type: object EtfMarketQuantityQuote: properties: created_at: description: When the quote was issued. format: date-time title: Created At type: string currency: allOf: - $ref: '#/components/schemas/Currency' description: The currency every cash amount in this quote is given in. estimate: allOf: - $ref: '#/components/schemas/EtfMarketQuantityEstimate' description: Estimated economics at the latest price. expires_at: description: When the quote expires. format: date-time title: Expires At type: string id: description: Quote ID, redeemable via `quote_id` at order placement. title: Id type: string instrument: anyOf: - $ref: '#/components/schemas/Bill' - $ref: '#/components/schemas/CurrencyPair' - $ref: '#/components/schemas/Bond' - $ref: '#/components/schemas/MoneyMarketFund' - $ref: '#/components/schemas/AMC' - $ref: '#/components/schemas/ETF' description: The full instrument being quoted. title: Instrument is_binding: description: >- Whether the quoted price is binding at execution. Always false for security quotes; binding FX quotes are issued via /order-quotes/fx. title: Is Binding type: boolean order_type: allOf: - $ref: '#/components/schemas/OrderType' description: Market or limit. quantity: description: Units the user chose to buy. examples: - '12' title: Quantity type: string quote_type: const: etf_market_quantity default: etf_market_quantity description: >- The kind of order quote returned, which determines the set of fields present in this response. title: Quote Type reservation: $ref: '#/components/schemas/OrderQuoteReservation' side: allOf: - $ref: '#/components/schemas/OrderSide' description: Buy or sell. required: - id - created_at - expires_at - is_binding - instrument - side - order_type - currency - reservation - quantity - estimate title: EtfMarketQuantityQuote type: object MmfMarketCashQuote: properties: cash_amount: description: Cash the user chose to invest (before fees). examples: - '1000.00' title: Cash Amount type: string created_at: description: When the quote was issued. format: date-time title: Created At type: string currency: allOf: - $ref: '#/components/schemas/Currency' description: The currency every cash amount in this quote is given in. estimate: allOf: - $ref: '#/components/schemas/MmfMarketCashEstimate' description: Estimated economics at the latest NAV. expires_at: description: When the quote expires. format: date-time title: Expires At type: string id: description: Quote ID, redeemable via `quote_id` at order placement. title: Id type: string instrument: anyOf: - $ref: '#/components/schemas/Bill' - $ref: '#/components/schemas/CurrencyPair' - $ref: '#/components/schemas/Bond' - $ref: '#/components/schemas/MoneyMarketFund' - $ref: '#/components/schemas/AMC' - $ref: '#/components/schemas/ETF' description: The full instrument being quoted. title: Instrument is_binding: description: >- Whether the quoted price is binding at execution. Always false for security quotes; binding FX quotes are issued via /order-quotes/fx. title: Is Binding type: boolean order_type: allOf: - $ref: '#/components/schemas/OrderType' description: Market or limit. quote_type: const: mmf_market_cash default: mmf_market_cash description: >- The kind of order quote returned, which determines the set of fields present in this response. title: Quote Type reservation: $ref: '#/components/schemas/OrderQuoteReservation' side: allOf: - $ref: '#/components/schemas/OrderSide' description: Buy or sell. required: - id - created_at - expires_at - is_binding - instrument - side - order_type - currency - reservation - cash_amount - estimate title: MmfMarketCashQuote type: object SellQuote: description: >- One shape for every sell, across instrument types. Market sells carry `estimate.price` / `asof` / `cash`; limit sells carry `estimate.min_proceeds` and a top-level `limit_price`. properties: created_at: description: When the quote was issued. format: date-time title: Created At type: string currency: allOf: - $ref: '#/components/schemas/Currency' description: The currency every cash amount in this quote is given in. estimate: allOf: - $ref: '#/components/schemas/SellEstimate' description: Estimated proceeds. expires_at: description: When the quote expires. format: date-time title: Expires At type: string id: description: Quote ID, redeemable via `quote_id` at order placement. title: Id type: string instrument: anyOf: - $ref: '#/components/schemas/Bill' - $ref: '#/components/schemas/CurrencyPair' - $ref: '#/components/schemas/Bond' - $ref: '#/components/schemas/MoneyMarketFund' - $ref: '#/components/schemas/AMC' - $ref: '#/components/schemas/ETF' description: The full instrument being quoted. title: Instrument is_binding: description: >- Whether the quoted price is binding at execution. Always false for security quotes; binding FX quotes are issued via /order-quotes/fx. title: Is Binding type: boolean limit_price: anyOf: - type: string - type: 'null' description: Worst-case price per unit; set on limit sells. examples: - '96.0000' title: Limit Price order_type: allOf: - $ref: '#/components/schemas/OrderType' description: Market or limit. quantity: description: Units the user chose to sell. examples: - '1000' title: Quantity type: string quote_type: const: sell default: sell description: >- The kind of order quote returned, which determines the set of fields present in this response. title: Quote Type reservation: $ref: '#/components/schemas/OrderQuoteReservation' side: allOf: - $ref: '#/components/schemas/OrderSide' description: Buy or sell. required: - id - created_at - expires_at - is_binding - instrument - side - order_type - currency - reservation - quantity - estimate title: SellQuote type: object Error: properties: code: description: A machine-readable error code. title: Code type: string context: additionalProperties: anyOf: - type: string - type: integer description: An optional object for adding extra context to the error. title: Context type: object x-remove-null-from-type-union: true detail: description: A human-readable description of the error. title: Detail type: string docs: description: A URL to documentation about this error code. title: Docs type: string x-remove-null-from-type-union: true params: description: An optional list of params that failed validation. items: $ref: '#/components/schemas/InvalidParam' title: Params type: array x-remove-null-from-type-union: true required: - detail - code title: Error type: object OrderSide: enum: - buy - sell properties: {} title: OrderSide type: string Currency: enum: - EUR - USD - GBP properties: {} title: Currency type: string AmcMarketCashEstimate: properties: asof: description: Timestamp of the price the estimate is based on. format: date-time title: Asof type: string fees: description: Estimated order fees. examples: - '20.00' title: Fees type: string net_cash_amount: description: Cash invested after fees. examples: - '149980.00' title: Net Cash Amount type: string price: description: Latest certificate price per unit. examples: - '109.5501' title: Price type: string quantity: description: Estimated certificate units the order would acquire. examples: - '1369.05' title: Quantity type: string required: - price - asof - quantity - net_cash_amount - fees title: AmcMarketCashEstimate type: object Bill: properties: about: anyOf: - type: string - type: 'null' description: Summary of the instrument. examples: - Common stock listed on the Nasdaq Global Select Market. title: About days_to_maturity: description: Calendar days remaining until maturity. examples: - 182 title: Days To Maturity type: integer decimal_precision: description: Decimal places used by the trading increment. examples: - 2 title: Decimal Precision type: integer enforce_trading_rules: description: Whether order amounts must satisfy the instrument trading rules. title: Enforce Trading Rules type: boolean exchange: anyOf: - type: string - type: 'null' description: MIC of the listing venue. examples: - XNAS title: Exchange icon_url: anyOf: - type: string - type: 'null' description: Public CDN URL of the instrument's icon. examples: - >- https://storage.googleapis.com/sophic-assets/instrument-icons/in_x7GqT.png title: Icon Url id: description: Unique resource identifier. title: Id type: string initial_auction_date: anyOf: - format: date type: string - type: 'null' description: Date of the first auction. examples: - '2024-12-30' title: Initial Auction Date initial_issue_date: description: Date the instrument was first issued. examples: - '2025-01-02' format: date title: Initial Issue Date type: string instrument_type: const: bill description: Instrument type. title: Instrument Type isin: description: International Securities Identification Number. examples: - US5949181045 title: Isin type: string issuer: description: Name of the issuer. examples: - United States Department of the Treasury title: Issuer type: string issuer_country: anyOf: - type: string - type: 'null' description: ISO 3166-1 alpha-2 country code of the issuer. examples: - US title: Issuer Country issuer_credit_rating: description: Issuer credit rating. examples: - AA+ title: Issuer Credit Rating type: string latest_auction_date: anyOf: - format: date type: string - type: 'null' description: Date of the latest auction, including tap issues. examples: - '2025-01-27' title: Latest Auction Date latest_issue_date: anyOf: - format: date type: string - type: 'null' description: Date of the latest issue, including tap issues. examples: - '2025-01-30' title: Latest Issue Date maturity_date: description: Date the instrument matures. examples: - '2025-07-03' format: date title: Maturity Date type: string minimum_initial_cash_investment: description: Minimum cash amount accepted for an initial investment. examples: - '1000.00' title: Minimum Initial Cash Investment type: string minimum_trading_quantity: description: Smallest quantity accepted for an order. examples: - '1.00' title: Minimum Trading Quantity type: string name: description: Display name of the instrument. examples: - Apple Inc. title: Name type: string price_type: allOf: - $ref: '#/components/schemas/PriceType' description: Price quotation type. pro_traders_only: description: Whether the instrument is restricted to professional investors. title: Pro Traders Only type: boolean required_cash_increment: description: Cash increment accepted above the minimum investment. examples: - 100 title: Required Cash Increment type: integer rollout_stage: anyOf: - $ref: '#/components/schemas/InstrumentRolloutStage' - type: 'null' description: Availability stage of the instrument. supports_automatic_rollover: description: Whether positions can roll over automatically at maturity. title: Supports Automatic Rollover type: boolean symbol: description: Market identifier, such as an ISIN or currency pair. examples: - US5949181045 title: Symbol type: string ticker: anyOf: - type: string - type: 'null' description: Ticker symbol of the security. examples: - AAPL title: Ticker trading_currency: allOf: - $ref: '#/components/schemas/Currency' description: Currency used to trade the instrument. examples: - USD trading_increment: description: Smallest quantity increment accepted for orders. examples: - '0.01' title: Trading Increment type: string trading_status: allOf: - $ref: '#/components/schemas/InstrumentTradingStatus' description: Current trading status. required: - id - name - symbol - instrument_type - trading_status - rollout_stage - trading_increment - decimal_precision - pro_traders_only - price_type - isin - issuer - issuer_country - minimum_trading_quantity - trading_currency - initial_issue_date - enforce_trading_rules - minimum_initial_cash_investment - required_cash_increment - maturity_date - days_to_maturity - supports_automatic_rollover - issuer_credit_rating - initial_auction_date - latest_auction_date - latest_issue_date title: Bill type: object CurrencyPair: properties: about: anyOf: - type: string - type: 'null' description: Summary of the instrument. examples: - Common stock listed on the Nasdaq Global Select Market. title: About base_currency: allOf: - $ref: '#/components/schemas/Currency' description: Currency being bought or sold. examples: - EUR decimal_precision: description: Decimal places used by the trading increment. examples: - 2 title: Decimal Precision type: integer exchange: anyOf: - type: string - type: 'null' description: MIC of the listing venue. examples: - XNAS title: Exchange icon_url: anyOf: - type: string - type: 'null' description: Public CDN URL of the instrument's icon. examples: - >- https://storage.googleapis.com/sophic-assets/instrument-icons/in_x7GqT.png title: Icon Url id: description: Unique resource identifier. title: Id type: string instrument_type: const: currency_pair description: Instrument type. title: Instrument Type name: description: Display name of the instrument. examples: - Apple Inc. title: Name type: string price_type: allOf: - $ref: '#/components/schemas/PriceType' description: Price quotation type. pro_traders_only: description: Whether the instrument is restricted to professional investors. title: Pro Traders Only type: boolean quote_currency: allOf: - $ref: '#/components/schemas/Currency' description: Currency in which the pair is priced. examples: - USD rollout_stage: anyOf: - $ref: '#/components/schemas/InstrumentRolloutStage' - type: 'null' description: Availability stage of the instrument. symbol: description: Market identifier, such as an ISIN or currency pair. examples: - US5949181045 title: Symbol type: string trading_increment: description: Smallest quantity increment accepted for orders. examples: - '0.01' title: Trading Increment type: string trading_status: allOf: - $ref: '#/components/schemas/InstrumentTradingStatus' description: Current trading status. required: - id - name - symbol - instrument_type - trading_status - rollout_stage - trading_increment - decimal_precision - pro_traders_only - price_type - base_currency - quote_currency title: CurrencyPair type: object Bond: properties: about: anyOf: - type: string - type: 'null' description: Summary of the instrument. examples: - Common stock listed on the Nasdaq Global Select Market. title: About coupon: description: Annual coupon rate as a percentage. examples: - '4.25' title: Coupon type: string coupon_frequency: anyOf: - $ref: '#/components/schemas/BondCouponFrequency' - type: 'null' description: Frequency of coupon payments. coupon_type: allOf: - $ref: '#/components/schemas/BondCouponType' description: Coupon payment type. day_count_convention: anyOf: - $ref: '#/components/schemas/DayCountConvention' - type: 'null' description: Day-count convention used for coupon calculations. days_to_maturity: description: Calendar days remaining until maturity. examples: - 182 title: Days To Maturity type: integer decimal_precision: description: Decimal places used by the trading increment. examples: - 2 title: Decimal Precision type: integer enforce_trading_rules: description: Whether order amounts must satisfy the instrument trading rules. title: Enforce Trading Rules type: boolean exchange: anyOf: - type: string - type: 'null' description: MIC of the listing venue. examples: - XNAS title: Exchange first_coupon_date: anyOf: - format: date type: string - type: 'null' description: Date of the first scheduled coupon payment. examples: - '2025-07-15' title: First Coupon Date icon_url: anyOf: - type: string - type: 'null' description: Public CDN URL of the instrument's icon. examples: - >- https://storage.googleapis.com/sophic-assets/instrument-icons/in_x7GqT.png title: Icon Url id: description: Unique resource identifier. title: Id type: string initial_auction_date: anyOf: - format: date type: string - type: 'null' description: Date of the first auction. examples: - '2024-12-30' title: Initial Auction Date initial_issue_date: description: Date the instrument was first issued. examples: - '2025-01-02' format: date title: Initial Issue Date type: string instrument_type: const: bond description: Instrument type. title: Instrument Type isin: description: International Securities Identification Number. examples: - US5949181045 title: Isin type: string issuer: description: Name of the issuer. examples: - United States Department of the Treasury title: Issuer type: string issuer_country: anyOf: - type: string - type: 'null' description: ISO 3166-1 alpha-2 country code of the issuer. examples: - US title: Issuer Country issuer_credit_rating: description: Issuer credit rating. examples: - AA+ title: Issuer Credit Rating type: string latest_auction_date: anyOf: - format: date type: string - type: 'null' description: Date of the latest auction, including tap issues. examples: - '2025-01-27' title: Latest Auction Date latest_issue_date: anyOf: - format: date type: string - type: 'null' description: Date of the latest issue, including tap issues. examples: - '2025-01-30' title: Latest Issue Date maturity_date: description: Date the instrument matures. examples: - '2025-07-03' format: date title: Maturity Date type: string minimum_initial_cash_investment: description: Minimum cash amount accepted for an initial investment. examples: - '1000.00' title: Minimum Initial Cash Investment type: string minimum_trading_quantity: description: Smallest quantity accepted for an order. examples: - '1.00' title: Minimum Trading Quantity type: string name: description: Display name of the instrument. examples: - Apple Inc. title: Name type: string next_coupon_date: anyOf: - format: date type: string - type: 'null' description: Next scheduled coupon payment date. examples: - '2026-01-15' title: Next Coupon Date par_value: anyOf: - type: string - type: 'null' description: Nominal value per unit used for price quotation. examples: - '100.00' title: Par Value price_type: allOf: - $ref: '#/components/schemas/PriceType' description: Price quotation type. pro_traders_only: description: Whether the instrument is restricted to professional investors. title: Pro Traders Only type: boolean required_cash_increment: description: Cash increment accepted above the minimum investment. examples: - 100 title: Required Cash Increment type: integer rollout_stage: anyOf: - $ref: '#/components/schemas/InstrumentRolloutStage' - type: 'null' description: Availability stage of the instrument. supports_automatic_rollover: description: Whether positions can roll over automatically at maturity. title: Supports Automatic Rollover type: boolean symbol: description: Market identifier, such as an ISIN or currency pair. examples: - US5949181045 title: Symbol type: string ticker: anyOf: - type: string - type: 'null' description: Ticker symbol of the security. examples: - AAPL title: Ticker trading_currency: allOf: - $ref: '#/components/schemas/Currency' description: Currency used to trade the instrument. examples: - USD trading_increment: description: Smallest quantity increment accepted for orders. examples: - '0.01' title: Trading Increment type: string trading_status: allOf: - $ref: '#/components/schemas/InstrumentTradingStatus' description: Current trading status. upcoming_coupon_amount_per_unit: anyOf: - type: string - type: 'null' description: Next coupon cash amount per unit of face quantity. examples: - '0.0213' title: Upcoming Coupon Amount Per Unit required: - id - name - symbol - instrument_type - trading_status - rollout_stage - trading_increment - decimal_precision - pro_traders_only - price_type - isin - issuer - issuer_country - minimum_trading_quantity - trading_currency - initial_issue_date - enforce_trading_rules - minimum_initial_cash_investment - required_cash_increment - maturity_date - days_to_maturity - supports_automatic_rollover - issuer_credit_rating - initial_auction_date - latest_auction_date - latest_issue_date - coupon_type - coupon_frequency - coupon - par_value title: Bond type: object MoneyMarketFund: properties: about: anyOf: - type: string - type: 'null' description: Summary of the instrument. examples: - Common stock listed on the Nasdaq Global Select Market. title: About benchmark: anyOf: - type: string - type: 'null' description: Benchmark used to evaluate fund performance. examples: - Euro Short-Term Rate (€STR) title: Benchmark dealing_deadline: description: Daily cutoff time for placing orders. examples: - '13:00:00' format: time title: Dealing Deadline type: string dealing_deadline_time_and_day: description: Next dealing cutoff shown as time and date. examples: - 13:00 Jul 15, 2026 title: Dealing Deadline Time And Day type: string decimal_precision: description: Decimal places used by the trading increment. examples: - 2 title: Decimal Precision type: integer enforce_trading_rules: description: Whether order amounts must satisfy the instrument trading rules. title: Enforce Trading Rules type: boolean exchange: anyOf: - type: string - type: 'null' description: MIC of the listing venue. examples: - XNAS title: Exchange fund_management_company: description: Company that manages the fund. examples: - BlackRock Asset Management Ireland Limited title: Fund Management Company type: string fund_ongoing_charges: description: Annual ongoing charges as a percentage. examples: - '0.15' title: Fund Ongoing Charges type: string icon_url: anyOf: - type: string - type: 'null' description: Public CDN URL of the instrument's icon. examples: - >- https://storage.googleapis.com/sophic-assets/instrument-icons/in_x7GqT.png title: Icon Url id: description: Unique resource identifier. title: Id type: string initial_issue_date: description: Date the fund was first issued. examples: - '2013-07-15' format: date title: Initial Issue Date type: string instrument_type: const: money_market_fund description: Instrument type. title: Instrument Type investment_objective: anyOf: - type: string - type: 'null' description: Investment objective of the fund. examples: - Preserve capital while providing daily liquidity and income. title: Investment Objective is_passed_dealing_deadline: description: Whether today's dealing cutoff has passed. title: Is Passed Dealing Deadline type: boolean is_qualifying_mmf: description: Whether the fund qualifies as a QMMF under MiFID. title: Is Qualifying Mmf type: boolean isin: description: International Securities Identification Number. examples: - US5949181045 title: Isin type: string issuer: description: Name of the issuer. examples: - BlackRock Asset Management Ireland Limited title: Issuer type: string issuer_country: anyOf: - type: string - type: 'null' description: ISO 3166-1 alpha-2 country code of the issuer. examples: - US title: Issuer Country issuer_credit_rating: description: Issuer credit rating. examples: - AAA title: Issuer Credit Rating type: string minimum_initial_cash_investment: description: Minimum cash amount accepted for an initial investment. examples: - '1000.00' title: Minimum Initial Cash Investment type: string minimum_trading_quantity: description: Smallest quantity accepted for an order. examples: - '1.00' title: Minimum Trading Quantity type: string name: description: Display name of the instrument. examples: - Apple Inc. title: Name type: string price_type: allOf: - $ref: '#/components/schemas/PriceType' description: Price quotation type. pro_traders_only: description: Whether the instrument is restricted to professional investors. title: Pro Traders Only type: boolean required_cash_increment: description: Cash increment accepted above the minimum investment. examples: - 100 title: Required Cash Increment type: integer rollout_stage: anyOf: - $ref: '#/components/schemas/InstrumentRolloutStage' - type: 'null' description: Availability stage of the instrument. symbol: description: Market identifier, such as an ISIN or currency pair. examples: - US5949181045 title: Symbol type: string ticker: anyOf: - type: string - type: 'null' description: Ticker symbol of the security. examples: - AAPL title: Ticker trading_currency: allOf: - $ref: '#/components/schemas/Currency' description: Currency used to trade the instrument. examples: - USD trading_increment: description: Smallest quantity increment accepted for orders. examples: - '0.01' title: Trading Increment type: string trading_status: allOf: - $ref: '#/components/schemas/InstrumentTradingStatus' description: Current trading status. required: - id - name - symbol - instrument_type - trading_status - rollout_stage - trading_increment - decimal_precision - pro_traders_only - price_type - isin - issuer - issuer_country - minimum_trading_quantity - trading_currency - initial_issue_date - enforce_trading_rules - minimum_initial_cash_investment - required_cash_increment - issuer_credit_rating - dealing_deadline - dealing_deadline_time_and_day - fund_management_company - investment_objective - is_passed_dealing_deadline - benchmark - fund_ongoing_charges - is_qualifying_mmf title: MoneyMarketFund type: object AMC: properties: about: anyOf: - type: string - type: 'null' description: Summary of the instrument. examples: - Common stock listed on the Nasdaq Global Select Market. title: About dealing_deadline: description: Daily cutoff time for placing orders. examples: - '14:00:00' format: time title: Dealing Deadline type: string dealing_deadline_time_and_day: description: Next dealing cutoff shown as time and date. examples: - 14:00 Jul 15, 2026 title: Dealing Deadline Time And Day type: string decimal_precision: description: Decimal places used by the trading increment. examples: - 2 title: Decimal Precision type: integer enforce_trading_rules: description: Whether order amounts must satisfy the instrument trading rules. title: Enforce Trading Rules type: boolean exchange: anyOf: - type: string - type: 'null' description: MIC of the listing venue. examples: - XNAS title: Exchange icon_url: anyOf: - type: string - type: 'null' description: Public CDN URL of the instrument's icon. examples: - >- https://storage.googleapis.com/sophic-assets/instrument-icons/in_x7GqT.png title: Icon Url id: description: Unique resource identifier. title: Id type: string initial_issue_date: description: Date the instrument was first issued. examples: - '2024-09-16' format: date title: Initial Issue Date type: string instrument_type: const: amc description: Instrument type. title: Instrument Type is_passed_dealing_deadline: description: Whether today's dealing cutoff has passed. title: Is Passed Dealing Deadline type: boolean isin: description: International Securities Identification Number. examples: - US5949181045 title: Isin type: string issuer: description: Name of the issuer. examples: - UBS AG title: Issuer type: string issuer_country: anyOf: - type: string - type: 'null' description: ISO 3166-1 alpha-2 country code of the issuer. examples: - US title: Issuer Country issuer_credit_rating: description: Issuer credit rating. examples: - A+ title: Issuer Credit Rating type: string minimum_initial_cash_investment: description: Minimum cash amount accepted for an initial investment. examples: - '1000.00' title: Minimum Initial Cash Investment type: string minimum_trading_quantity: description: Smallest quantity accepted for an order. examples: - '1.00' title: Minimum Trading Quantity type: string name: description: Display name of the instrument. examples: - Apple Inc. title: Name type: string portfolio_manager: anyOf: - type: string - type: 'null' description: Name of the portfolio manager. examples: - UBS Asset Management title: Portfolio Manager price_type: allOf: - $ref: '#/components/schemas/PriceType' description: Price quotation type. pro_traders_only: description: Whether the instrument is restricted to professional investors. title: Pro Traders Only type: boolean provider: anyOf: - type: string - type: 'null' description: Provider of the instrument. examples: - UBS title: Provider required_cash_increment: description: Cash increment accepted above the minimum investment. examples: - 100 title: Required Cash Increment type: integer risk_profile: anyOf: - type: string - type: 'null' description: Risk profile. examples: - Balanced title: Risk Profile rollout_stage: anyOf: - $ref: '#/components/schemas/InstrumentRolloutStage' - type: 'null' description: Availability stage of the instrument. share_class: anyOf: - type: string - type: 'null' description: Share class. examples: - Class A USD title: Share Class strategy: anyOf: - type: string - type: 'null' description: Investment strategy. examples: - Global Macro title: Strategy symbol: description: Market identifier, such as an ISIN or currency pair. examples: - US5949181045 title: Symbol type: string ticker: anyOf: - type: string - type: 'null' description: Ticker symbol of the security. examples: - AAPL title: Ticker trading_currency: allOf: - $ref: '#/components/schemas/Currency' description: Currency used to trade the instrument. examples: - USD trading_increment: description: Smallest quantity increment accepted for orders. examples: - '0.01' title: Trading Increment type: string trading_status: allOf: - $ref: '#/components/schemas/InstrumentTradingStatus' description: Current trading status. required: - id - name - symbol - instrument_type - trading_status - rollout_stage - trading_increment - decimal_precision - pro_traders_only - price_type - isin - issuer - issuer_country - minimum_trading_quantity - trading_currency - initial_issue_date - enforce_trading_rules - minimum_initial_cash_investment - required_cash_increment - issuer_credit_rating - dealing_deadline - dealing_deadline_time_and_day - is_passed_dealing_deadline - strategy - risk_profile - portfolio_manager - share_class - provider title: AMC type: object ETF: properties: about: anyOf: - type: string - type: 'null' description: Summary of the instrument. examples: - Common stock listed on the Nasdaq Global Select Market. title: About currency_sentence: anyOf: - type: string - type: 'null' description: Plain-language description of the fund's currency risk. examples: - >- The fund is denominated in USD; your return in EUR will vary with the USD/EUR rate. title: Currency Sentence decimal_precision: description: Decimal places used by the trading increment. examples: - 2 title: Decimal Precision type: integer display_name: anyOf: - type: string - type: 'null' description: >- Short card headline derived from the legal name with share-class tokens removed. examples: - iShares Core MSCI World UCITS ETF title: Display Name distribution_frequency: anyOf: - $ref: '#/components/schemas/ETFDistributionFrequency' - type: 'null' description: How often a distributing fund pays out income. distribution_policy: anyOf: - $ref: '#/components/schemas/ETFDistributionPolicy' - type: 'null' description: Whether the fund accumulates or distributes its income. enforce_trading_rules: description: Whether order amounts must satisfy the instrument trading rules. title: Enforce Trading Rules type: boolean exchange: anyOf: - type: string - type: 'null' description: MIC of the listing venue. examples: - XNAS title: Exchange expense_ratio: anyOf: - type: string - type: 'null' description: Annual expense ratio as a fraction of assets. examples: - '0.0020' title: Expense Ratio fund_base_currency: anyOf: - $ref: '#/components/schemas/Currency' - type: 'null' description: Currency in which the fund's net assets figure is reported. examples: - USD fund_category: anyOf: - type: string - type: 'null' description: Fund category. examples: - Global Large-Cap Blend Equity title: Fund Category fund_domicile: anyOf: - type: string - type: 'null' description: ISO 3166-1 alpha-2 domicile country code. examples: - IE title: Fund Domicile fund_management: anyOf: - type: string - type: 'null' description: Legal company that manages the fund. examples: - BlackRock Asset Management Ireland Limited title: Fund Management headline: anyOf: - type: string - type: 'null' description: One-line "what do I own" summary shown on the holding card. examples: - Global developed-market equities in a single fund. title: Headline hedge_currency: anyOf: - $ref: '#/components/schemas/Currency' - type: 'null' description: Currency into which foreign-exchange exposure is hedged. examples: - EUR icon_url: anyOf: - type: string - type: 'null' description: Public CDN URL of the instrument's icon. examples: - >- https://storage.googleapis.com/sophic-assets/instrument-icons/in_x7GqT.png title: Icon Url id: description: Unique resource identifier. title: Id type: string initial_issue_date: anyOf: - format: date type: string - type: 'null' description: Fund inception date. examples: - '2009-09-25' title: Initial Issue Date instrument_type: const: etf description: Instrument type. title: Instrument Type isin: description: International Securities Identification Number. examples: - US5949181045 title: Isin type: string issuer: anyOf: - type: string - type: 'null' description: Brand-level name of the fund issuer. examples: - iShares title: Issuer issuer_country: anyOf: - type: string - type: 'null' description: ISO 3166-1 alpha-2 country code of the issuer. examples: - US title: Issuer Country minimum_initial_cash_investment: description: Minimum cash amount accepted for an initial investment. examples: - '1000.00' title: Minimum Initial Cash Investment type: string minimum_trading_quantity: description: Smallest quantity accepted for an order. examples: - '1.00' title: Minimum Trading Quantity type: string name: description: Display name of the instrument. examples: - Apple Inc. title: Name type: string net_assets: anyOf: - type: string - type: 'null' description: Total net asset value of the fund. examples: - '84250000000.00' title: Net Assets price_type: allOf: - $ref: '#/components/schemas/PriceType' description: Price quotation type. pro_traders_only: description: Whether the instrument is restricted to professional investors. title: Pro Traders Only type: boolean replication_method: anyOf: - $ref: '#/components/schemas/ETFReplicationMethod' - type: 'null' description: How the fund replicates its tracking index. required_cash_increment: description: Cash increment accepted above the minimum investment. examples: - 100 title: Required Cash Increment type: integer rhp_years: anyOf: - type: integer - type: 'null' description: Recommended holding period in years from the PRIIPs KID. examples: - 5 title: Rhp Years rollout_stage: anyOf: - $ref: '#/components/schemas/InstrumentRolloutStage' - type: 'null' description: Availability stage of the instrument. sri: anyOf: - $ref: '#/components/schemas/SyntheticRiskIndicator' - type: 'null' description: PRIIPs KID synthetic risk indicator. symbol: description: Market identifier, such as an ISIN or currency pair. examples: - US5949181045 title: Symbol type: string ticker: description: Ticker symbol of the ETF listing. examples: - IWDA title: Ticker type: string tracking_index: anyOf: - type: string - type: 'null' description: Index tracked by the fund. examples: - MSCI World Index title: Tracking Index trading_currency: allOf: - $ref: '#/components/schemas/Currency' description: Currency used to trade the instrument. examples: - USD trading_increment: description: Smallest quantity increment accepted for orders. examples: - '0.01' title: Trading Increment type: string trading_status: allOf: - $ref: '#/components/schemas/InstrumentTradingStatus' description: Current trading status. required: - id - name - symbol - instrument_type - trading_status - rollout_stage - trading_increment - decimal_precision - pro_traders_only - price_type - isin - ticker - issuer - issuer_country - minimum_trading_quantity - trading_currency - initial_issue_date - enforce_trading_rules - minimum_initial_cash_investment - required_cash_increment - fund_management - fund_category - fund_domicile - tracking_index - expense_ratio - replication_method - distribution_policy - distribution_frequency - sri - hedge_currency - display_name - headline - currency_sentence - rhp_years - fund_base_currency title: ETF type: object OrderType: enum: - market - limit properties: {} title: OrderType type: string OrderQuoteReservation: description: What a placement referencing this quote would set aside. properties: amount: description: >- Amount a placement would reserve: a cash amount on a buy, a unit quantity on a sell — see `denomination`. examples: - '1000.00' title: Amount type: string denomination: allOf: - $ref: '#/components/schemas/ReservedDenomination' description: Whether `amount` is a cash amount or a unit quantity. required: - amount - denomination title: OrderQuoteReservation type: object BillMarketCashEstimate: properties: asof: description: Timestamp of the price the estimate is based on. format: date-time title: Asof type: string fees: description: Estimated order fees. examples: - '1.00' title: Fees type: string net_cash_amount: description: Cash invested after fees. examples: - '9999.00' title: Net Cash Amount type: string price: description: Latest price per unit. examples: - '99.9281' title: Price type: string quantity: description: >- Estimated units the order would acquire; for fixed income this is the nominal redeemed at par at maturity. examples: - '10000' title: Quantity type: string yield: anyOf: - type: string - type: 'null' description: >- Annualised yield (yield to maturity for fixed income). Percent, e.g. 2.25 = 2.25%. examples: - '2.25' title: Yield required: - price - asof - quantity - net_cash_amount - fees title: BillMarketCashEstimate type: object BondFixedCouponMarketCashEstimate: properties: accrued_interest: anyOf: - type: string - type: 'null' description: >- Total accrued interest amount (cash, not a percent of par) included in the purchase cost. examples: - '50.0000' title: Accrued Interest annual_income: anyOf: - type: string - type: 'null' description: Estimated annual coupon income (nominal x coupon rate). examples: - '425.00' title: Annual Income asof: description: Timestamp of the price the estimate is based on. format: date-time title: Asof type: string fees: description: Estimated order fees. examples: - '1.00' title: Fees type: string net_cash_amount: description: Cash invested after fees. examples: - '9999.00' title: Net Cash Amount type: string price: description: Latest price per unit. examples: - '99.9281' title: Price type: string quantity: description: >- Estimated units the order would acquire; for fixed income this is the nominal redeemed at par at maturity. examples: - '10000' title: Quantity type: string yield: anyOf: - type: string - type: 'null' description: >- Annualised yield (yield to maturity for fixed income). Percent, e.g. 2.25 = 2.25%. examples: - '2.25' title: Yield required: - price - asof - quantity - net_cash_amount - fees title: BondFixedCouponMarketCashEstimate type: object BondZeroCouponMarketCashEstimate: properties: asof: description: Timestamp of the price the estimate is based on. format: date-time title: Asof type: string fees: description: Estimated order fees. examples: - '1.00' title: Fees type: string net_cash_amount: description: Cash invested after fees. examples: - '9999.00' title: Net Cash Amount type: string price: description: Latest price per unit. examples: - '99.9281' title: Price type: string quantity: description: >- Estimated units the order would acquire; for fixed income this is the nominal redeemed at par at maturity. examples: - '10000' title: Quantity type: string yield: anyOf: - type: string - type: 'null' description: >- Annualised yield (yield to maturity for fixed income). Percent, e.g. 2.25 = 2.25%. examples: - '2.25' title: Yield required: - price - asof - quantity - net_cash_amount - fees title: BondZeroCouponMarketCashEstimate type: object EtfLimitCashEstimate: properties: fees: description: Estimated order fees. examples: - '1.00' title: Fees type: string max_cost: description: Worst-case cash the order can consume at the limit. examples: - '9976.00' title: Max Cost type: string net_cash_amount: description: Cash invested after fees. examples: - '9999.00' title: Net Cash Amount type: string quantity: description: Estimated units affordable at the limit within the budget. examples: - '116' title: Quantity type: string required: - quantity - net_cash_amount - max_cost - fees title: EtfLimitCashEstimate type: object EtfLimitQuantityEstimate: properties: cost: description: All-in cost at the limit price (notional + fees). examples: - '1207.45' title: Cost type: string fees: description: Estimated order fees. examples: - '1.00' title: Fees type: string max_cost: description: Worst-case cash the order can consume at the limit. examples: - '1207.45' title: Max Cost type: string notional: description: Traded value at the limit price (limit x quantity). examples: - '1206.45' title: Notional type: string required: - notional - cost - max_cost - fees title: EtfLimitQuantityEstimate type: object EtfMarketCashEstimate: properties: asof: description: Timestamp of the price the estimate is based on. format: date-time title: Asof type: string fees: description: Estimated order fees. examples: - '1.00' title: Fees type: string net_cash_amount: description: Cash invested after fees. examples: - '9999.00' title: Net Cash Amount type: string price: description: Latest market price per unit. examples: - '703.40' title: Price type: string quantity: description: Estimated units the order would acquire. examples: - '14' title: Quantity type: string required: - price - asof - quantity - net_cash_amount - fees title: EtfMarketCashEstimate type: object EtfMarketQuantityEstimate: properties: asof: description: Timestamp of the price the estimate is based on. format: date-time title: Asof type: string cost: description: Estimated all-in cost (notional + fees). examples: - '1034.04' title: Cost type: string fees: description: Estimated order fees. examples: - '0.00' title: Fees type: string notional: description: Estimated traded value (price x quantity). examples: - '1034.04' title: Notional type: string price: description: Latest market price per unit. examples: - '86.17' title: Price type: string price_buffer_percentage: description: >- Fraction added on top of the cost when sizing the cash reservation, to absorb price movement before execution (0.02 = 2%). The gap between `cost` and `reservation.amount` is this buffer. examples: - '0.0200' title: Price Buffer Percentage type: string required: - price - asof - notional - cost - price_buffer_percentage - fees title: EtfMarketQuantityEstimate type: object MmfMarketCashEstimate: properties: asof: description: Timestamp of the price the estimate is based on. format: date-time title: Asof type: string fees: description: Estimated order fees. examples: - '1.00' title: Fees type: string net_cash_amount: description: Cash invested after fees. examples: - '9999.00' title: Net Cash Amount type: string price: description: Latest price per unit. examples: - '99.9281' title: Price type: string quantity: description: >- Estimated units the order would acquire; for fixed income this is the nominal redeemed at par at maturity. examples: - '10000' title: Quantity type: string yield: anyOf: - type: string - type: 'null' description: >- Annualised yield (yield to maturity for fixed income). Percent, e.g. 2.25 = 2.25%. examples: - '2.25' title: Yield required: - price - asof - quantity - net_cash_amount - fees title: MmfMarketCashEstimate type: object SellEstimate: properties: asof: anyOf: - format: date-time type: string - type: 'null' description: >- Timestamp of the price the estimate is based on; set on market sells. title: Asof cash: anyOf: - type: string - type: 'null' description: Estimated proceeds after fees; set on market sells. examples: - '965.30' title: Cash fees: description: Estimated order fees. examples: - '0.00' title: Fees type: string min_proceeds: anyOf: - type: string - type: 'null' description: Worst-case proceeds at the limit; set on limit sells. examples: - '950.00' title: Min Proceeds price: anyOf: - type: string - type: 'null' description: Latest market price per unit; set on market sells. examples: - '96.53' title: Price required: - fees title: SellEstimate type: object InvalidParam: properties: code: description: A machine-readable error code. title: Code type: string detail: description: Human-readable detail for error. title: Detail type: string path: description: Path to the field name (or index if a list) that errored. items: anyOf: - type: integer - type: string title: Path type: array required: - path - detail - code title: InvalidParam type: object PriceType: enum: - percent - money properties: {} title: PriceType type: string InstrumentRolloutStage: enum: - ga - beta - provisional properties: {} title: InstrumentRolloutStage type: string InstrumentTradingStatus: enum: - buy_sell - buy_only - sell_only - not_trading properties: {} title: InstrumentTradingStatus type: string BondCouponFrequency: enum: - annual - semi_annual - quarterly - monthly - biennial properties: {} title: BondCouponFrequency type: string BondCouponType: enum: - fixed_coupon - floating_coupon - zero_coupon - stepped_coupon - deferred_coupon - pay_in_kind_coupon - indexed_coupon - credit_linked_coupon properties: {} title: BondCouponType type: string DayCountConvention: enum: - 30_360 - actual_360 - actual_365_fixed - actual_actual properties: {} title: DayCountConvention type: string ETFDistributionFrequency: enum: - annual - semi_annual - quarterly - monthly properties: {} title: ETFDistributionFrequency type: string ETFDistributionPolicy: enum: - accumulating - distributing properties: {} title: ETFDistributionPolicy type: string ETFReplicationMethod: enum: - physical - sampling - synthetic properties: {} title: ETFReplicationMethod type: string SyntheticRiskIndicator: enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 properties: {} title: SyntheticRiskIndicator type: integer ReservedDenomination: enum: - cash - units properties: {} title: ReservedDenomination type: string securitySchemes: HTTPBearer: scheme: bearer type: http ````