BitSkins API client

The unofficial BitSkins API client.

Installation

$ npm install bitskins-api

Example

const BitSkins = require('bitskins-api');
const bitskins = new BitSkins(apiKey, secret);

bitskins.getTradeDetails({ trade_token: 'd3bedb77f7430e68', trade_id: 'ddc126dc3cc4e8a2'  });
bitskins.getMarketData({ names: ['AK-47 | Redline (Field-Tested)'] });

Methods

All of the following methods return a native Promise. Some methods allow you to pass addtional data via an object when calling the API. See the methods API reference to see what data can be sent.

Constructor(apiKey, secret)

• apiKey - Your BitSkins API key. Can be found in your settings page
• secret - Your 2FA secret. This is shown to you when enabling 2FA on your account.

Creates a new BitSkins instance.

General

| Name | Description | Reference | |------------------------------|-------------------------------------------------------------------------------------------|-------------------------------------------------------------------| | getAccountBalance() | Returns your account balance. | Link | | getAllItemPrices() | Returns the entire price database used by Bitskins. | Link | | getMarketData(options) | Returns basic pricing data for up to 250 market_hash_name's that are currently on sale. | Link | | getAccountInventory(options) | Returns your account's available inventory on Steam, Bitskins and pending withdrawals. | Link | | getInventoryOnSale(options) | Returns your inventory currently on sale. | Link | | getResetPriceItems(options) | Returns a paginated list of items that need their prices reset. | Link | | getMoneyEvents(options) | Returns historical events that caused changes in your balance. | Link | | requestWithdrawal(options) | Allows you to request withdrawal of available balance on your BitSkins account. | Link | | buyItem(options) | Allows you to buy an item currently on sale. | Link | | sellItem(options) | Allows you to list an item for sale. | Link | | modifySale(options) | Allows you to change the price(s) of item(s) currently on sale. | Link | | withdrawItem(options) | Lets you delist an active sale item and/or re-attempt an item pending withdrawal. | Link | | bumpItem(options) | Lets you bump items currently listed for a fee. | Link | | getBuyHistory(options) | Returns your purchase history. | Link | | getSellHistory(options) | Returns your sell history. | Link | | getItemHistory(options) | Returns bought / sold / listed item history. | Link | | getTradeDetails(options) | Returns info about items trades sent to / from BitSkins | Link | | getRecentSaleInfo(options) | Returns recent sales for a given item name. | Link |

Buy orders

| Name | Description | Reference | |----------------------------------|------------------------------------------------------------|--------------------------------------------------------------------------------------------------| | createBuyOrder(options) | Creates a buy order. | Link | | getExpectedPlaceInQueue(options) | Returns expected place in queue for a buy order. | Link | | cancelBuyOrder(options) | Cancels a given buy order. | Link | | cancelAllBuyOrders(options) | Cancels all buy orders for a given item name. | Link | | getMyBuyOrders(options) | Returns all buy orders placed. | Link | | getMarketBuyOrders(options) | Returns all market orders on the market. | Link | | summarizeBuyOrders() | Returns a summary of all market orders. | Link |

Bitcoin deposits

| Name | Description | Reference | |-----------------------------------|----------------------------------------------|------------------------------------------------------------------------------| | getBitcoinDepositAddress(options) | Returns your accounts bitcoin address. | Link | | getBitcoinDepositRate(options) | Returns the current conversion rate. | Link | | createBitcoinDeposit(options) | Creates a bitcoin deposit. | Link | | getBitcoinDepositStatus(options) | Returns the status of your Bitcoin deposits. | Link |

Giftable coupons

| Name | Description | Reference | |--------------------------|--------------------------------------------|------------------------------------------------------------| | createCoupons(options) | Creates coupons. | Link | | disableCoupons(options) | Disables given coupons. | Link | | getCoupons() | Returns list of coupons created. | Link | | getCouponStatus(options) | Returns the status of all coupons created. | Link | | redeemCoupon(options) | Redeems a given coupon. | Link |