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

Uploaded Source

Built Distribution

speedruncompy-0.0.5-py3-none-any.whl (21.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: speedruncompy-0.0.5.tar.gz
  • Upload date:
  • Size: 20.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.0.5.tar.gz
Algorithm Hash digest
SHA256 97a453b9512010085ceeae298cafac6f2d88333c0d0594275d32a45722530176
MD5 e8af507212ea7fd3f1d781296bdf29d8
BLAKE2b-256 4a1f5ed7c322e53765e38c2ad404e8334bf31b8458af8f4ae267c8d3f3956a6b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for speedruncompy-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 b9d9761ef195d1c5e53c8aa93e4cc8f3d3c6a732f55086cfaba26122d36f7cb8
MD5 1fa986f2de75f0225861e4a5902cfaeb
BLAKE2b-256 7c70db04e00905378875c0581b1b6eaf3234c53c56b420e974391f7574dfd69d

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