Announcement

Announcement

Announcement(api_key=None, **kwargs: Any)

Bases: API

Client to fetch announcement data from DataMaxi+ API.

Parameters:

• api_key (str, default: None ) –

  The DataMaxi+ API key

• **kwargs (Any, default: {} ) –

  Keyword arguments used by datamaxi.api.API.

get

get(
    category: Optional[str] = None,
    page: int = 1,
    limit: int = 1000,
    sort: str = "desc",
) -> Dict[str, Any]

Get exchange announcements

GET /api/v1/announcements

https://docs.datamaxiplus.com/api/datasets/announcements

Parameters:

• category (str, default: None ) –

  announcement category

• page (int, default: 1 ) –

  Page number

• limit (int, default: 1000 ) –

  Limit of data

• sort (str, default: 'desc' ) –

  Sort order

Returns:

• Dict[str, Any] –

  Announcements