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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: speedruncompy-0.0.4.tar.gz
  • Upload date:
  • Size: 17.6 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.4.tar.gz
Algorithm Hash digest
SHA256 a0c23d27d61ae2b540881229d0b73eb20100ac3df06ce2fa14913a01ace52ea3
MD5 636b9b963bd14128226af7fec1a26040
BLAKE2b-256 0ceea14c074780f29844759b87f91344bf5dc8a863f870bb1dd8b7ff3ae21159

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for speedruncompy-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 9932e80718e3575c9eda3da8309f86a088bfa7077c3ce5907e5679e60dd6bcfe
MD5 6a0d5e92a6cc890daea06d3f6a32e755
BLAKE2b-256 a7ea5a913253360fd2f08340ea41114b29689b3ce652721313e9f0331070db3d

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