Skip to content

OnChainEvents API

Used to retrieve on chain events (id registry, keys, storage rent)

API

Method NameRequest TypeResponse TypeDescription
GetOnChainSignerSignerRequestOnChainEventReturns the onchain event for an active signer for an Fid
GetOnChainSignersByFidFidRequestOnChainEventResponseReturns all active account keys (signers) add events for an Fid
GetIdRegistryOnChainEventFidRequestOnChainEventReturns the most recent register/transfer on chain event for an fid
GetIdRegistryOnChainEventByAddressIdRegistryEventByAddressRequestOnChainEventReturns the registration/transfer event by address if it exists (allows looking up fid by address)
GetOnChainEventsOnChainEventRequestOnChainEventResponseReturns all on chain events filtered by type for an Fid (includes inactive keys and expired rent events)

Signer Request

FieldTypeLabelDescription
fiduint64Farcaster ID of the user who generated the Signer
signerbytesPublic Key of the Signer

Fid Request

FieldTypeLabelDescription
fiduint64Farcaster ID of the user
page_sizeuint32(optional) Type of the Link being requested
page_tokenbytes(optional)Type of the Link being requested
reverseboolean(optional) Ordering of the response

IdRegistryEventByAddressRequest

FieldTypeLabelDescription
addressbytes

OnChainEventResponse

FieldTypeLabelDescription
eventsOnChainEventrepeated
next_page_tokenbytesoptional