📚 API Reference

Contents

📚 API Reference#

Config#

class Config[source]#

Bases: object

Global configuration settings.

REGION: ClassVar[str | Region] = 'ru'#

Game server region. Defaults to ru.

REALM: ClassVar[str | Realm] = 'ru'#

Game version realm. Defaults to ru.

LANGUAGE: ClassVar[str | Language] = 'ru'#

UNUSED. Entity localization. Defaults to ru.

LIMIT: ClassVar[int] = 20#

Pagination limit (0-100). Defaults to 20.

OFFSET: ClassVar[int] = 0#

Pagination offset. Defaults to 0.

ORDER_AUCTION: ClassVar[str | Order] = 'desc'#

Auction ordering direction. Defaults to descending.

ORDER_OPERATION: ClassVar[str | Order] = 'desc'#

Operations ordering direction. Defaults to descending.

SORT_AUCTION: ClassVar[str | SortAuction] = 'time_created'#

Auction sorting field. Defaults to time_created.

SORT_OPERATION: ClassVar[str | SortOperations] = 'date_finish'#

Operations sessions sorting field. Defaults to date_finish.

ADDITIONAL: ClassVar[bool] = False#

Auction additional json data flag. Defaults to False.

Consts#

class BaseUrl[source]#

Bases: object

Base URLs for API endpoints.

DEMO = 'http://dapi.stalcraft.net'#
EXTERNAL = 'http://eapi.stalcraft.net'#
PRODUCTION = 'http://eapi.stalcraft.net'#
OAUTH = 'https://exbo.net/oauth'#
class DatabaseRepository[source]#

Bases: object

Git Repository storing game entity ids, data and translations.

OWNER = 'EXBO-Studio'#
REPOSITORY = 'stalcraft-database'#
BRANCH = 'main'#
class Defaults[source]#

Bases: object

Default constant values.

TIMEOUT: int = 60#
JSON: bool = False#
REDIRECT_URI: str = 'http://localhost'#
SCOPE: str = ''#

Enums#

class Region(value)[source]#

Bases: LowercaseStrEnum

Game server region for STALCRAFT API requests.

RU = 'ru'#
RUSSIA = 'ru'#
EU = 'eu'#
EUROPE = 'eu'#
NA = 'na'#
NORTH_AMERICA = 'na'#
SEA = 'sea'#
SOUTH_EAST_ASIA = 'sea'#
NEA = 'nea'#
NORTH_EAST_ASIA = 'nea'#
class Realm(value)[source]#

Bases: LowercaseStrEnum

Game version with separate database.

RU = 'ru'#
RUSSIA = 'ru'#
GLOBAL = 'global'#
class Language(value)[source]#

Bases: LowercaseStrEnum

Supported localization languages.

RU = 'ru'#
RUSSIAN = 'ru'#
EN = 'en'#
ENGLISH = 'en'#
ES = 'es'#
SPANISH = 'es'#
FR = 'fr'#
FRENCH = 'fr'#
KO = 'ko'#
KOREAN = 'ko'#
class Alliance(value)[source]#

Bases: LowercaseStrEnum

Game alliance name.

STALKERS = 'stalkers'#
BANDITS = 'bandits'#
DUTY = 'duty'#
FREEDOM = 'freedom'#
MERC = 'merc'#
COVENANT = 'covenant'#
class ClanRank(value)[source]#

Bases: UppercaseStrEnum

Game clan member rank name.

RECRUIT = 'RECRUIT'#
COMMONER = 'COMMONER'#
SOLDIER = 'SOLDIER'#
SERGEANT = 'SERGEANT'#
OFFICER = 'OFFICER'#
COLONEL = 'COLONEL'#
LEADER = 'LEADER'#
class Order(value)[source]#

Bases: LowercaseStrEnum

Results ordering direction.

ASC = 'asc'#
ASCENDING = 'asc'#
DESC = 'desc'#
DESCENDING = 'desc'#
class SortAuction(value)[source]#

Bases: LowercaseStrEnum

Auction results sorting criteria.

TIME_CREATED = 'time_created'#
TIME_LEFT = 'time_left'#
CURRENT_PRICE = 'current_price'#
BUYOUT_PRICE = 'buyout_price'#
class SortOperations(value)[source]#

Bases: LowercaseStrEnum

Operations session sorting criteria.

DATE_FINISH = 'date_finish'#
DIFFICULTY = 'difficulty'#
class OperationsMap(value)[source]#

Bases: LowercaseStrEnum

Operations session map names.

BIG_CLEANUP = 'big_cleanup'#
SHOCK_THERAPY = 'shock_therapy'#
SEA_ALIENATION = 'sea_alienation'#
class StatType(value)[source]#

Bases: UppercaseStrEnum

Statistic value type.

INTEGER = 'INTEGER'#
DECIMAL = 'DECIMAL'#
DATE = 'DATE'#
DURATION = 'DURATION'#
class IndexFile(value)[source]#

Bases: LowercaseStrEnum

JSON index files available for entity search.

LISTING = 'listing.json'#
ACHIEVEMENTS = 'achievements.json'#
STATS = 'stats.json'#

Exceptions#

exception ScApiException[source]#

Bases: Exception

Base exception for scapi errors.

exception ClientError[source]#

Bases: ScApiException

Client request related error.

exception CredentialsError[source]#

Bases: ClientError

Client missing credentials.

exception RequestError(data, status, method, url)[source]#

Bases: ClientError

HTTP request error.

data: Any#
status: int#
method: str#
url: URL#
property message: str#
exception BadRequestError(data, status, method, url)[source]#

Bases: RequestError

Invalid request parameters or malformed data.

exception UnauthorizedError(data, status, method, url)[source]#

Bases: RequestError

Missing or invalid authentication credentials.

exception NotFoundError(data, status, method, url)[source]#

Bases: RequestError

Requested resource not found.

exception RateLimitError(data, status, method, url)[source]#

Bases: RequestError

API rate limit exceeded.

exception ServerError(data, status, method, url)[source]#

Bases: RequestError

Server-side error during request.

Contents