Simple API client for interacting with the OrangeTheory Fitness APIs.
Review the documentation.
This library allows access to the OrangeTheory API to retrieve workouts and performance data, class schedules, studio information, and bookings.
Installation
pip install otf-api
Overview
To use the API, you need to create an instance of the Otf class. This will authenticate you with the API and allow you to make requests. When the Otf object is created it automatically grabs your member details and home studio, to simplify the process of making requests.
You can either pass an OtfUser object to the OtfClass or you can pass nothing and allow it to prompt you for your username and password.
You can also export environment variables OTF_EMAIL and OTF_PASSWORD to get these from the environment.
from otf_api import Otf, OtfUser
otf = Otf()
# OR
otf = Otf(user=OtfUser(<email_address>,<password>))
OpenAPI Schema
This library generates OpenAPI 3.0.3 schema files from its Pydantic models, providing a machine-readable representation of the API structure and data models. These schemas are automatically generated during the build process and are available as build artifacts.
What's Generated
The OpenAPI schema includes:
- All public Pydantic models from the
otf_api.modelsmodule - Complete type definitions with field descriptions and constraints
- Nested model references and relationships
- Both YAML (
openapi.yaml) and JSON (openapi.json) formats
Why It's Generated
The OpenAPI schema serves as a contract for other language implementations and tools:
- TypeScript Implementation: Used by mphuff/otf-api-ts to generate type-safe TypeScript clients
- API Documentation: Provides machine-readable API documentation
- Code Generation: Enables automatic code generation for other programming languages
- Integration Tools: Supports IDE integrations and API testing tools
Generating the Schema
To generate the OpenAPI schema locally:
# Install dependencies
uv sync
# Generate schema
uv run python scripts/generate_openapi.py
The schema files will be created in the schema/ directory:
schema/openapi.yaml- YAML format (recommended for readability)schema/openapi.json- JSON format (recommended for tooling)
Schema Structure
The generated schema follows OpenAPI 3.0.3 specification with:
- Info: API metadata and version information
- Components/Schemas: All Pydantic models as reusable schema definitions
- Field Names: Uses snake_case field names to match Python usage
- Type References: Properly resolved nested model references
The schema represents the complete structure of public API objects documented in the user documentation, making it easy to build compatible clients in other languages.
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 otf_api-0.21.0.tar.gz.
File metadata
- Download URL: otf_api-0.21.0.tar.gz
- Upload date:
- Size: 94.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0fd987b80403647455777edcf2632634fdeb716884703b064ff1868dc93be041
|
|
| MD5 |
cd528462a15edc01c81cbc4856df7ceb
|
|
| BLAKE2b-256 |
c170f512c98a8262ff4afce3991c9da85c134405226de4caf4754f469647f785
|
Provenance
The following attestation bundles were made for otf_api-0.21.0.tar.gz:
Publisher:
python_package.yml on NodeJSmith/otf-api
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
otf_api-0.21.0.tar.gz -
Subject digest:
0fd987b80403647455777edcf2632634fdeb716884703b064ff1868dc93be041 - Sigstore transparency entry: 2424785264
- Sigstore integration time:
-
Permalink:
NodeJSmith/otf-api@a2ff24cc14a79fe0885193b35b2bc7e217e1921f -
Branch / Tag:
refs/tags/v0.21.0 - Owner: https://github.com/NodeJSmith
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python_package.yml@a2ff24cc14a79fe0885193b35b2bc7e217e1921f -
Trigger Event:
push
-
Statement type:
File details
Details for the file otf_api-0.21.0-py3-none-any.whl.
File metadata
- Download URL: otf_api-0.21.0-py3-none-any.whl
- Upload date:
- Size: 117.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
501bf5a4d81011dd2e1d7442e518897a7a3744de76366747fd405452a599701b
|
|
| MD5 |
1f88e740ce2f49e3fddb1cf43283245c
|
|
| BLAKE2b-256 |
121f9d1ee7f5c8bf561c8e84064f8e312734819c46884bbd5ea51881ad6467d2
|
Provenance
The following attestation bundles were made for otf_api-0.21.0-py3-none-any.whl:
Publisher:
python_package.yml on NodeJSmith/otf-api
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
otf_api-0.21.0-py3-none-any.whl -
Subject digest:
501bf5a4d81011dd2e1d7442e518897a7a3744de76366747fd405452a599701b - Sigstore transparency entry: 2424785360
- Sigstore integration time:
-
Permalink:
NodeJSmith/otf-api@a2ff24cc14a79fe0885193b35b2bc7e217e1921f -
Branch / Tag:
refs/tags/v0.21.0 - Owner: https://github.com/NodeJSmith
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python_package.yml@a2ff24cc14a79fe0885193b35b2bc7e217e1921f -
Trigger Event:
push
-
Statement type:
