teambattles-sdk
Official Python SDK for the TeamBattles public developer API.
Auto-generated from the TeamBattles OpenAPI 3.1 specification with Microsoft Kiota. This README is generated by pnpm sdk:docs and regenerates on every API change - do not edit it by hand.
- Language: Python
- Registry: PyPI
- Maturity: Stable
Install
pip install teambattles-sdk
Dependencies
The generated client is a thin veneer over the shared Kiota runtime. This package depends on:
microsoft-kiota-abstractionsmicrosoft-kiota-httpmicrosoft-kiota-serialization-jsonmicrosoft-kiota-serialization-textmicrosoft-kiota-serialization-formmicrosoft-kiota-serialization-multipart
Create a client
Construct a client once with your API key. The factory wires a bearer-token authentication provider and points the client at the production base URL.
import os
from teambattles_sdk import create_teambattles_client
client = create_teambattles_client(os.environ["TEAMBATTLES_API_KEY"])
First call: list the authenticated user's matches
# List the authenticated user's matches (requires matches.user_matches: read)
from teambattles_sdk.models import MatchesRequestBody
result = await client.user.matches.post(MatchesRequestBody(num_items=25))
for match in result.page or []:
print(match.id, match.status)
Authentication
Every request is authenticated with an API key sent as a bearer token:
Authorization: Bearer tb_YOUR_KEY
Create and manage keys at Settings > Developer. Keys carry granular permission scopes - listing the authenticated user's matches requires matches.user_matches: read.
Errors return a JSON body of the form { "error": "machine_code", "details": "optional message" }. Treat the error machine code - not the details message - as the stable programmatic contract: branch on error, and use details only for human-readable context (it may be absent on auth and permission errors).
Documentation
- API reference and guides: https://teambattles.gg/docs/developers
- SDKs overview: https://teambattles.gg/docs/sdks
- This SDK: https://teambattles.gg/docs/sdks/python
- Authentication: https://teambattles.gg/docs/developers/authentication
License
MIT
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file teambattles_sdk-0.2.0.tar.gz.
File metadata
- Download URL: teambattles_sdk-0.2.0.tar.gz
- Upload date:
- Size: 187.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
066d06e5b31f896eb35d6f3dac294a6c2ba9c865214cb60c198c212c8b5c74f9
|
|
| MD5 |
4716af114905eda0aa3b1091120dcac8
|
|
| BLAKE2b-256 |
f9f9158eb554f752d3e4e1c5ce3b5f6f9a4ffc20bf52aaab031dec9587a7f686
|
Provenance
The following attestation bundles were made for teambattles_sdk-0.2.0.tar.gz:
Publisher:
sdks.yml on KarandeepSWranch/teambattles
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
teambattles_sdk-0.2.0.tar.gz -
Subject digest:
066d06e5b31f896eb35d6f3dac294a6c2ba9c865214cb60c198c212c8b5c74f9 - Sigstore transparency entry: 1942883930
- Sigstore integration time:
-
Permalink:
KarandeepSWranch/teambattles@e637bd9d31bf49a41b203c1c143dce87ffc8c2c5 -
Branch / Tag:
refs/tags/v0.2.0 - Owner: https://github.com/KarandeepSWranch
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
sdks.yml@e637bd9d31bf49a41b203c1c143dce87ffc8c2c5 -
Trigger Event:
push
-
Statement type:
File details
Details for the file teambattles_sdk-0.2.0-py3-none-any.whl.
File metadata
- Download URL: teambattles_sdk-0.2.0-py3-none-any.whl
- Upload date:
- Size: 948.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
602e4c3ef86d487a1b6f200f770d06f67e1f98f53e9c2ed0c52a4a387f8b7c7d
|
|
| MD5 |
57acae2a981ed88ebfcd9a597fd1a390
|
|
| BLAKE2b-256 |
253a8b93670c308bfc133594d3058866672bc5f2098b83b52dcd0c4079b3b39e
|
Provenance
The following attestation bundles were made for teambattles_sdk-0.2.0-py3-none-any.whl:
Publisher:
sdks.yml on KarandeepSWranch/teambattles
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
teambattles_sdk-0.2.0-py3-none-any.whl -
Subject digest:
602e4c3ef86d487a1b6f200f770d06f67e1f98f53e9c2ed0c52a4a387f8b7c7d - Sigstore transparency entry: 1942883993
- Sigstore integration time:
-
Permalink:
KarandeepSWranch/teambattles@e637bd9d31bf49a41b203c1c143dce87ffc8c2c5 -
Branch / Tag:
refs/tags/v0.2.0 - Owner: https://github.com/KarandeepSWranch
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
sdks.yml@e637bd9d31bf49a41b203c1c143dce87ffc8c2c5 -
Trigger Event:
push
-
Statement type:
