Interact with STNTrading's API
Project description
stntrading
Interact with STNTrading.eu's API hosted at https://api.stntrading.eu
For getting inventories and item names, I recommend using tf2-utils.
Installation
pip install stntrading
Update
pip install --upgrade stntrading
Setup
Find or register your API key on https://stntrading.eu/dev/apikey
If you want to access BETA endpoints shown here, you need STN Premium. For more information read this.
Usage
>>> from stntrading import STN, EStateCodes
>>> stn = STN("26bf8abb59e86b4301aaff5b88547aaf") # (fake api key)
>>> stn.get_key_prices()
{'success': 1, 'result': {'pricing': {'buyPrice': 570.0, 'sellPrice': 606.0}}}
>>> stn.get_key_stock()
{'success': 1, 'result': {'stock': {'canBuy': 15, 'canSell': 15, 'stockLevel': 702, 'stockLimit': 1770}}}
>>> stn.request_key_trade("buy", 1)
{'success': 0, 'error': "Failed to create trade: 'NotEnoughCurrenciesUser'"}
>>> stn.get_trade_status(20530029)
{'success': 1, 'result': {'trade': {'state': 15, 'tradeOfferId': 6697968536}}}
>>> EStateCodes(15).name
CANCELLED_AFTER_SENDING
>>> stn.request_item_trade("buy", "The Team Captain", 1)
{'success': 1, 'result': {'tradeDetails': {'id': 20530029, 'bot': '76561198309976634'}}}
>>> stn.request_item_trade("sell", [12552033523], 1)
{'success': 0, 'error': "Failed to create trade: 'UserItemOverstocked'"}
# ----------------------
# if STN Premium access:
# ----------------------
>>> stn.get_schema()
{'success': 1, 'result': {'schema': ['A Brush with Death', 'A Color Similar to Slate', 'A Deep Commitment to Purple', ...]}}
>>> stn.get_item_details("The Team Captain")
{'success': 1, 'item': {'full_name': 'The Team Captain', 'pricing': {'buy': {'keys': 0, 'metal': 10.0}, 'sell': {'keys': 0, 'metal': 10.88}}, 'stock': {'level': 48, 'limit': 100}}}
Documentation
Documentation can be found on the official wiki or using Swagger.
License
Copyright (c) 2020-2024 offish
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file stntrading-1.1.0.tar.gz
.
File metadata
- Download URL: stntrading-1.1.0.tar.gz
- Upload date:
- Size: 6.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3adeddee715a384b6387ce58928f2a96938724c66de3f66dc331baf09f978db0 |
|
MD5 | 87fd6b3f3b16227f042e5fbf911d84f1 |
|
BLAKE2b-256 | e17f2b96e5bc6018595892df1d1a6845727940a18c7496e4e0a5cefa1e98eba2 |
File details
Details for the file stntrading-1.1.0-py3-none-any.whl
.
File metadata
- Download URL: stntrading-1.1.0-py3-none-any.whl
- Upload date:
- Size: 5.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 670b0993ee02c2530d0eb2d458aa22ebb662c6c12dc055040dc17ea18a311336 |
|
MD5 | b31a3246567ae3a74541a6fe3bfea4c6 |
|
BLAKE2b-256 | d540cfcdec1bf987834ff5c161144f8b928434564092f855e42ca11104f3b8ee |