nitrado 1.0.12

This application accesses the Nitrado API.

Python Nitrado SDK

tests need a Nitrado subscription account

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. Services

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

4. GameServer

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

5. Games

Custom game specific libraries.

Examples

Connect the Client

To begin using the API you must have the API key saved as an environment variable. The identifer must be labeled as NITRADO_API_KEY.

NITRADO_API_KEY=123456789abcdefghijklmnop

Saving your API key

If you don't know how to save your API key as an environment variable, run this to save it in a .env file locally.

If you already have a .env file, this will append the key to the file.

An important rule of thumb is to never save this file publicly. Add it to your .gitignore file before attempting to upload changes to your repository.

from nitrado import initialize

initialize("your-api-key")

Services

This example highlights how to get the service.

from nitrado import Service

services = Services.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)')>
]