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
.check_work_methods     : params = None
.countMethods           : params = None

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.5.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.5-py3-none-any.whl (3.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gerstlix_python-0.2.5.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.5.tar.gz
Algorithm Hash digest
SHA256 7d5417e6c23faca78932b1030e27cdc6b8166bd09d1ac390ed6443b2f87b8d08
MD5 8c452e69d850948b6d51e6aa6fc99243
BLAKE2b-256 750813b4f37acd7414782aaa5d4208ffa9bd21ffdfb984a132e12b885d9e12ad

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gerstlix_python-0.2.5-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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 5aee9c70c49af6dfbaf313e66c9dda90951d7ea25d4f81ff24ceeef81dc8f749
MD5 ead0b9a51672557c7d4259219e521769
BLAKE2b-256 1fb95ef6ceec39096676155415c966a2438d9748f253d0c45240b0986be1a8fc

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