Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dmitrydnl/bitskinsapi
A wrapper for the BitSkins API, build on .NET Standard 2.0
https://github.com/dmitrydnl/bitskinsapi
api-wrapper bitskins dotnet-standard nuget-package steam
Last synced: 3 months ago
JSON representation
A wrapper for the BitSkins API, build on .NET Standard 2.0
- Host: GitHub
- URL: https://github.com/dmitrydnl/bitskinsapi
- Owner: dmitrydnl
- License: mit
- Archived: true
- Created: 2019-03-25T09:28:32.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T09:03:15.000Z (about 2 years ago)
- Last Synced: 2024-09-25T18:43:57.928Z (3 months ago)
- Topics: api-wrapper, bitskins, dotnet-standard, nuget-package, steam
- Language: C#
- Homepage: https://www.nuget.org/packages/BitSkinsApi/
- Size: 415 KB
- Stars: 13
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# What is BitSkinsApi?
[](https://www.codacy.com/app/dmitrydnl/BitSkinsApi?utm_source=github.com&utm_medium=referral&utm_content=dmitrydnl/BitSkinsApi&utm_campaign=Badge_Grade)
[](https://travis-ci.com/dmitrydnl/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](https://bitskins.com/api).
\
Learn more about [NuGet](https://www.nuget.org).
# How do I install BitSkinsApi?
[](https://www.nuget.org/packages/BitSkinsApi/)
[](https://www.nuget.org/packages/BitSkinsApi/)
To install the NuGet package, you can the Package Manager Console. For more information, see [Package consumption overview and workflow](https://docs.microsoft.com/en-us/nuget/consume-packages/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](https://github.com/dmitrydnl/BitSkinsApi/blob/master/docs/index.md).
\
\
In short:
1. Register on [BitSkins website](https://bitskins.com).
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:
```js
{
"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](https://docs.microsoft.com/en-us/dotnet/standard/net-standard#net-implementation-support).
## License
This project is licensed under the MIT License - see the [LICENSE](https://github.com/dmitrydnl/BitSkinsApi/blob/master/LICENSE) file for details.