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

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for speedruncompy-0.0.2.tar.gz
Algorithm Hash digest
SHA256 f29b8e7a0272466b2ccd6b5b86c8f2b135b183bf2bbb530a8906cc1d3ef9f057
MD5 e9494180e61b89849353b94b975fbc57
BLAKE2b-256 fd791240594ab9bc634dd0d874d2bd225395ae19d1848da0006ccc2bd82ee6ff

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