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_player             : params = server, player     
.get_status             : params = gameProject       
.get_info               : params = server             
.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_admins_list        : params = server            
.check_work_methods     : params = None              
.count_methods          : params = None              
.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-1.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-1.0-py3-none-any.whl (3.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gerstlix_python-1.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-1.0.tar.gz
Algorithm Hash digest
SHA256 a652c572270b26f3a716927da502a7bb2e7c5c0684883e4040e08221b4826971
MD5 defadde032eed6aa617de570c071c238
BLAKE2b-256 c78b297ac479818b62b3c2cde00447b9e64e53cb7be3c7db88ee0b8b5bae77ed

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gerstlix_python-1.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-1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3d5a6a9b2e8a186868c5bdeb6d3fccd225a53790b7924e640ca7d6befff0675d
MD5 a1ebed02fc6051b0f95de44787e5c400
BLAKE2b-256 42c9ab35e670e69b778c7a1707e72d0da90928b906dc874756a519c178d21cfa

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