stalcraft api unofficial python library
Project description
stalcraft-api unofficial python library
Official API documentation: https://eapi.stalcraft.net
Before you can use the API, you must register your application and receive approval
For testing Demo API is available
🔧 Install
Pip
pip install stalcraft-api --upgrade
Manual
git clone git@github.com:onejeuu/stalcraft-api.git
cd stalcraft-api
pip install -r requirements.txt
⚡ Quick Start
from stalcraft import AppClient
TOKEN = "YOUR_TOKEN"
client = AppClient(token=TOKEN)
📎 Usage Examples
App Client
from stalcraft import AppClient, Region, Sort, Order
CLIENT_ID = "YOUR_CLIENT_ID"
CLIENT_SECRET = "YOUR_CLIENT_SECRET"
TOKEN = "YOUR_TOKEN"
# Method 1:
client = AppClient(token=TOKEN)
# Method 2:
client = AppClient(client_id=CLIENT_ID, client_secret=CLIENT_SECRET)
print()
print("List of regions")
print(client.regions())
print()
print("List of clans with limit 2")
print(client.clans(limit=2))
print()
print("Information about emission on NA server")
print(client.emission(Region.NA))
print()
print("List of lots for item with id '1r756'")
print("With offset 5, limit 2, sort by buyout price and order by descending")
print(client.auction("1r756").lots(offset=5, limit=2, sort=Sort.BUYOUT_PRICE, order=Order.DESC))
print()
print("List of price history for item with id '1r756'")
print(client.auction("1r756").price_history())
print()
print("Information about clan with id '562968e7-4282-4ac6-900f-f7f1581495e8'")
print(client.clan("562968e7-4282-4ac6-900f-f7f1581495e8").info())
User Client
from stalcraft import UserClient, BaseUrl, Region
TOKEN = "YOUR_TOKEN"
client = UserClient(token=TOKEN, base_url=BaseUrl.DEMO)
# + all methods from AppClient
print("List of characters created by the user on EU server by which used access token was provided")
print(client.characters(Region.EU))
print()
print("List of friends character names who are friend with 'Test-1'")
print(client.friends("Test-1"))
# Members in clan with id '562968e7-4282-4ac6-900f-f7f1581495e8'
# (Can be used only when using user access token and that user has at least one character in that clan)
# client.clan("562968e7-4282-4ac6-900f-f7f1581495e8").members()
#
# Information about player's profile. Includes alliance, profile description, last login time, stats, etc.
# (Not working in DEMO API)
# client.character_profile("ZIV")
Find Item ID by name
from stalcraft import AppClient, LocalItem, WebItem, ItemFolder
TOKEN = "YOUR_TOKEN"
client = AppClient(token=TOKEN)
print()
print("Search by local file")
print(client.auction(LocalItem("Snowflake")).lots())
print()
print("(Not reliable)")
print("Search by listing.json in stalcraft-database github repository")
print(client.auction(WebItem("Snowflake", folder=ItemFolder.GLOBAL)).lots())
Exceptions
from stalcraft import UserClient, LocalItem
from stalcraft.exceptions import (
InvalidToken, StalcraftApiException, ItemException
)
TOKEN = "YOUR_TOKEN"
client = UserClient(token=TOKEN)
def handle_exception(func, exception):
try:
func()
except exception as e:
print("Error:", e)
print()
print("If token is invalid")
handle_exception(lambda: UserClient("test1234567890"), InvalidToken)
print()
print("If an item with that name does not exist")
handle_exception(lambda: LocalItem("test"), ItemException)
print()
print("If one of parameters is invalid")
handle_exception(lambda: client.auction("test").price_history(), StalcraftApiException)
🚫 Rate Limits
# To obtain information about the current rate limit values, you can use client.ratelimit
# Warning: by default client.ratelimit is None until the first request is made (except for regions), so use caution
from stalcraft import AppClient
TOKEN = "YOUR_TOKEN"
client = AppClient(token=TOKEN)
print(client.ratelimit)
# Output: None
client.emission()
print(client.ratelimit)
# Output: RateLimit(limit=200, remaining=199, reset=datetime.datetime(2023, 2, 23, 12, 0, 0, tzinfo=...))
🔑 About Tokens
Get User and App Token
CLIENT_ID = "YOUR_CLIENT_ID"
CLIENT_SECRET = "YOUR_CLIENT_SECRET"
auth = Authorization(client_id=CLIENT_ID, client_secret=CLIENT_SECRET)
print()
print("Get App Token")
print(auth.get_app_token())
print()
print("Get User Code")
print(auth.get_user_code())
auth.input_code()
# or
# auth.code = "USER_CODE"
print()
print("Get User Token")
print(auth.get_user_token())
Refresh User Token
CLIENT_ID = "YOUR_CLIENT_ID"
CLIENT_SECRET = "YOUR_CLIENT_SECRET"
auth = Authorization(client_id=CLIENT_ID, client_secret=CLIENT_SECRET)
REFRESH_TOKEN = "USER_REFRESH_TOKEN"
print()
print("Refresh User Token")
print(auth.update_token(REFRESH_TOKEN))
📋 Output Formats
from stalcraft import AppClient
# Optional
from rich import print
TOKEN = "YOUR_TOKEN"
client = AppClient(token=TOKEN)
print()
print("Object:")
print(client.emission())
# or client = AppClient(TOKEN, json=True)
client.json = True
print()
print("Json:")
print(client.emission())
Output:
Object:
Emission(
current_start=None,
previous_start=datetime.datetime(2023, 1, 30, 5, 16, 52, tzinfo=datetime.timezone.utc),
previous_end=datetime.datetime(2023, 1, 30, 5, 21, 52, tzinfo=datetime.timezone.utc)
)
Json:
{
'previousStart': '2023-01-30T05:16:52Z',
'previousEnd': '2023-01-30T05:21:52Z'
}
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
stalcraft_api-0.2.6.tar.gz
(54.2 kB
view hashes)
Built Distribution
Close
Hashes for stalcraft_api-0.2.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dd265f2ab69bb221800cc33be805dcd22323fcd6278b89ba82605bac7db2046b |
|
MD5 | 3d19d369d083e9042a79e6dbed6c897b |
|
BLAKE2b-256 | 5423454381a703fc4e4c6bb21948b72d3975c1a82b44a054b9d120ed0af5d091 |