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

Uploaded Source

Built Distribution

speedruncompy-0.3.2-py3-none-any.whl (33.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: speedruncompy-0.3.2.tar.gz
  • Upload date:
  • Size: 39.0 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.2.tar.gz
Algorithm Hash digest
SHA256 d0d14b40c7a38db9de50c500cdce67a9342ad3403025334b769ca0a0ad958bb1
MD5 a7de167eb04074e2f21fc0322daa46e9
BLAKE2b-256 9f8e15d8b662b6e1fef89ee5c72820716741f6a6d972a9829236ad8e1009f181

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for speedruncompy-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 29c0e77b2fc735fa50c1dff6650ca43e5e85c479b9061cb7cc4498106d7b049d
MD5 d2ed909b97ee8044e17c44b61d5d341a
BLAKE2b-256 d9cb1a6e2551b80a2c2d40730cd34c66f7fdc47de8c099d9ed26fa8fd4e98c0e

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