houndapi.client.methods package

Submodules

houndapi.client.methods.poll module

class houndapi.client.methods.poll.Poll

Bases: object

async poll(subscription_id: str, limit: int = 50) → List[Context] | None

Poll Subscription Events

Arg:

subscription_id (str): the subscription id limit (int, optional): the limit of polled events default=50

Returns:

Union[None, List[houndapi.schema.context.Context]]

houndapi.client.methods.subscribe module

class houndapi.client.methods.subscribe.Subscribe

Bases: object

async subscribe(subscriptions: LogsSubscription | PendingTransactionsSubscription | List[LogsSubscription | PendingTransactionsSubscription]) → SubscriptionResponse | None

Subscribe

Parameters:

subscriptions (Union[Union[LogsSubscription, PendingTransactionsSubscription],List[Union[LogsSubscription, PendingTransactionsSubscription]]]]) – the Subscriptions

Returns:

Union[None, houndapi.schema.responses.subscription.SubscriptionResponse]

houndapi.client.methods.unsubscribe module

class houndapi.client.methods.unsubscribe.Unsubscribe

Bases: object

async unsubscribe(subscription_id: str) → SubscriptionResponse | None

Unsubscribe

Parameters:

subscription_id (str) – the subscription id

Returns:

Union[None, houndapi.schema.responses.subscription.SubscriptionResponse]

Module contents

class houndapi.client.methods.APIMethods

Bases: Subscribe, Unsubscribe, Poll