houndcore.api.routes package

Submodules

houndcore.api.routes.poll module

async houndcore.api.routes.poll.poll(scanner: Annotated[Scanner, Depends(get_scanner)], sub_id: str, limit: int = 10) List[Context][source]

poll any new updates

Parameters:
  • sub_id (str) – the subscription_id returned from /api/subscribe

  • limit (int, def=10) – the limit of returned events

Returns:

List[Context]

houndcore.api.routes.router module

houndcore.api.routes.subscribe module

async houndcore.api.routes.subscribe.subscribe(scanner: Annotated[Scanner, Depends(get_scanner)], logger: Annotated[Logger, Depends(get_logger)], subscriptions: LogsSubscription | PendingTransactionsSubscription | List[LogsSubscription | PendingTransactionsSubscription]) Json[source]

subscribe to specified subscriptions

Parameters:

subscriptions (Union[SupportedSubscription, List[SupportedSubscription]]) – the subscriptions

Returns:

Json response with subscription ids in the result

houndcore.api.routes.unsubscribe module

async houndcore.api.routes.unsubscribe.unsubscribe(scanner: Annotated[Scanner, Depends(get_scanner)], sub_id: str) Json[source]
Parameters:

sub_id (str) – the subscription id

Returns:

Json

Module contents