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:

import gerstlix_python
gx = gerstlixAPI(token="your_token")

Example

import 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.0.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.0-py3-none-any.whl (3.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gerstlix_python-0.2.0.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.0.tar.gz
Algorithm Hash digest
SHA256 ef961430b0fe879d780e70302e67424689cdf763d6afddba15bdba1da13afa3c
MD5 0f45a2993742b7e86700d19f60ac52aa
BLAKE2b-256 7d7fdc7719834a84e695279aed4d05b629d054367bdc5cf85911912ddc666d88

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gerstlix_python-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 3.9 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 027fe4534789afd5a3edc23aeb39b9113e286179b41dfb4e4b355abe3724a206
MD5 adb6d1b930dbb90d74a5c736ec759d72
BLAKE2b-256 51fde75b4c5d41bfb0db681aa67cf3d5a85752d0429f8335a80fa3bbe3bb5c76

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