logo Developer API
Market Buy Orders


Intro

Buy orders are a feature to request items you want to buy, at the price you want to buy them. This feature gives our sellers a heads up for items that will be purchased instantly when listed for sale at or below given prices.

All of the following methods require the API Key, which you can retrieve through the settings page after you enable API access for your account. All API calls are accessible through GET and POST methods. Furthermore, all API calls require Secure Access to be enabled, and a two-factor security code generated for every single API call you make. For information on how to generate this two-factor security code, see the General API documentation.

The interactive widget you will see under the respective API calls here once your account is Secure Access-verified generates the codes automatically.

Default API throttle limits are 8 requests per second. Contact us if you need higher limits.


Create Buy Order

Allows you to create a buy order for a single item. Buy orders are executed within 30 seconds if someone lists an item for sale that is at or below your buy order price. Funds are not withheld because of pending buy orders, but will be automatically cancelled if your account has insufficient funds to execute a buy order when an eligible item is up for sale.

Endpoint
/api/v1/create_buy_order

Request Parameters

api_key
Your API Key as a string.
code
Two-factor authentication code.
name
The name of the item you want to purchase.
price
The price at which you want to purchase the item. Use 'auto' to buy at current market value.
quantity
Number of buy orders to create at this price for this item. (optional)

Example Request

          
https://bitskins.com/api/v1/create_buy_order/?api_key=API_KEY&code=CODE&name=NAME&price=PRICE&quantity=QUANTITY
           
        

Get Expected Place in Queue

Allows you to retrieve the expected place in queue for a new buy order without creating the buy order.

Endpoint
/api/v1/get_expected_place_in_queue_for_new_buy_order

Request Parameters

api_key
Your API Key as a string.
code
Two-factor authentication code.
name
The name of the item you want to purchase.
price
The price at which you want to purchase the item. Use 'auto' to buy at current market value.

Example Request

          
https://bitskins.com/api/v1/get_expected_place_in_queue_for_new_buy_order/?api_key=API_KEY&code=CODE&name=NAME&price=PRICE
           
        

Cancel Buy Order

Allows you to cancel an active buy order.

Endpoint
/api/v1/cancel_buy_order

Request Parameters

api_key
Your API Key as a string.
code
Two-factor authentication code.
buy_order_id
The buy order's ID.

Example Request

          
https://bitskins.com/api/v1/cancel_buy_order/?api_key=API_KEY&code=CODE&buy_order_id=BUY_ORDER_ID
           
        

Cancel All Buy Orders

Allows you to cancel all buy orders for a given item name.

Endpoint
/api/v1/cancel_all_buy_orders

Request Parameters

api_key
Your API Key as a string.
code
Two-factor authentication code.
market_hash_name
The item name

Example Request

          
https://bitskins.com/api/v1/cancel_all_buy_orders/?api_key=API_KEY&code=CODE&market_hash_name=MARKET_HASH_NAME
           
        

Get My Buy Orders

Allows you to retrieve all buy orders you have placed, whether active or not.

Endpoint
/api/v1/get_buy_order_history

Request Parameters

api_key
Your API Key as a string.
code
Two-factor authentication code.
page
The page number. (optional)
type
Either listed, settled, cancelled_by_user, or cancelled_by_system (optional)
market_hash_name
An item's name (optional)

Example Request

          
https://bitskins.com/api/v1/get_buy_order_history/?api_key=API_KEY&code=CODE&page=PAGE&type=TYPE&market_hash_name=MARKET_HASH_NAME
           
        

Get Settled Orders

Allows you to retrieve all buy orders you made that have been settled. Provides information on the item you purchased to settle this buy order. Deprecated, use get_buy_order_history.

Endpoint
/api/v1/get_settled_buy_orders

Request Parameters

api_key
Your API Key as a string.
code
Two-factor authentication code.
page
The page number. (optional)

Example Request

          
https://bitskins.com/api/v1/get_settled_buy_orders/?api_key=API_KEY&code=CODE&page=PAGE
           
        

Get Active Buy Orders

Allows you to retrieve all buy orders that have not been cancelled or settled. Deprecated, use get_buy_order_history.

Endpoint
/api/v1/get_active_buy_orders

Request Parameters

api_key
Your API Key as a string.
code
Two-factor authentication code.
page
The page number. (optional)

Example Request

          
https://bitskins.com/api/v1/get_active_buy_orders/?api_key=API_KEY&code=CODE&page=PAGE
           
        

Get Cancelled Buy Orders

Allows you to retrieve all buy orders that have been cancelled by you or the system. The system cancels buy orders automatically if you have insufficient funds to settle the buy order. Deprecated, use get_buy_order_history.

Endpoint
/api/v1/get_cancelled_buy_orders

Request Parameters

api_key
Your API Key as a string.
code
Two-factor authentication code.
page
Page number. (optional)

Example Request

          
https://bitskins.com/api/v1/get_cancelled_buy_orders/?api_key=API_KEY&code=CODE&page=PAGE
           
        

Get Market Buy Orders

Allows you to retrieve all market orders by all buyers (except your own) that need fulfillment.

Endpoint
/api/v1/get_market_buy_orders

Request Parameters

api_key
Your API Key as a string.
code
Two-factor authentication code.
market_hash_name
The item name for which you seek buy orders. If not provided, you will get active buy orders for all items. (optional)
page
Page number. (optional)

Example Request

          
https://bitskins.com/api/v1/get_market_buy_orders/?api_key=API_KEY&code=CODE&market_hash_name=MARKET_HASH_NAME&page=PAGE
           
        

Summarize Buy Orders

Allows you to retrieve a summary of all market buy orders. Results include your own buy orders, where applicable.

Endpoint
/api/v1/summarize_buy_orders

Request Parameters

api_key
Your API Key as a string.
code
Two-factor authentication code.

Example Request

          
https://bitskins.com/api/v1/summarize_buy_orders/?api_key=API_KEY&code=CODE