Skip to main content

A wrapper for speedrun.com's new v2 API, as used by their new site

Project description

Speedrun.com v2 API wrapper

A WIP python wrapper for speedrun.com's new backend API.

WIP documentation for the API can be found in speedruncom-apiv2-docs

Usage

pip install speedruncompy, then import speedruncompy.

Default namespace contains all endpoints. Login flow in speedruncompy.auth. Other notable fields include enums and exceptions. data_structures is currently unused, but may be useful to help construct common data structures.

Authorisation

Note that this uses the API in the same way as https://speedrun.com. The v2 API does not currently accept the Bearer token the v1 API can use - but v2 is also not half-broken, and contains most of the new features SRC has added over the years.

As such, authorisation requires your username & password (and 2FA token). This means logging in requires a massive leap of trust, and so I encourage you to inspect the auth module, and if you're very concerned consider either changing your SRC password or manually get an authed PHPSESSID with your own requests, then use auth.loginSESSID.

Goals

Future versions will aim to assist further in development;

  • Flesh out data_structures to include most desired structures
  • Document more enums
  • Automatic pagination handling

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

speedruncompy-0.0.3.tar.gz (17.7 kB view details)

Uploaded Source

Built Distribution

speedruncompy-0.0.3-py3-none-any.whl (18.5 kB view details)

Uploaded Python 3

File details

Details for the file speedruncompy-0.0.3.tar.gz.

File metadata

  • Download URL: speedruncompy-0.0.3.tar.gz
  • Upload date:
  • Size: 17.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.17

File hashes

Hashes for speedruncompy-0.0.3.tar.gz
Algorithm Hash digest
SHA256 2958d43241c486a83a333ebfc6f573f50683aac758d48e29c3f58ddae09c7379
MD5 28ee3b3f97816c00ee81e3785ff3cc66
BLAKE2b-256 fd24698c6afc23ec2fc5fa9965ffde518a7d38a72b90961e259cf1a19600db64

See more details on using hashes here.

File details

Details for the file speedruncompy-0.0.3-py3-none-any.whl.

File metadata

File hashes

Hashes for speedruncompy-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 c663243ee7730b12c11391780341a01b1a82c21381874159c14faaa1ba74daab
MD5 f4fb74542ea5f445f4b52fda9a9284bb
BLAKE2b-256 3af8c2df1b082aefb68b2f4cd0d668d8f0ca8e093f8bafb2248b0c8191dc2ed7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page