Skip to main content

Python API for interacting with the Roberts Space Industries site for Star Citizen.

Project description

A community made Python API for interactive with the Roberts Space Industries site for Star Citizen.

Warning

This API is in it’s very early stages and will change often.

Features

  • TODO

Examples

Getting system status:

from rsi.status import Status
s = Status()
current_status = s.system()
recent_incidents = s.timeline()
specific_incident = s.incident('28f92e5a')

Getting Roadmap information:

from datetime import datetime
from rsi.roadmap import Roadmap
r = Roadmap()
cur_roadmap = r.fetch_roadmap(start_date=datetime(year=2021, month=1, day=1),
                              end_date=datetime(year=2021, month=12, day=31))

Accessing ship information:

from rsi.shipmatrix import ShipMatrixAPI
ship_matrix = ShipMatrixAPI()
ship = ship_matrix.ships[170]      # ships is a dictionary, keys are ship IDs
ship = ship_matrix.search_by_name('kraken')

Accessing citizen information:

from rsi.citizen import fetch_citizen
fetch_citizen('ventorvar')

Accessing org information:

from rsi.org import OrgAPI
org = OrgAPI('EXTERRA')
member = org.members[0]

Accessing admin org information for an organization that you have the Officer or Founder role for. This let’s you see the member information for hidden members.

from rsi.org import OrgAPI
org = OrgAPI('EXTERRA', admin_mode=True, username=username, password=password)
member = org.members[0]
members = org.search('fuzzy_handle_matching')     # list of members using fuzzy matching
member = org.search_one('fuzzy_handle_matching')  # returns only the top match

Accessing your hangar:

Hangar access is only for the currently authenticated account.

import rsi
session = rsi.session.RSISession()
session.authenticate('username', 'password')
hangar = rsi.hangar.Hangar(session=session)
print(hangar.ships)
Made By the Star Citizen Community

This project is not endorsed by or affiliated with the Cloud Imperium or Roberts Space Industries group of companies. All game content and materials are copyright Cloud Imperium Rights LLC and Cloud Imperium Rights Ltd.. Star Citizen®, Squadron 42®, Roberts Space Industries®, and Cloud Imperium® are registered trademarks of Cloud Imperium Rights LLC. All rights reserved.

History

0.1.18 (2021-01-11)

  • Added Hangar support

0.1.16 (2020-12-30)

  • Moved to GitLab

0.1.15 (2020-12-23)

  • Added new Roadmap API

0.1.11 (2020-05-02)

  • Added RSI status page API

0.1.2 (2018-12-27)

  • Added Authentication and session management required for accessing privileged Organization members list

0.1.0 (2018-12-10)

  • Initial commit

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pyrsi, version 0.1.19
Filename, size File type Python version Upload date Hashes
Filename, size pyrsi-0.1.19.tar.gz (105.6 kB) File type Source Python version None Upload date Hashes View
Filename, size pyrsi-0.1.19-py2.py3-none-any.whl (20.0 kB) File type Wheel Python version py2.py3 Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page