--- title: "Retrieve current orders on Smarkets, these include open and recently settled orders." method: GET path: "/v3/orders/" tags: ["orders"] --- # Retrieve current orders on Smarkets, these include open and recently settled orders. `GET /v3/orders/` ## Query parameters - `contract_id` string — This ID uniquely identifies the contract - `created_datetime_max` string, date-time — When was the order created - `created_datetime_min` string, date-time — When was the order created - `id` string[] — Order IDs to filter by - `limit` integer — Maximum number of orders to be retrieved in one API call - `market_id` string[] — Market IDs to filter by - `pagination_last_id` string — The last order id from the previous page, so we can fetch the subsequent orders.
It should be used in conjuntion with the sort parameter - `sequence_number_max` integer — This refers to the sequence number in the account activity - statement endpoint - `sequence_number_min` integer — This refers to the sequence number in the account activity - statement endpoint - `state` string[] — Order states to filter by. By default all order states are returned - `side` 'buy' | 'sell' — side can either be: - `sort` 'id' | '-id' — How to sort the results, it should be used in conjuntion with the pagination parameter - `include_promotion_data` boolean — Whether to enrich the response with bet token and promotion data.
Set to false to skip the promotion lookup when those fields are not needed, in which case they are returned empty ## Response `200` Orders success response - object — Orders success response - `orders` object[], required - `average_price_matched` integer, required — This price can be different from the order price, as it may have been matched at a better price for the user, according to best price execution rules - `average_price_matched_precise` string, required — This price is in percentage basis points with full precision (up to 6 decimal places).
Example: 5000 = 50%, 71.234567 = 0.71234567%
Use this field when deriving stake or returns from quantity to avoid rounding error, particularly after reduction factors are applied. - `best_price` object, nullable - `price` integer, required — This price is in percentage basis points.
Example: 5000 = 50%
To convert it to decimal odds, just divide 10000 by it
Example: 10000 / 5000 = 2.0 (decimal odds).
This price has to conform to a valid tick on the exchange; an invalid price error will be returned if it does not. - `source` string, required — Name of the best price source - `bonus_bet` boolean - `contract_id` string, required — This ID uniquely identifies the contract - `created_datetime` string, date-time, required — When was the order created - `id` string, required — This ID uniquely identifies an order - `label` string, nullable — Label is a user-defined string that will be stored in the order. It can be used to identify different trading strategies - `last_modified_datetime` string, date-time, required — When was the order last modified, usually by the exchange matching it - `market_id` string, required — This ID uniquely identifies the market - `original_order_id` string, nullable, required — This ID uniquely identifies an order - `otc_available` boolean - `outcome` 'winner' | 'loser' | 'deadheat' | 'reduce' | 'void', nullable — The outcome of the contract can be:
  • winner: This contract is the winner or one of the winners of the market
  • loser: This contract is a loser
  • deadheat: There was a tie between this contract and another one. This is quite a rare outcome.
  • reduce: This contract was withdrawn from the market and a reduction factor was applied.
  • void: This contract is no longer allowed to be traded on. - `price` integer, required — This price is in percentage basis points.
    Example: 5000 = 50%
    To convert it to decimal odds, just divide 10000 by it
    Example: 10000 / 5000 = 2.0 (decimal odds).
    This price has to conform to a valid tick on the exchange; an invalid price error will be returned if it does not. - `quantity` integer, required — Quantity is the sum of the total pot (back+lay) in case the order is matched
    The units are 1/100 of a UK penny.
    Example: Quantity 500 = 0.05 GBP
    To convert it to back stake, just multiply by the price and divide by 100000000
    Example: 100000 (quantity) * 5000 (price) / 100000000 = 5 GBP back stake
    The minimum stake is £0.05 or currency equivalent - `quantity_filled` integer, required — The quantity in GBP of the order that was matched - `quantity_filled_pending` integer, required — The quantity in GBP of the order that was matched and pending confirmation.
    Bets will be subject to an eight second ‘Pending’ confirmation delay after being matched.
    If no significant events occur in this period, the bet is confirmed.
    If our scouting feed tells us that a material event (a goal, red card, or penalty) or a set-piece event (corner or dangerous free-kick) might have occurred, the Pending period is extended until we get confirmation either way.
    If subsequent messages confirm that a material event has occurred, we void those bets matched in the preceding eight seconds.
    This is to protect users from courtsiding and faster feeds. - `quantity_filled_pending_user_currency` integer, required — The quantity of the order that is matched, but pending confirmation, converted to the user's currency - `quantity_filled_user_currency` integer, required — The quantity of the order that is matched, converted to the user's currency - `quantity_traded_out_user_currency` integer, required — Quantity is the sum of the total pot (back+lay) in case the order is matched
    The units are 1/10000 * one unit of the user's currency.
    Example: Quantity 500 = 0.05 GBP
    To convert it to back stake, just multiply by the price and divide by 100000000
    Example: 100000 (quantity) * 5000 (price) / 100000000 = 5 GBP back stake
    The minimum stake is £0.05 or currency equivalent - `quantity_unfilled` integer, required — The quantity in GBP of the order that is still unmatched - `quantity_unfilled_user_currency` integer, required — The quantity of the order that is unmatched, converted to the user's currency - `quantity_user_currency` integer, required — Quantity is the sum of the total pot (back+lay) in case the order is matched
    The units are 1/10000 * one unit of the user's currency.
    Example: Quantity 500 = 0.05 GBP
    To convert it to back stake, just multiply by the price and divide by 100000000
    Example: 100000 (quantity) * 5000 (price) / 100000000 = 5 GBP back stake
    The minimum stake is £0.05 or currency equivalent - `sequence_number` integer, required — This refers to the sequence number in the account activity - statement endpoint - `side` 'buy' | 'sell', required — side can either be: - `stake_traded_out_user_currency` number, required — Stake of an order - `state` 'created' | 'partial' | 'filled' | 'settled', required — Order state can be one of four values: