Skip to main content

Nitrado SDK   Python

Testing

A Python based SDK for the Nitrado RESTful API published at PyPI.


Installation

In your terminal install the nitrado package with pip.

pip install nitrado

Overview

To have access to this application you must have an account created at Nitrado and create an API key.

Wiki - Full documentation

Table of contents

1. Generate API Key

Shows how to get access to your API key.

2. Getting Started

Shows how to log in to the client and use the basic code interface

3. Globals

Basic requests from Nitrado for health and maintenance checks.

4. Services

Data provided outside of the game server. Like server status, user id, and auto extension plan.

5. GameServer

Data directly related to the game server. This includes the player list, game settings, etc.

6. Games

Custom game specific libraries.



Examples

Globals

The basic maintanance tools from Nitrado API.

from nitrado import Global

version = Global.version()
print(version)

'nitrapi-1201-wh2h4'

Services

This example highlights how to get the service.

from nitrado import Service

services = Service.all()
print(services)
[
    <Service(id=1011111, status='active', type_human='Publicserver 10 slots', suspend_date='2023-05-07T01:21:11')>,
    <Service(id=1022222, status='active', type_human='Publicserver 20 slots', suspend_date='2023-07-07T02:11:01')>,
    <Service(id=1033333, status='active', type_human='Publicserver 30 slots', suspend_date='2023-09-07T06:51:41')>
]

GameServer

This example highlights how to get the gameserver.

from nitrado import GameServer

gameservers = GameServer.all()
print(gameservers)
[
    <GameServer(service_id=11111111, location='US', slots=10, ip='1.2.3.4', game_human='ARK: Survival Evolved (Xbox One)')>,
    <GameServer(service_id=22222222, location='US', slots=70, ip='11.22.33.44', game_human='ARK: Survival Evolved (Xbox One)')>
]

Metadata

Release files for nitrado 1.0.33

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for nitrado 1.0.33
File Size Uploaded
nitrado-1.0.33.tar.gz 33.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for nitrado 1.0.33
File Interpreter ABI Platform
nitrado-1.0.33-py3-none-any.whl Python 3 none any Details

Total release size: 70.8 kB

Release files / nitrado-1.0.33.tar.gz

Download URL nitrado-1.0.33.tar.gz
Size 33.3 kB
Tags Source
SHA-256 checksum
How to use checksums
8d987a5afd5c9a2846fd4a3d3fd639cf939a6404c2e381bd506f5b995230eecd
BLAKE2b-256 checksum
How to use checksums
cb57f50692af3165d3dbf35c178c364fd1f3a31d567f30cba7838ae3c059d538
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.9.13

Release files / nitrado-1.0.33-py3-none-any.whl

Download URL nitrado-1.0.33-py3-none-any.whl
Size 37.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
330d607a5ecc19430a15cb67a309dddca730163dd7ecdedb51f4c285abc0ae05
BLAKE2b-256 checksum
How to use checksums
07ae3ea2b494488c7b357f48e830d87061aeed11616750e864b314ee0d854950
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.9.13

Release history Release notifications | RSS feed

This release

1.0.33 This release

2 release files

1.0.32

2 release files

1.0.31

2 release files

1.0.30

2 release files

1.0.29

2 release files

1.0.28

2 release files

1.0.27

2 release files

1.0.26

2 release files

1.0.25

2 release files

1.0.23

2 release files

1.0.22

2 release files

1.0.21

2 release files

1.0.20

2 release files

1.0.19

2 release files

1.0.18

2 release files

1.0.17

2 release files

1.0.16

2 release files

1.0.15

2 release files

1.0.14

2 release files

1.0.13

2 release files

1.0.12

2 release files

1.0.11

2 release files

1.0.10

2 release files

1.0.9

2 release files

1.0.8

2 release files

1.0.7

2 release files

1.0.6

2 release files

1.0.5

2 release files

1.0.4

1 release file

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

0.0.11

2 release files

0.0.10

2 release files

0.0.9

2 release files

0.0.6

2 release files

0.0.5

2 release files

0.0.4

2 release files

0.0.3

2 release files

0.0.2

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page