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.2.0.tar.gz (22.4 kB view details)

Uploaded Source

Built Distribution

speedruncompy-0.2.0-py3-none-any.whl (23.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for speedruncompy-0.2.0.tar.gz
Algorithm Hash digest
SHA256 2cfbb5305644bdfb621761a0f1982bd406174e17ac0af4ea0c3e17db1f807794
MD5 bbef895384f45ff28b2e7bb262121f39
BLAKE2b-256 557cdef2fd14f55c424650657952e7b342e5b21e24d929a442d20ca39fc0f92a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for speedruncompy-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7c139716ebb97fb9517798a1314574e523e115460f32c9c9c7bfc783b50f40bd
MD5 e9773bee5bd0e93d58ff724a6b1b8218
BLAKE2b-256 a07bd5f1d7a1f92ff318b0c901082f325b9dfeabe60f786a40aaf0bc9998d258

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