Breaking Changes to the API

 Learn about the changes to the API that will improve your trading experience.

What is the Purpose & How Will it Affect Users?

On February 4th, 2021 at 6:00pm CET we will be making several upgrades to our current API and WebSockets to improve and stabilize all components. 

We advise users to check the Trading, Fees, and WebSockets endpoints outlined below.  All trading endpoints have been updated therefore, if you create an order with an old parameter, the order will be created however the response from the server will be different.

What are the Changes to the API?

Fee Rates EndpointDeposits & Withdrawals:
– Renamed: currency -> currency_id
– Renamed: minimum -> fee_minimum

Trading:
– Renamed: market -> market_id
– Removed: ask_fee
– Removed: bid_fee
– Added: maker_ratio
– Added: taker_ratio
Creating Order Endpoint
Getting Order by ID Endpoint (Private)
Listing Orders Endpoint (Private)
WS Orders Channel (Private)
Endpoints return orders are now in a single format, meaning they have a unified response.
– No changes: id
– Deprecated but not removed (use «market_id» instead): market
– Added: market_id
– Added: ask_unit
– Added: bid_unit
– No changes: strategy
– Added: type
– Deprecated but not removed (use «type» instead): side
– No changes: price
– No changes: stop_price
– No changes: immediate
– No changes: expiry
– No changes: state
– No changes: trades_count
– Deprecated but not removed (use «user_id» instead): uid
– Added: user_id
– Deprecated but not removed (use «average_execution_price» instead): avg_price
– Added: average_execution_price
– No changes: created_at
– No changes: updated_at
– Deprecated but not removed (use «volume_initial» instead): volume
– Deprecated but not removed (use «volume_remaining» instead): remaining_volume
– Deprecated but not removed (use «volume_executed» instead): executed_volume
– Added: volume_initial
– Added: volume_remaining
– Added: volume_executed
– Deprecated but not removed (use «ask_unit» instead): base
– Deprecated but not removed (use «bid_unit» instead): quote
– Deprecated but not removed (use «funds_used» instead): cost
– Added: funds_used
– Added: funds_received
– Added: fee_model
– Added: fee_ask_bid_ratio
– Added: fee_maker_ratio
– Added: fee_taker_ratio
– Added: fee_unit_default
– Added: fee_discount_default
– Added: fee_unit_instructed
– Added: fee_discount_instructed
– Removed: fee_percentage
– Removed: fee_discount
– Removed: fee_currency
– Removed: income_unit
– Removed: outcome_unit
– Removed: initial_income_amount
– Removed: current_income_amount
– Removed: initial_outcome_amount
– Removed: current_outcome_amount
– Removed: default_fee_unit
– Removed: default_fee_rate
– Removed: default_fee_discount
– Removed: instructed_fee_unit
– Removed: instructed_fee_rate
– Removed: instructed_fee_discount
Listing Trades Endpoint (Private)– Renamed: buyer_uid -> buyer_id
– Renamed: seller_uid -> seller_id
– Deprecated but not removed (don’t use): order_id
– Deprecated but not removed (don’t use): side
– Deprecated but not removed (use funds» instead): total_value
– Deprecated but not removed (use «executed_at» instead): timestamp
– Deprecated but not removed (use «market_id»): market
– Renamed: buyer_fee.rate -> buyer_fee.ratio
– Renamed: seller_fee.rate -> seller_fee.ratio
– Added buyer_fee.model
– Added seller_fee.model
– Added ask_behavior
– Added bid_behavior
– Added ask_id
– Added bid_id
– Added market_id
– Simplified: buyer_income.unit now always equals to ask_unit
– Simplified: buyer_outcome.unit now always equals to bid_unit
– Simplified: seller_income.unit now always equals to bid_unit
– Simplified: seller_outcome.unit now always equals to ask_unit
Listing Trades Endpoint (Public) Deprecated but not removed (use funds» instead): total_value
– Deprecated but not removed (use «executed_at» instead): timestamp
– Deprecated but not removed (use «market_id»): market
WS Trades Channel (Public)– Deprecated but not removed (use funds» instead): total_value
– Deprecated but not removed (use «executed_at» instead): timestamp
– Added: funds
– Added: executed_at
WS Trades Channel (Private)– Renamed: buyer_uid -> buyer_id
– Renamed: seller_uid -> seller_id
– Deprecated but not removed (don’t use): side
– Deprecated but not removed (use funds» instead): total_value
– Deprecated but not removed (use «executed_at» instead): timestamp
– Deprecated but not removed (use «market_id»): market
– Renamed: buyer_fee.rate -> buyer_fee.ratio
– Renamed: seller_fee.rate -> seller_fee.ratio
– Added buyer_fee.model
– Added seller_fee.model
– Added ask_behavior
– Added bid_behavior
– Added market_id
– Added funds
– Simplified: buyer_income.unit now always equals to ask_unit
– Simplified: buyer_outcome.unit now always equals to bid_unit
– Simplified: seller_income.unit now always equals to bid_unit
– Simplified: seller_outcome.unit now always equals to ask_unit

How can I stay up to date on the update?

Follow us on Twitter for updates and an announcement when the upgrade is complete.