@neynar/nodejs-sdk 3.133.0 → 3.134.0

package/build/api/apis/onchain-api.d.ts

@@ -2,7 +2,7 @@
  * 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.133.0
+ * The version of the OpenAPI document: 3.134.0
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -13,6 +13,7 @@ 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';
@@ -21,6 +22,8 @@ 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';
@@ -34,6 +37,19 @@ import type { TransactionSendFungiblesResponse } from '../models';
  * @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
@@ -116,7 +132,7 @@ export declare const OnchainApiAxiosParamCreator: (configuration?: Configuration
     /**
      * 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
+     * @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\&#39;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.
@@ -153,6 +169,34 @@ export declare const OnchainApiAxiosParamCreator: (configuration?: Configuration
      *
      */
     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. \&quot;ethereum\&quot;, \&quot;optimism\&quot;, \&quot;base\&quot;, \&quot;arbitrum\&quot;
+     * @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)
@@ -212,6 +256,19 @@ export declare const OnchainApiAxiosParamCreator: (configuration?: Configuration
  * @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
@@ -294,7 +351,7 @@ export declare const OnchainApiFp: (configuration?: Configuration) => {
     /**
      * 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
+     * @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\&#39;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.
@@ -331,6 +388,34 @@ export declare const OnchainApiFp: (configuration?: Configuration) => {
      *
      */
     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. \&quot;ethereum\&quot;, \&quot;optimism\&quot;, \&quot;base\&quot;, \&quot;arbitrum\&quot;
+     * @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)
@@ -390,6 +475,18 @@ export declare const OnchainApiFp: (configuration?: Configuration) => {
  * @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
@@ -486,6 +583,30 @@ export declare const OnchainApiFactory: (configuration?: Configuration, basePath
      *
      */
     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)
@@ -541,6 +662,19 @@ export declare const OnchainApiFactory: (configuration?: Configuration, basePath
  * @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
@@ -645,6 +779,32 @@ export interface OnchainApiInterface {
      *
      */
     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}
+     * @memberof OnchainApiInterface
+     * @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}
+     * @memberof OnchainApiInterface
+     * @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)
@@ -698,6 +858,31 @@ export interface OnchainApiInterface {
      */
     simulateNftMint(requestParameters: OnchainApiSimulateNftMintRequest, options?: RawAxiosRequestConfig): AxiosPromise<SimulateNftMintResponse>;
 }
+/**
+ * Request parameters for batchGetTokenMetadata operation in OnchainApi.
+ * @export
+ * @interface OnchainApiBatchGetTokenMetadataRequest
+ */
+export interface OnchainApiBatchGetTokenMetadataRequest {
+    /**
+     * Comma-separated list of blockchain networks. Each value must be a valid network (ethereum, optimism, base, arbitrum).
+     *
+     * @commaSeparated
+     *
+     * @type {string}
+     * @memberof OnchainApiBatchGetTokenMetadata
+     */
+    readonly networks: string;
+    /**
+     * Comma-separated list of token contract addresses corresponding to each network
+     *
+     * @commaSeparated
+     *
+     * @type {string}
+     * @memberof OnchainApiBatchGetTokenMetadata
+     */
+    readonly addresses: string;
+}
 /**
  * Request parameters for createX402Signature operation in OnchainApi.
  * @export
@@ -956,7 +1141,7 @@ export interface OnchainApiFetchFungiblesRequest {
  */
 export interface OnchainApiFetchRelevantFungibleOwnersRequest {
     /**
-     * Contract address of the fungible asset
+     * Contract address of the fungible asset (Ethereum or Solana)
      *
      *
      *
@@ -1033,6 +1218,74 @@ export interface OnchainApiFetchUserBalanceRequest {
      */
     readonly networks: Array<FetchUserBalanceNetworksEnum>;
 }
+/**
+ * Request parameters for getTokenMetadata operation in OnchainApi.
+ * @export
+ * @interface OnchainApiGetTokenMetadataRequest
+ */
+export interface OnchainApiGetTokenMetadataRequest {
+    /**
+     * A blockchain network e.g. \&quot;ethereum\&quot;, \&quot;optimism\&quot;, \&quot;base\&quot;, \&quot;arbitrum\&quot;
+     *
+     *
+     *
+     * @type {'ethereum' | 'optimism' | 'base' | 'arbitrum'}
+     * @memberof OnchainApiGetTokenMetadata
+     */
+    readonly network: GetTokenMetadataNetworkEnum;
+    /**
+     * Ethereum address
+     *
+     *
+     *
+     * @type {string}
+     * @memberof OnchainApiGetTokenMetadata
+     */
+    readonly address: string;
+}
+/**
+ * Request parameters for getWalletBalances operation in OnchainApi.
+ * @export
+ * @interface OnchainApiGetWalletBalancesRequest
+ */
+export interface OnchainApiGetWalletBalancesRequest {
+    /**
+     * Comma-separated list of networks to query. Each value must be a valid network (ethereum, optimism, base, arbitrum).
+     *
+     * @commaSeparated
+     *
+     * @type {string}
+     * @memberof OnchainApiGetWalletBalances
+     */
+    readonly networks: string;
+    /**
+     * Ethereum address
+     *
+     *
+     *
+     * @type {string}
+     * @memberof OnchainApiGetWalletBalances
+     */
+    readonly address: string;
+    /**
+     * Number of results to return (max 100) (Default: 50, Maximum: 100)
+     *
+     *
+     *
+     * @type {number}
+     * @memberof OnchainApiGetWalletBalances
+     */
+    readonly limit?: number;
+    /**
+     * Pagination cursor.
+     *
+     *
+     *
+     * @type {string}
+     * @memberof OnchainApiGetWalletBalances
+     */
+    readonly cursor?: string;
+}
 /**
  * Request parameters for mintNft operation in OnchainApi.
  * @export
@@ -1149,6 +1402,19 @@ export interface OnchainApiSimulateNftMintRequest {
  * @extends {BaseAPI}
  */
 export declare class OnchainApi extends BaseAPI implements 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 OnchainApi
+     * @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): Promise<import("axios").AxiosResponse<BatchGetTokenMetadata200Response, any, {}>>;
     /**
      * Create a signature for a given x402 resource using the specified wallet.
      * @summary Create x402 signature
@@ -1253,6 +1519,32 @@ export declare class OnchainApi extends BaseAPI implements OnchainApiInterface {
      *
      */
     fetchUserBalance(requestParameters: OnchainApiFetchUserBalanceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BalanceResponse, any, {}>>;
+    /**
+     * 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}
+     * @memberof OnchainApi
+     * @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): Promise<import("axios").AxiosResponse<GetTokenMetadata200Response, any, {}>>;
+    /**
+     * 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}
+     * @memberof OnchainApi
+     * @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): Promise<import("axios").AxiosResponse<GetWalletBalances200Response, any, {}>>;
     /**
      * 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)
@@ -1386,6 +1678,16 @@ export declare const FetchUserBalanceNetworksEnum: {
     readonly Arbitrum: "arbitrum";
 };
 export type FetchUserBalanceNetworksEnum = typeof FetchUserBalanceNetworksEnum[keyof typeof FetchUserBalanceNetworksEnum];
+/**
+ * @export
+ */
+export declare const GetTokenMetadataNetworkEnum: {
+    readonly Ethereum: "ethereum";
+    readonly Optimism: "optimism";
+    readonly Base: "base";
+    readonly Arbitrum: "arbitrum";
+};
+export type GetTokenMetadataNetworkEnum = typeof GetTokenMetadataNetworkEnum[keyof typeof GetTokenMetadataNetworkEnum];
 /**
  * @export
  */