https://github.com/mark7888/pricestf
https://github.com/mark7888/pricestf
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mark7888/pricestf
- Owner: Mark7888
- License: mit
- Created: 2020-03-05T20:32:22.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-01-12T00:26:33.000Z (over 4 years ago)
- Last Synced: 2024-10-30T18:32:38.472Z (8 months ago)
- Language: Python
- Size: 40 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
- License: LICENSE
Awesome Lists containing this project
README
# PricesTF Python API
This modul is a simple python api for [Nickalson's](https://github.com/Nicklason/) prices.tf website.
### Installation
This module requires [Python](https://www.python.org/) v3+ to run.
For install the module type this to your command line...
```sh
pip install pricestf
```
### Quick Example
```py
from pricestf import get_price
print(get_price("Scattergun", quality="Strange", australium=False, killstreak=0, error_message=True, ratelimit_data=False))
```
It will return a dictionary with the item's full name and with the buy- and sellprices.
```json
{"name": "Strange Scattergun", "buy_price": {"keys": 0, "metal": 18.11}, "sell_price": {"keys": 0, "metal": 18.22}}
```
If something went wring, it returns an error code.
### Getting item history
```py
from pricestf import get_history
print(get_history("Scattergun", quality="Strange", australium=False, killstreak=0, error_message=True, ratelimit_data=False))
```
It will return a dictionary with the item's full name and the list of different prices on different dates.
```json
{"name": "Strange Scattergun", "history": [{"time": 1602993074, "buy": {"keys": 0, "metal": 23.77}, "sell": {"keys": 0, "metal": 24.44}}, {"time": 1602998528, "buy": {"keys": 0, "metal": 23.77}, "sell": {"keys": 0, "metal": 30}}]}
```
##### Error codes:
- `0`: Unknown error
- `1`: Rate limit exceeded
- `2`: Item is not priced
- `3`: No prices for given source
- `4`: No item named
##### [List of tf2 items](https://wiki.alliedmods.net/Team_fortress_2_item_definition_indexes)


##### Qualities:
- Normal
- Genuine
- Vintage
- rarity3
- Unusual
- Unique (Default)
- Community
- Valve
- Self-Made
- Customized
- Strange
- Completed
- Haunted
- Collector's
- Decorated Weapon
##### Australium:
- It can be `True` if australium, and `False` if not. (Default: `False`)
##### Killstreak:
- If ``not killstreak`` it's `0`
- If ``killstreak`` it's `1`
- If ``specialized`` it's `2`
- If ``pofessional`` it's `3`
##### Error message:
- If `True` it will print the error message, if `False` it wont. (Default: `True`)
##### Rate limit:
If `True`, besides the prices it will even return data about the current ratelimit status. (Default: `False`)
```json
{"name": "Strange Scattergun", "buy_price": {"keys": 0, "metal": 18.11}, "sell_price": {"keys": 0, "metal": 18.22}, "ratelimit": {"limit": 180, "remaining": 178, "reset": 1583686816}}
```
Also usable:
```py
from pricestf import ratelimit
print(ratelimit())
```
You will get a dictionary about the current ratelimit status.
```json
{"limit": 180, "remaining": 178, "reset": 1583686816}
```
License
----
MIT