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 | return => json
.get_deputy             : params = server, fractionId | return => json
.get_members            : params = server, fractionId | return => json
.get_minister           : params = server, fractionId | return => json
.get_record_fraction    : params = server, fractionId | return => json
.get_player             : params = server, player     | return => json 
.get_status             : params = gameProject        | return => json
.get_info               : params = server             | return => json 
.get_ghetto_territories : params = server             | return => json
.get_old_players        : params = server             | return => json
.get_rich_players       : params = server             | return => json
.get_deputies           : params = server             | return => json
.get_leaders            : params = server             | return => json
.get_minister_list      : params = server             | return => json
.get_records            : params = server             | return => json
.check_work_methods     : params = None               | return => json
.count_methods          : params = None               | return => int
.get_ip                 : params = ip                 | return => json

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: gerstlix_python-0.2.9.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.9.tar.gz
Algorithm Hash digest
SHA256 b20a66a5169b87a105ef501cc7eb4a3d20b807526e4567374fdde563f3a78507
MD5 0c0c38683dc058f408afa090279ea9ff
BLAKE2b-256 c22dd66eb9dd2f9a5be7ac5d3ee8ba3c151bcbba85f197edf5e953ac9078b7de

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gerstlix_python-0.2.9-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.9-py3-none-any.whl
Algorithm Hash digest
SHA256 135acc03858a628f9d55fec5f103184f20220c74cac9a4776ffea040e9ec0cbe
MD5 a60e0daa4991f83107fd7e489cc8404b
BLAKE2b-256 3ae6d01c029edea22ac2450cb6279df6b19998a87aaf15386ce9928effc00e2a

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