API Reference

ActivityType

Represents activities types.

  • EDUCATION = "education"

  • RECREATIONAL = "recreational"

  • SOCIAL = "social"

  • DIY = "diy"

  • CHARITY = "charity"

  • COOKING = "cooking"

  • RELAXATION = "relaxation"

  • MUSIC = "music"

  • BUSYWORK = "busywork"

BoredActivity

Represents responce of request

  • activity: str

  • accessibility: float

  • type: ActivityType

  • participants: int

  • price: float

  • key: int

  • link: str

BoredClient

Represent methods to send request to bored api

get()

Gets a event with given parameters or random event if parameters not given.

Parameters:

  • key: Optional[int] = None

  • type: Optional[Union[ActivityType, str]] = None

  • participants: Optional[int] = None

  • price: Optional[float] = None

  • min_price: Optional[float] = None

  • max_price: Optional[float] = None

  • accessibility: Optional[float] = None

  • min_accessibility: Optional[float] = None

  • max_accessibility: Optional[float] = None

Returns BoredActivity

Raises BoredException if nothing found.

get_random()

Find a random activity. Similar as get() with no given parameters.

Returns BoredActivity Raises BoredException if nothing found.

get_by_key()

Find an activity by its key.

Parameters:

  • key: int

Returns BoredActivity

Raises BoredException if nothing found.

get_by_type()

Find a random activity with a given type.

Parameters:

  • type: Union[ActivityType, str]

Returns BoredActivity

Raises BoredException if nothing found.

get_by_participants()

Find a random activity with a given number of participants.

Parameters:

  • participants: int

Returns BoredActivity

Raises BoredException if nothing found.

get_by_price()

Find an activity with a specified price.

Parameters:

  • price: float

Returns BoredActivity

Raises BoredException if nothing found.

get_by_min_max_price()

Find an event with a specified price in an inclusively constrained range.

Parameters:

  • min_price: float

  • max_price: float

Returns BoredActivity

Raises BoredException if nothing found.

get_by_accessibility()

Find a price in an inclusively constrained range.

Parameters:

  • accessibility: float

Returns BoredActivity

Raises BoredException if nothing found.

get_by_min_max_accessibility()

Find an event with a specified accessibility in an inclusively constrained range.

Parameters:

  • min_accessibility: float

  • max_accessibility: float

Returns BoredActivity

Raises BoredException if nothing found.

PreviousQuickstart

Last updated