# README
Documentation for API Endpoints
All URIs are relative to https://hub-api.neynar.com
Class | Method | HTTP request | Description |
---|---|---|---|
CastsApi | GetCastById | Get /v1/castById | Get a cast by its FID and Hash. |
CastsApi | ListCastsByFid | Get /v1/castsByFid | Fetch all casts authored by an FID. |
CastsApi | ListCastsByMention | Get /v1/castsByMention | Fetch all casts that mention an FID |
CastsApi | ListCastsByParent | Get /v1/castsByParent | Fetch all casts by parent cast's FID and Hash OR by the parent's URL |
FIDsApi | ListFids | Get /v1/fids | Get a list of all the FIDs |
HubEventsApi | GetEventById | Get /v1/eventById | Get an event by its ID |
HubEventsApi | ListEvents | Get /v1/events | Get a page of Hub events |
InfoApi | GetInfo | Get /v1/info | Sync Methods |
LinksApi | GetLinkById | Get /v1/linkById | Get a link by its FID and target FID. |
LinksApi | ListLinksByFid | Get /v1/linksByFid | Get all links from a source FID |
LinksApi | ListLinksByTargetFid | Get /v1/linksByTargetFid | Get all links to a target FID |
OnChainEventsApi | GetOnChainIdRegistrationByAddress | Get /v1/onChainIdRegistryEventByAddress | Get an on chain ID Registry Event for a given Address |
OnChainEventsApi | ListOnChainEventsByFid | Get /v1/onChainEventsByFid | Get a list of on-chain events provided by an FID |
OnChainEventsApi | ListOnChainSignersByFid | Get /v1/onChainSignersByFid | Get a list of signers provided by an FID |
ReactionsApi | GetReactionById | Get /v1/reactionById | Get a reaction by its created FID and target Cast. |
ReactionsApi | ListReactionsByCast | Get /v1/reactionsByCast | Get all reactions to a cast |
ReactionsApi | ListReactionsByFid | Get /v1/reactionsByFid | Get all reactions by an FID |
ReactionsApi | ListReactionsByTarget | Get /v1/reactionsByTarget | Get all reactions to a target URL |
StorageApi | GetStorageLimitsByFid | Get /v1/storageLimitsByFid | Get an FID's storage limits. |
SubmitMessageApi | SubmitMessage | Post /v1/submitMessage | Submit a signed protobuf-serialized message to the Hub |
UserDataApi | GetUserDataByFid | Get /v1/userDataByFid | Get UserData for a FID. |
UsernamesApi | GetUsernameProof | Get /v1/userNameProofByName | Get an proof for a username by the Farcaster username |
UsernamesApi | ListUsernameProofsByFid | Get /v1/userNameProofsByFid | Get a list of proofs provided by an FID |
ValidateMessageApi | ValidateMessage | Post /v1/validateMessage | Validate a signed protobuf-serialized message with the Hub |
VerificationsApi | ListVerificationsByFid | Get /v1/verificationsByFid | Get a list of verifications provided by an FID |
Documentation For Models
- CastAdd
- CastAddBody
- CastEmbed
- CastId
- CastRemove
- CastRemoveBody
- DbStats
- Embed
- ErrorResponse
- ErrorResponseMetadata
- FarcasterNetwork
- FidsResponse
- FrameActionBody
- HashScheme
- HubEvent
- HubEventMergeMessage
- HubEventMergeOnChainEvent
- HubEventMergeUsernameProof
- HubEventPruneMessage
- HubEventRevokeMessage
- HubInfoResponse
- IdRegisterEventBody
- IdRegisterEventType
- InlineResponse200
- InlineResponse2001
- InlineResponse2002
- InlineResponse2003
- InlineResponse2004
- InlineResponse2005
- InlineResponse2006
- InlineResponse2007
- LinkAdd
- LinkBody
- LinkRemove
- LinkType
- MergeMessageBody
- MergeOnChainEventBody
- MergeUserNameProofBody
- Message
- MessageCommon
- MessageDataCastAdd
- MessageDataCastRemove
- MessageDataCommon
- MessageDataFrameAction
- MessageDataLink
- MessageDataReaction
- MessageDataUserDataAdd
- MessageDataUsernameProof
- MessageDataVerificationAdd
- MessageDataVerificationRemove
- MessageType
- OnChainEvent
- OnChainEventCommon
- OnChainEventIdRegister
- OnChainEventSigner
- OnChainEventSignerMigrated
- OnChainEventStorageRent
- OnChainEventType
- PruneMessageBody
- Reaction
- ReactionBody
- ReactionRemove
- ReactionType
- RevokeMessageBody
- SignatureScheme
- SignerEventBody
- SignerEventType
- SignerMigratedEventBody
- StorageLimit
- StorageLimitsResponse
- StorageRentEventBody
- StoreType
- UrlEmbed
- UserDataAdd
- UserDataBody
- UserDataType
- UserNameProof
- UserNameType
- UsernameProofsResponse
- ValidateMessageResponse
- Verification
- VerificationAddEthAddressBody
- VerificationRemove
- VerificationRemoveBody
Documentation For Authorization
usernamePassword
- Type: HTTP basic authentication
Example
auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
UserName: "username",
Password: "password",
})
r, err := client.Service.Operation(auth, args)