@neynar/nodejs-sdk
Version:
SDK to interact with Neynar APIs (https://docs.neynar.com/reference/quickstart)
747 lines • 86.1 kB
TypeScript
/**
* Neynar API
* The Neynar API allows you to interact with the Farcaster protocol among other things. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
*
* The version of the OpenAPI document: 3.137.0
* Contact: team@neynar.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import type { Configuration } from '../configuration';
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
import { type RequestArgs, BaseAPI } from '../base';
import type { BalanceResponse } from '../models';
import type { BatchGetTokenMetadata200Response } from '../models';
import type { CreateX402Signature200Response } from '../models';
import type { CreateX402SignatureRequest } from '../models';
import type { DeployErc721201Response } from '../models';
import type { DeployErc721Request } from '../models';
import type { DeployFungibleResponse } from '../models';
import type { FetchFungibleTrades200Response } from '../models';
import type { FetchTrendingFungibles200Response } from '../models';
import type { FungiblesResponseSchema } from '../models';
import type { GetTokenMetadata200Response } from '../models';
import type { GetWalletBalances200Response } from '../models';
import type { MintNft200Response } from '../models';
import type { MintNftRequest } from '../models';
import type { RegisterUserOnChainReqBody } from '../models';
import type { RegisterUserOnChainResponse } from '../models';
import type { RelevantFungibleOwnersResponse } from '../models';
import type { SimulateNftMintResponse } from '../models';
import type { TransactionSendFungiblesReqBody } from '../models';
import type { TransactionSendFungiblesResponse } from '../models';
/**
* OnchainApi - axios parameter creator
* @export
*/
export declare const OnchainApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Fetch metadata for multiple tokens in a single request. Provide comma-separated networks and addresses in the same order. Maximum 100 tokens per request.
* @summary Batch get token metadata
* @param {string} networks Comma-separated list of blockchain networks. Each value must be a valid network (ethereum, optimism, base, arbitrum).
* @param {string} addresses Comma-separated list of token contract addresses corresponding to each network
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<BatchGetTokenMetadata200Response>} A promise that resolves to a `BatchGetTokenMetadata200Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/batch-get-token-metadata)
*
*/
batchGetTokenMetadata: (networks: string, addresses: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Create a signature for a given x402 resource using the specified wallet.
* @summary Create x402 signature
* @param {string} xWalletId Wallet ID to use for transactions
* @param {string} xApiKey
* @param {CreateX402SignatureRequest} createX402SignatureRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<CreateX402Signature200Response>} A promise that resolves to a `CreateX402Signature200Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/create-x402-signature)
*
*/
createX402Signature: (xWalletId: string, xApiKey: string, createX402SignatureRequest: CreateX402SignatureRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Deploy a new ERC-721A (series) NFT collection.
* @summary Deploy ERC-721 collection
* @param {string} xWalletId Wallet ID to use for transactions
* @param {DeployErc721Request} deployErc721Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<DeployErc721201Response>} A promise that resolves to a `DeployErc721201Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/deploy-erc721)
*
*/
deployErc721: (xWalletId: string, deployErc721Request: DeployErc721Request, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Creates a new token. This is an allowlisted API, reach out if you want access.
* @summary Deploy fungible
* @param {string} owner Ethereum address of the one who is creating the token
* @param {string} symbol Symbol/Ticker for the token
* @param {string} name Name of the token
* @param {File | null} [metadataMedia] Media file associated with the token. Supported formats are image/jpeg, image/gif and image/png
* @param {string} [metadataDescription] Description of the token
* @param {DeployFungibleMetadataNsfwEnum} [metadataNsfw] Indicates if the token is NSFW (Not Safe For Work).
* @param {string} [metadataWebsiteLink] Website link related to the token
* @param {string} [metadataTwitter] Twitter profile link
* @param {string} [metadataDiscord] Discord server link
* @param {string} [metadataTelegram] Telegram link
* @param {DeployFungibleNetworkEnum} [network] Network/Chain name
* @param {DeployFungibleFactoryEnum} [factory] Factory name - wow -> [wow.xyz](https://wow.xyz) - clanker -> [clanker.world](https://www.clanker.world)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<DeployFungibleResponse>} A promise that resolves to a `DeployFungibleResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/deploy-fungible)
*
*/
deployFungible: (owner: string, symbol: string, name: string, metadataMedia?: File | null, metadataDescription?: string, metadataNsfw?: DeployFungibleMetadataNsfwEnum, metadataWebsiteLink?: string, metadataTwitter?: string, metadataDiscord?: string, metadataTelegram?: string, network?: DeployFungibleNetworkEnum, factory?: DeployFungibleFactoryEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Get recent trades for a specific fungible within a timeframe. Returns trades ordered by timestamp (most recent first).
* @summary Get fungible trades
* @param {FetchFungibleTradesNetworkEnum} network
* @param {string} address Contract address
* @param {FetchFungibleTradesTimeWindowEnum} [timeWindow] Time window for trades e.g. \"1h\", \"6h\", \"12h\", \"24h\", \"7d\"
* @param {number | null} [minAmountUsd] Minimum USD amount to filter trades
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<FetchFungibleTrades200Response>} A promise that resolves to a `FetchFungibleTrades200Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-fungible-trades)
*
*/
fetchFungibleTrades: (network: FetchFungibleTradesNetworkEnum, address: string, timeWindow?: FetchFungibleTradesTimeWindowEnum, minAmountUsd?: number | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Fetch details for fungible assets identified by fungible identifiers.
* @summary Fetch fungibles
* @param {string} fungibles Comma-separated fungible identifiers
* @param {boolean} [xNeynarExperimental] Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
* @param {number | null} [viewerFid] Optional FID of the viewer to personalize cast count filtering
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<FungiblesResponseSchema>} A promise that resolves to a `FungiblesResponseSchema` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-fungibles)
*
*/
fetchFungibles: (fungibles: string, xNeynarExperimental?: boolean, viewerFid?: number | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Fetch a list of relevant owners for a on chain asset. If a viewer is provided, only relevant holders will be shown. This usually shows on a fungible asset page as \"X, Y, Z and N others you know own this asset\".
* @summary Relevant owners
* @param {string} contractAddress Contract address of the fungible asset (Ethereum or Solana)
* @param {FetchRelevantFungibleOwnersNetworkEnum} network Network of the fungible asset.
* @param {number} [viewerFid] If you provide a viewer_fid, the response will include token holders from the user\'s network, respecting their mutes and blocks and including viewer_context; if not provided, the response will show top token holders across the network—both sets can be combined to generate a longer list if desired.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<RelevantFungibleOwnersResponse>} A promise that resolves to a `RelevantFungibleOwnersResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-relevant-fungible-owners)
*
*/
fetchRelevantFungibleOwners: (contractAddress: string, network: FetchRelevantFungibleOwnersNetworkEnum, viewerFid?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Fetch trending fungibles based on buy activity from watched addresses. Returns fungibles ranked by USD buy volume and buy count within the specified time window.
* @summary Trending fungibles
* @param {FetchTrendingFungiblesNetworkEnum} network
* @param {FetchTrendingFungiblesTimeWindowEnum} [timeWindow] Time window for trending calculations e.g. \"1h\", \"6h\", \"12h\", \"24h\", \"7d\"
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<FetchTrendingFungibles200Response>} A promise that resolves to a `FetchTrendingFungibles200Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-trending-fungibles)
*
*/
fetchTrendingFungibles: (network: FetchTrendingFungiblesNetworkEnum, timeWindow?: FetchTrendingFungiblesTimeWindowEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Fetches the token balances of a user given their FID
* @summary Token balance
* @param {number} fid FID of the user to fetch
* @param {Array<FetchUserBalanceNetworksEnum>} networks Comma separated list of networks to fetch balances for
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<BalanceResponse>} A promise that resolves to a `BalanceResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-user-balance)
*
*/
fetchUserBalance: (fid: number, networks: Array<FetchUserBalanceNetworksEnum>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Fetch metadata for a specific token including price, market data, and basic information. Data is fetched from onchain-indexer with fallback to third-party providers.
* @summary Get token metadata
* @param {GetTokenMetadataNetworkEnum} network A blockchain network e.g. \"ethereum\", \"optimism\", \"base\", \"arbitrum\"
* @param {string} address Ethereum address
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<GetTokenMetadata200Response>} A promise that resolves to a `GetTokenMetadata200Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-token-metadata)
*
*/
getTokenMetadata: (network: GetTokenMetadataNetworkEnum, address: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Fetch all token balances for a wallet address across multiple networks. Results are paginated.
* @summary Get wallet token balances
* @param {string} networks Comma-separated list of networks to query. Each value must be a valid network (ethereum, optimism, base, arbitrum).
* @param {string} address Ethereum address
* @param {number} [limit] Number of results to return (max 100) (Default: 50, Maximum: 100)
* @param {string} [cursor] Pagination cursor.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<GetWalletBalances200Response>} A promise that resolves to a `GetWalletBalances200Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-wallet-balances)
*
*/
getWalletBalances: (networks: string, address: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Mints an NFT to one or more recipients on a specified network and contract, using a configured server wallet. Contact us to set up your wallet configuration if you don\'t have one.
* @summary Mint NFT(s)
* @param {string} xWalletId Wallet ID to use for transactions
* @param {MintNftRequest} mintNftRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<MintNft200Response>} A promise that resolves to a `MintNft200Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/mint-nft)
*
*/
mintNft: (xWalletId: string, mintNftRequest: MintNftRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Register a new farcaster account onchain. Optionally you can pass in signers to register a new account and create multiple signers in a single transaction. Requires x-wallet-id header.
* @summary Register Farcaster account onchain
* @param {string} xWalletId Wallet ID to use for transactions
* @param {RegisterUserOnChainReqBody} registerUserOnChainReqBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<RegisterUserOnChainResponse>} A promise that resolves to a `RegisterUserOnChainResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/register-account-onchain)
*
*/
registerAccountOnchain: (xWalletId: string, registerUserOnChainReqBody: RegisterUserOnChainReqBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Send fungibles in bulk to several farcaster users. A funded wallet is to required use this API. React out to us on the Neynar channel on farcaster to get your wallet address.
* @summary Send fungibles
* @param {string} xWalletId Wallet ID to use for transactions
* @param {TransactionSendFungiblesReqBody} transactionSendFungiblesReqBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<TransactionSendFungiblesResponse>} A promise that resolves to a `TransactionSendFungiblesResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/send-fungibles-to-users)
*
*/
sendFungiblesToUsers: (xWalletId: string, transactionSendFungiblesReqBody: TransactionSendFungiblesReqBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Simulates mint calldata for the given recipients, contract, and network. Useful for previewing calldata and ABI before minting.
* @summary Simulate NFT mint calldata
* @param {string} recipients JSON array of recipients (same structure as POST).
* @param {string} nftContractAddress Ethereum address
* @param {SimulateNftMintNetworkEnum} network Network to mint on.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<SimulateNftMintResponse>} A promise that resolves to a `SimulateNftMintResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/simulate-nft-mint)
*
*/
simulateNftMint: (recipients: string, nftContractAddress: string, network: SimulateNftMintNetworkEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* OnchainApi - functional programming interface
* @export
*/
export declare const OnchainApiFp: (configuration?: Configuration) => {
/**
* Fetch metadata for multiple tokens in a single request. Provide comma-separated networks and addresses in the same order. Maximum 100 tokens per request.
* @summary Batch get token metadata
* @param {string} networks Comma-separated list of blockchain networks. Each value must be a valid network (ethereum, optimism, base, arbitrum).
* @param {string} addresses Comma-separated list of token contract addresses corresponding to each network
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<BatchGetTokenMetadata200Response>} A promise that resolves to a `BatchGetTokenMetadata200Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/batch-get-token-metadata)
*
*/
batchGetTokenMetadata(networks: string, addresses: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BatchGetTokenMetadata200Response>>;
/**
* Create a signature for a given x402 resource using the specified wallet.
* @summary Create x402 signature
* @param {string} xWalletId Wallet ID to use for transactions
* @param {string} xApiKey
* @param {CreateX402SignatureRequest} createX402SignatureRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<CreateX402Signature200Response>} A promise that resolves to a `CreateX402Signature200Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/create-x402-signature)
*
*/
createX402Signature(xWalletId: string, xApiKey: string, createX402SignatureRequest: CreateX402SignatureRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateX402Signature200Response>>;
/**
* Deploy a new ERC-721A (series) NFT collection.
* @summary Deploy ERC-721 collection
* @param {string} xWalletId Wallet ID to use for transactions
* @param {DeployErc721Request} deployErc721Request
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<DeployErc721201Response>} A promise that resolves to a `DeployErc721201Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/deploy-erc721)
*
*/
deployErc721(xWalletId: string, deployErc721Request: DeployErc721Request, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeployErc721201Response>>;
/**
* Creates a new token. This is an allowlisted API, reach out if you want access.
* @summary Deploy fungible
* @param {string} owner Ethereum address of the one who is creating the token
* @param {string} symbol Symbol/Ticker for the token
* @param {string} name Name of the token
* @param {File | null} [metadataMedia] Media file associated with the token. Supported formats are image/jpeg, image/gif and image/png
* @param {string} [metadataDescription] Description of the token
* @param {DeployFungibleMetadataNsfwEnum} [metadataNsfw] Indicates if the token is NSFW (Not Safe For Work).
* @param {string} [metadataWebsiteLink] Website link related to the token
* @param {string} [metadataTwitter] Twitter profile link
* @param {string} [metadataDiscord] Discord server link
* @param {string} [metadataTelegram] Telegram link
* @param {DeployFungibleNetworkEnum} [network] Network/Chain name
* @param {DeployFungibleFactoryEnum} [factory] Factory name - wow -> [wow.xyz](https://wow.xyz) - clanker -> [clanker.world](https://www.clanker.world)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<DeployFungibleResponse>} A promise that resolves to a `DeployFungibleResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/deploy-fungible)
*
*/
deployFungible(owner: string, symbol: string, name: string, metadataMedia?: File | null, metadataDescription?: string, metadataNsfw?: DeployFungibleMetadataNsfwEnum, metadataWebsiteLink?: string, metadataTwitter?: string, metadataDiscord?: string, metadataTelegram?: string, network?: DeployFungibleNetworkEnum, factory?: DeployFungibleFactoryEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeployFungibleResponse>>;
/**
* Get recent trades for a specific fungible within a timeframe. Returns trades ordered by timestamp (most recent first).
* @summary Get fungible trades
* @param {FetchFungibleTradesNetworkEnum} network
* @param {string} address Contract address
* @param {FetchFungibleTradesTimeWindowEnum} [timeWindow] Time window for trades e.g. \"1h\", \"6h\", \"12h\", \"24h\", \"7d\"
* @param {number | null} [minAmountUsd] Minimum USD amount to filter trades
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<FetchFungibleTrades200Response>} A promise that resolves to a `FetchFungibleTrades200Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-fungible-trades)
*
*/
fetchFungibleTrades(network: FetchFungibleTradesNetworkEnum, address: string, timeWindow?: FetchFungibleTradesTimeWindowEnum, minAmountUsd?: number | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FetchFungibleTrades200Response>>;
/**
* Fetch details for fungible assets identified by fungible identifiers.
* @summary Fetch fungibles
* @param {string} fungibles Comma-separated fungible identifiers
* @param {boolean} [xNeynarExperimental] Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
* @param {number | null} [viewerFid] Optional FID of the viewer to personalize cast count filtering
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<FungiblesResponseSchema>} A promise that resolves to a `FungiblesResponseSchema` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-fungibles)
*
*/
fetchFungibles(fungibles: string, xNeynarExperimental?: boolean, viewerFid?: number | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FungiblesResponseSchema>>;
/**
* Fetch a list of relevant owners for a on chain asset. If a viewer is provided, only relevant holders will be shown. This usually shows on a fungible asset page as \"X, Y, Z and N others you know own this asset\".
* @summary Relevant owners
* @param {string} contractAddress Contract address of the fungible asset (Ethereum or Solana)
* @param {FetchRelevantFungibleOwnersNetworkEnum} network Network of the fungible asset.
* @param {number} [viewerFid] If you provide a viewer_fid, the response will include token holders from the user\'s network, respecting their mutes and blocks and including viewer_context; if not provided, the response will show top token holders across the network—both sets can be combined to generate a longer list if desired.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<RelevantFungibleOwnersResponse>} A promise that resolves to a `RelevantFungibleOwnersResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-relevant-fungible-owners)
*
*/
fetchRelevantFungibleOwners(contractAddress: string, network: FetchRelevantFungibleOwnersNetworkEnum, viewerFid?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RelevantFungibleOwnersResponse>>;
/**
* Fetch trending fungibles based on buy activity from watched addresses. Returns fungibles ranked by USD buy volume and buy count within the specified time window.
* @summary Trending fungibles
* @param {FetchTrendingFungiblesNetworkEnum} network
* @param {FetchTrendingFungiblesTimeWindowEnum} [timeWindow] Time window for trending calculations e.g. \"1h\", \"6h\", \"12h\", \"24h\", \"7d\"
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<FetchTrendingFungibles200Response>} A promise that resolves to a `FetchTrendingFungibles200Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-trending-fungibles)
*
*/
fetchTrendingFungibles(network: FetchTrendingFungiblesNetworkEnum, timeWindow?: FetchTrendingFungiblesTimeWindowEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FetchTrendingFungibles200Response>>;
/**
* Fetches the token balances of a user given their FID
* @summary Token balance
* @param {number} fid FID of the user to fetch
* @param {Array<FetchUserBalanceNetworksEnum>} networks Comma separated list of networks to fetch balances for
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<BalanceResponse>} A promise that resolves to a `BalanceResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-user-balance)
*
*/
fetchUserBalance(fid: number, networks: Array<FetchUserBalanceNetworksEnum>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BalanceResponse>>;
/**
* Fetch metadata for a specific token including price, market data, and basic information. Data is fetched from onchain-indexer with fallback to third-party providers.
* @summary Get token metadata
* @param {GetTokenMetadataNetworkEnum} network A blockchain network e.g. \"ethereum\", \"optimism\", \"base\", \"arbitrum\"
* @param {string} address Ethereum address
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<GetTokenMetadata200Response>} A promise that resolves to a `GetTokenMetadata200Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-token-metadata)
*
*/
getTokenMetadata(network: GetTokenMetadataNetworkEnum, address: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTokenMetadata200Response>>;
/**
* Fetch all token balances for a wallet address across multiple networks. Results are paginated.
* @summary Get wallet token balances
* @param {string} networks Comma-separated list of networks to query. Each value must be a valid network (ethereum, optimism, base, arbitrum).
* @param {string} address Ethereum address
* @param {number} [limit] Number of results to return (max 100) (Default: 50, Maximum: 100)
* @param {string} [cursor] Pagination cursor.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<GetWalletBalances200Response>} A promise that resolves to a `GetWalletBalances200Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-wallet-balances)
*
*/
getWalletBalances(networks: string, address: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetWalletBalances200Response>>;
/**
* Mints an NFT to one or more recipients on a specified network and contract, using a configured server wallet. Contact us to set up your wallet configuration if you don\'t have one.
* @summary Mint NFT(s)
* @param {string} xWalletId Wallet ID to use for transactions
* @param {MintNftRequest} mintNftRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<MintNft200Response>} A promise that resolves to a `MintNft200Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/mint-nft)
*
*/
mintNft(xWalletId: string, mintNftRequest: MintNftRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MintNft200Response>>;
/**
* Register a new farcaster account onchain. Optionally you can pass in signers to register a new account and create multiple signers in a single transaction. Requires x-wallet-id header.
* @summary Register Farcaster account onchain
* @param {string} xWalletId Wallet ID to use for transactions
* @param {RegisterUserOnChainReqBody} registerUserOnChainReqBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<RegisterUserOnChainResponse>} A promise that resolves to a `RegisterUserOnChainResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/register-account-onchain)
*
*/
registerAccountOnchain(xWalletId: string, registerUserOnChainReqBody: RegisterUserOnChainReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RegisterUserOnChainResponse>>;
/**
* Send fungibles in bulk to several farcaster users. A funded wallet is to required use this API. React out to us on the Neynar channel on farcaster to get your wallet address.
* @summary Send fungibles
* @param {string} xWalletId Wallet ID to use for transactions
* @param {TransactionSendFungiblesReqBody} transactionSendFungiblesReqBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<TransactionSendFungiblesResponse>} A promise that resolves to a `TransactionSendFungiblesResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/send-fungibles-to-users)
*
*/
sendFungiblesToUsers(xWalletId: string, transactionSendFungiblesReqBody: TransactionSendFungiblesReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransactionSendFungiblesResponse>>;
/**
* Simulates mint calldata for the given recipients, contract, and network. Useful for previewing calldata and ABI before minting.
* @summary Simulate NFT mint calldata
* @param {string} recipients JSON array of recipients (same structure as POST).
* @param {string} nftContractAddress Ethereum address
* @param {SimulateNftMintNetworkEnum} network Network to mint on.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<SimulateNftMintResponse>} A promise that resolves to a `SimulateNftMintResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/simulate-nft-mint)
*
*/
simulateNftMint(recipients: string, nftContractAddress: string, network: SimulateNftMintNetworkEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SimulateNftMintResponse>>;
};
/**
* OnchainApi - factory interface
* @export
*/
export declare const OnchainApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Fetch metadata for multiple tokens in a single request. Provide comma-separated networks and addresses in the same order. Maximum 100 tokens per request.
* @summary Batch get token metadata
* @param {OnchainApiBatchGetTokenMetadataRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<BatchGetTokenMetadata200Response>} A promise that resolves to a `BatchGetTokenMetadata200Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/batch-get-token-metadata)
*
*/
batchGetTokenMetadata(requestParameters: OnchainApiBatchGetTokenMetadataRequest, options?: RawAxiosRequestConfig): AxiosPromise<BatchGetTokenMetadata200Response>;
/**
* Create a signature for a given x402 resource using the specified wallet.
* @summary Create x402 signature
* @param {OnchainApiCreateX402SignatureRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<CreateX402Signature200Response>} A promise that resolves to a `CreateX402Signature200Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/create-x402-signature)
*
*/
createX402Signature(requestParameters: OnchainApiCreateX402SignatureRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateX402Signature200Response>;
/**
* Deploy a new ERC-721A (series) NFT collection.
* @summary Deploy ERC-721 collection
* @param {OnchainApiDeployErc721Request} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<DeployErc721201Response>} A promise that resolves to a `DeployErc721201Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/deploy-erc721)
*
*/
deployErc721(requestParameters: OnchainApiDeployErc721Request, options?: RawAxiosRequestConfig): AxiosPromise<DeployErc721201Response>;
/**
* Creates a new token. This is an allowlisted API, reach out if you want access.
* @summary Deploy fungible
* @param {OnchainApiDeployFungibleRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<DeployFungibleResponse>} A promise that resolves to a `DeployFungibleResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/deploy-fungible)
*
*/
deployFungible(requestParameters: OnchainApiDeployFungibleRequest, options?: RawAxiosRequestConfig): AxiosPromise<DeployFungibleResponse>;
/**
* Get recent trades for a specific fungible within a timeframe. Returns trades ordered by timestamp (most recent first).
* @summary Get fungible trades
* @param {OnchainApiFetchFungibleTradesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<FetchFungibleTrades200Response>} A promise that resolves to a `FetchFungibleTrades200Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-fungible-trades)
*
*/
fetchFungibleTrades(requestParameters: OnchainApiFetchFungibleTradesRequest, options?: RawAxiosRequestConfig): AxiosPromise<FetchFungibleTrades200Response>;
/**
* Fetch details for fungible assets identified by fungible identifiers.
* @summary Fetch fungibles
* @param {OnchainApiFetchFungiblesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<FungiblesResponseSchema>} A promise that resolves to a `FungiblesResponseSchema` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-fungibles)
*
*/
fetchFungibles(requestParameters: OnchainApiFetchFungiblesRequest, options?: RawAxiosRequestConfig): AxiosPromise<FungiblesResponseSchema>;
/**
* Fetch a list of relevant owners for a on chain asset. If a viewer is provided, only relevant holders will be shown. This usually shows on a fungible asset page as \"X, Y, Z and N others you know own this asset\".
* @summary Relevant owners
* @param {OnchainApiFetchRelevantFungibleOwnersRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<RelevantFungibleOwnersResponse>} A promise that resolves to a `RelevantFungibleOwnersResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-relevant-fungible-owners)
*
*/
fetchRelevantFungibleOwners(requestParameters: OnchainApiFetchRelevantFungibleOwnersRequest, options?: RawAxiosRequestConfig): AxiosPromise<RelevantFungibleOwnersResponse>;
/**
* Fetch trending fungibles based on buy activity from watched addresses. Returns fungibles ranked by USD buy volume and buy count within the specified time window.
* @summary Trending fungibles
* @param {OnchainApiFetchTrendingFungiblesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<FetchTrendingFungibles200Response>} A promise that resolves to a `FetchTrendingFungibles200Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-trending-fungibles)
*
*/
fetchTrendingFungibles(requestParameters: OnchainApiFetchTrendingFungiblesRequest, options?: RawAxiosRequestConfig): AxiosPromise<FetchTrendingFungibles200Response>;
/**
* Fetches the token balances of a user given their FID
* @summary Token balance
* @param {OnchainApiFetchUserBalanceRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<BalanceResponse>} A promise that resolves to a `BalanceResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-user-balance)
*
*/
fetchUserBalance(requestParameters: OnchainApiFetchUserBalanceRequest, options?: RawAxiosRequestConfig): AxiosPromise<BalanceResponse>;
/**
* Fetch metadata for a specific token including price, market data, and basic information. Data is fetched from onchain-indexer with fallback to third-party providers.
* @summary Get token metadata
* @param {OnchainApiGetTokenMetadataRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<GetTokenMetadata200Response>} A promise that resolves to a `GetTokenMetadata200Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-token-metadata)
*
*/
getTokenMetadata(requestParameters: OnchainApiGetTokenMetadataRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetTokenMetadata200Response>;
/**
* Fetch all token balances for a wallet address across multiple networks. Results are paginated.
* @summary Get wallet token balances
* @param {OnchainApiGetWalletBalancesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<GetWalletBalances200Response>} A promise that resolves to a `GetWalletBalances200Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-wallet-balances)
*
*/
getWalletBalances(requestParameters: OnchainApiGetWalletBalancesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetWalletBalances200Response>;
/**
* Mints an NFT to one or more recipients on a specified network and contract, using a configured server wallet. Contact us to set up your wallet configuration if you don\'t have one.
* @summary Mint NFT(s)
* @param {OnchainApiMintNftRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<MintNft200Response>} A promise that resolves to a `MintNft200Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/mint-nft)
*
*/
mintNft(requestParameters: OnchainApiMintNftRequest, options?: RawAxiosRequestConfig): AxiosPromise<MintNft200Response>;
/**
* Register a new farcaster account onchain. Optionally you can pass in signers to register a new account and create multiple signers in a single transaction. Requires x-wallet-id header.
* @summary Register Farcaster account onchain
* @param {OnchainApiRegisterAccountOnchainRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<RegisterUserOnChainResponse>} A promise that resolves to a `RegisterUserOnChainResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/register-account-onchain)
*
*/
registerAccountOnchain(requestParameters: OnchainApiRegisterAccountOnchainRequest, options?: RawAxiosRequestConfig): AxiosPromise<RegisterUserOnChainResponse>;
/**
* Send fungibles in bulk to several farcaster users. A funded wallet is to required use this API. React out to us on the Neynar channel on farcaster to get your wallet address.
* @summary Send fungibles
* @param {OnchainApiSendFungiblesToUsersRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<TransactionSendFungiblesResponse>} A promise that resolves to a `TransactionSendFungiblesResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/send-fungibles-to-users)
*
*/
sendFungiblesToUsers(requestParameters: OnchainApiSendFungiblesToUsersRequest, options?: RawAxiosRequestConfig): AxiosPromise<TransactionSendFungiblesResponse>;
/**
* Simulates mint calldata for the given recipients, contract, and network. Useful for previewing calldata and ABI before minting.
* @summary Simulate NFT mint calldata
* @param {OnchainApiSimulateNftMintRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<SimulateNftMintResponse>} A promise that resolves to a `SimulateNftMintResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/simulate-nft-mint)
*
*/
simulateNftMint(requestParameters: OnchainApiSimulateNftMintRequest, options?: RawAxiosRequestConfig): AxiosPromise<SimulateNftMintResponse>;
};
/**
* OnchainApi - interface
* @export
* @interface OnchainApi
*/
export interface OnchainApiInterface {
/**
* Fetch metadata for multiple tokens in a single request. Provide comma-separated networks and addresses in the same order. Maximum 100 tokens per request.
* @summary Batch get token metadata
* @param {OnchainApiBatchGetTokenMetadataRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof OnchainApiInterface
* @returns {Promise<BatchGetTokenMetadata200Response>} A promise that resolves to a `BatchGetTokenMetadata200Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/batch-get-token-metadata)
*
*/
batchGetTokenMetadata(requestParameters: OnchainApiBatchGetTokenMetadataRequest, options?: RawAxiosRequestConfig): AxiosPromise<BatchGetTokenMetadata200Response>;
/**
* Create a signature for a given x402 resource using the specified wallet.
* @summary Create x402 signature
* @param {OnchainApiCreateX402SignatureRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof OnchainApiInterface
* @returns {Promise<CreateX402Signature200Response>} A promise that resolves to a `CreateX402Signature200Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/create-x402-signature)
*
*/
createX402Signature(requestParameters: OnchainApiCreateX402SignatureRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateX402Signature200Response>;
/**
* Deploy a new ERC-721A (series) NFT collection.
* @summary Deploy ERC-721 collection
* @param {OnchainApiDeployErc721Request} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof OnchainApiInterface
* @returns {Promise<DeployErc721201Response>} A promise that resolves to a `DeployErc721201Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/deploy-erc721)
*
*/
deployErc721(requestParameters: OnchainApiDeployErc721Request, options?: RawAxiosRequestConfig): AxiosPromise<DeployErc721201Response>;
/**
* Creates a new token. This is an allowlisted API, reach out if you want access.
* @summary Deploy fungible
* @param {OnchainApiDeployFungibleRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof OnchainApiInterface
* @returns {Promise<DeployFungibleResponse>} A promise that resolves to a `DeployFungibleResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/deploy-fungible)
*
*/
deployFungible(requestParameters: OnchainApiDeployFungibleRequest, options?: RawAxiosRequestConfig): AxiosPromise<DeployFungibleResponse>;
/**
* Get recent trades for a specific fungible within a timeframe. Returns trades ordered by timestamp (most recent first).
* @summary Get fungible trades
* @param {OnchainApiFetchFungibleTradesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof OnchainApiInterface
* @returns {Promise<FetchFungibleTrades200Response>} A promise that resolves to a `FetchFungibleTrades200Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-fungible-trades)
*
*/
fetchFungibleTrades(requestParameters: OnchainApiFetchFungibleTradesRequest, options?: RawAxiosRequestConfig): AxiosPromise<FetchFungibleTrades200Response>;
/**
* Fetch details for fungible assets identified by fungible identifiers.
* @summary Fetch fungibles
* @param {OnchainApiFetchFungiblesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof OnchainApiInterface
* @returns {Promise<FungiblesResponseSchema>} A promise that resolves to a `FungiblesResponseSchema` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-fungibles)
*
*/
fetchFungibles(requestParameters: OnchainApiFetchFungiblesRequest, options?: RawAxiosRequestConfig): AxiosPromise<FungiblesResponseSchema>;
/**
* Fetch a list of relevant owners for a on chain asset. If a viewer is provided, only relevant holders will be shown. This usually shows on a fungible asset page as \"X, Y, Z and N others you know own this asset\".
* @summary Relevant owners
* @param {OnchainApiFetchRelevantFungibleOwnersRequest} requestParameters Request parameters.
* @param {*} [options] Over