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 import *
gx = gerstlixAPI(token="your_token")

Example

from gerstlix_python import *
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
----------------------------------------
arz          : Arizona Role Play
marz         : Mobile Arizona Role Play
rrp          : Rodina Role Play

Other information

Gerstlix site The module is specially designed for Gerstlix

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.4.tar.gz (3.2 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.4-py3-none-any.whl (3.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gerstlix_python-0.2.4.tar.gz
  • Upload date:
  • Size: 3.2 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.4.tar.gz
Algorithm Hash digest
SHA256 9556e0a40c47805fb49c9a072b5b407129fefb1c6a9887db4f7898407b00580b
MD5 c2f028952d6d081f7c9efe7b610d216d
BLAKE2b-256 2acb70903628e5000374719a72606fd008dbbd98c210328dde8b0b2dfe01014a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gerstlix_python-0.2.4-py3-none-any.whl
  • Upload date:
  • Size: 3.7 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 6470020f0dcb4f696aeedd84da8e4ffcb2a1a9905cd37b959c536f6c77eb9aa9
MD5 4fc0ac3e764006c6d77985fc80bfbf7f
BLAKE2b-256 b0e8860304af81ff37d99c0a27d5b8ecc5c9a7e106b31f73905b71481a4f080f

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