Skip to main content

Library for simplified access to the Gerstlix API

Project description

pip install gerstlix_python

What is this?

Library for simplified access to the Gerstlix API

Quick Guide

To access the methods of the module, you need to:

from  gerstlix_python *
gx = gerstlixAPI(token="your_token")

Example

from  gerstlix_python *
gx = gerstlixAPI(token="your_token")

result = gx.get_members(server=3, fractionId=1)
print(result)

Output

{
    "serverId": 1, 
    "serverName": "serverName", 
    "fractionId": 1, 
    "fractionName": "fractionName", 
    "playersLastUpdate": "2023-10-13 13:03:40", 
    "playersCount": 1, 
    "playersInfo": [
        {
            "nickname": "nickname", 
            "accountId": 1, 
            "rang": 1, 
            "rankLabel": "rankLabel", 
            "isLeader": true, 
            "isOnline": false, 
            "gameId": -1, 
            "level": -1
        }
    ]
}

Currently available methods

.get_leader             : params = server, fractionId
.get_deputy             : params = server, fractionId
.get_members            : params = server, fractionId
.get_minister           : params = server, fractionId
.get_record_fraction    : params = server, fractionId
.get_status             : params = gameProject
.get_ghetto_territories : params = server
.get_old_players        : params = server
.get_rich_players       : params = server
.get_deputies           : params = server
.get_leaders            : params = server
.get_minister_list      : params = server
.get_records            : params = server
.get_ip                 : params = ip

types of parameters

server       : INTEGER
fractionId   : INTEGER
gameProject  : STRING [ arz, marz, rrp ]
ip           : IPv4

Other

Gerstlix site

developer: travkacode

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gerstlix_python-0.2.1.tar.gz (3.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gerstlix_python-0.2.1-py3-none-any.whl (4.0 kB view details)

Uploaded Python 3

File details

Details for the file gerstlix_python-0.2.1.tar.gz.

File metadata

  • Download URL: gerstlix_python-0.2.1.tar.gz
  • Upload date:
  • Size: 3.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.11.4 Windows/10

File hashes

Hashes for gerstlix_python-0.2.1.tar.gz
Algorithm Hash digest
SHA256 fc75144ff0a072bffc2dae8dc96910fffdc6a8ea4f61f99255bac0ba377dfb26
MD5 828fba5e68b3fb24292f6006cba6b2bd
BLAKE2b-256 36f40fe9cc7eb4f22b9fe4c3e59f3ddaaa369f78cb627e0fdcd15d210e3ac97d

See more details on using hashes here.

File details

Details for the file gerstlix_python-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: gerstlix_python-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 4.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.11.4 Windows/10

File hashes

Hashes for gerstlix_python-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f95273a91d5ef4e0ddacbe9179c686fca9f2ecb7c8af8af9cd5593fd888a2fe8
MD5 5237b7905690b4ff4cafd5cd9ef4e19a
BLAKE2b-256 7311fed423070f528bc6c223deb8aa2444140ab70c995dd0c1bfe239994a4e67

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page