dmitrydnl / bitskinsapi

A wrapper for the BitSkins API, build on .NET Standard 2.0

What is BitSkinsApi?

An extended wrapper for the BitSkins API. It is a NuGet Package, that build on .NET Standard 2.0. BitSkinsApi allows you to interact with your BitSkins account through methods call. You can sell/buy items, get all BitSkins market data, get your Steam inventory and more. All games available on BitSkins are supported.

Learn more about BitSkins API you can an official BitSkins website.
Learn more about NuGet.

How do I install BitSkinsApi?

To install the NuGet package, you can the Package Manager Console. For more information, see Package consumption overview and workflow.

1. In Visual Studio select the Tools > NuGet Package Manager > Package Manager Console menu command.
2. Once the console opens, check that the Default project drop-down list shows the project into which you want to install the package.
3. Enter the command:
   Install-Package BitSkinsApi -Version 1.2.3

How do I use BitSkinsApi?

All about using BitSkinsApi you can find in documentation.

In short:

1. Register on BitSkins website.
2. Enable API access and two-factor authentication for your BitSkins account.
3. Initialize your BitSkins account in code:
   BitSkinsApi.Account.AccountData.SetupAccount(ApiKey, SecretCode);
   API Key you can retrieve through the BitSkins settings page. The secret code can be found when you enable two-factor authentication for your BitSkins account.
4. Now you can use BitSkinsApi. For example to retrieve your balance BitSkins you need execute function:
   BitSkinsApi.Balance.CurrentBalance.GetAccountBalance();

Features

• Made on .NET Standard
• Easy to use
• Automatic two-factor authentication
• Full coverage of the BitSkins General API
• Full coverage of the BitSkins Buy Orders API
• Full coverage of the BitSkins Crypto Deposits API

Tests

For the tests to work it is necessary to create account_data.json file in BitSkinsApiTest project, in properties this file you must set Copy to Output Directory to Copy always. After that need add in account_data.json this:

{
  "ApiKey": "Your api key",
  "SecretCode": "Your secret code"
}

After that Build Solution.

Requirements for BitSkins inventory and Steam inventory for tests:

1. In the Steam inventory must be at least one item available for sale. This item must be from a game that supported by BitSkins. This is necessary for the SellItemTest test. If successful, you will receive a Steam trade offer, which you can decline.
2. In BitSkins must be at least one item currently on sale by you. This is necessary for the RelistAndDelistItemTest and ModifySaleTest tests.
3. In the BitSkins inventory must be at least one pending withdrawal item. This is necessary for the WithdrawItemTest test. If successful, you will receive a Steam trade offer, which you can decline.
4. On BitSkins account balance must be at least $ 0.01. This is necessary for the BuyItemTest test.

Changes in the BitSkins inventory and Steam inventory after passing tests:

1. In BitSkins, an item is bought for $ 0.01 and stays in the BitSkins inventory.
2. In BitSkins creates a buy order for $ 0.01.
3. There will be several trade offers on Steam, you can cancel them all.

Project requirements for use the BitSkinsApi

BitSkinsApi build on .NET Standard 2.0. To use the BitSkinsApi, version of the platform you are using must implement .NET Standart 2.0.

Learn more about .NET implementation support.

License

This project is licensed under the MIT License - see the LICENSE file for details.