Skip to main content

A wrapper for speedrun.com's obscure 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.3.0.tar.gz (36.5 kB view details)

Uploaded Source

Built Distribution

speedruncompy-0.3.0-py3-none-any.whl (32.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for speedruncompy-0.3.0.tar.gz
Algorithm Hash digest
SHA256 b65cbff148eb04edc372a6975e87373bc2483289890800552d9513960ad44342
MD5 e081b4f2f998b436f54d55eaa0e4d488
BLAKE2b-256 69d3b5acb0ab53c25061499c9e35f369c0de0abfc57c5836bcde5c8aa7427c46

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for speedruncompy-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e14c54448a59c8462e0b328052f42cb4025b598a3afe4c29f80d3ed8d51ff488
MD5 5fd0f7d48fb9291feb308b6b8862f3c2
BLAKE2b-256 19bc272d27fdddd82ce0bb05b442ec00a60ac8b67568e444ad63603da22cc381

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