StudioApi

StudioApi ¶

API for managing OrangeTheory studio data.

Provides methods to search for studios, retrieve studio details and services, and manage favorite studios.

get_favorite_studios()

Get the member's favorite studios.

Returns:

Type	Description
`list[StudioDetail]`	list[StudioDetail]: The member's favorite studios.

add_favorite_studio(studio_uuids)

Add a studio to the member's favorite studios.

Parameters:

Name	Type	Description	Default
`studio_uuids`	`list[str] \| str`	The studio UUID or list of studio UUIDs to add to the member's favorite studios. If a string is provided, it will be converted to a list.	required

Returns:

Type	Description
`list[StudioDetail]`	list[StudioDetail]: The new favorite studios.

remove_favorite_studio(studio_uuids)

Remove a studio from the member's favorite studios.

Parameters:

Name	Type	Description	Default
`studio_uuids`	`list[str] \| str`	The studio UUID or list of studio UUIDs to remove from the member's favorite studios. If a string is provided, it will be converted to a list.	required

Returns:

Type	Description
`None`	None

get_studio_services(studio_uuid=None)

Get the services available at a specific studio.

If no studio UUID is provided, the member's home studio will be used.

Parameters:

Name	Type	Description	Default
`studio_uuid`	`str`	The studio UUID to get services for.	`None`

Returns:

Type	Description
`list[StudioService]`	list[StudioService]: The services available at the studio.

get_studio_detail(studio_uuid=None)

Get detailed information about a specific studio.

If no studio UUID is provided, it will default to the user's home studio.

If the studio is not found, it will return a StudioDetail object with default values.

Parameters:

Name	Type	Description	Default
`studio_uuid`	`str`	The studio UUID to get detailed information about.	`None`

Returns:

Name	Type	Description
`StudioDetail`	`StudioDetail`	Detailed information about the studio.

get_studios_by_geo(latitude=None, longitude=None)

Alias for search_studios_by_geo.

Parameters:

Name	Type	Description	Default
`latitude`	`float \| None`	Latitude to search around. Default is None (uses home studio).	`None`
`longitude`	`float \| None`	Longitude to search around. Default is None (uses home studio).	`None`

Returns:

Type	Description
`list[StudioDetail]`	list[StudioDetail]: List of studios that match the search criteria.

search_studios_by_geo(latitude=None, longitude=None, distance=50)

Search for studios by geographic location.

Parameters:

Name	Type	Description	Default
`latitude`	`float`	Latitude of the location to search around, if None uses home studio latitude.	`None`
`longitude`	`float`	Longitude of the location to search around, if None uses home studio longitude.	`None`
`distance`	`int`	The distance in miles to search around the location. Default is 50.	`50`

Returns:

Type	Description
`list[StudioDetail]`	list[StudioDetail]: List of studios that match the search criteria.