add getNFTsByAccount (#1148)

* add getNFTsByAccount

* improve chain param

* add chain doc

Author: ryanio

src/api/api.ts

@@ -39,6 +39,7 @@ import {
   getNFTPath,
   getRefreshMetadataPath,
   getCollectionOffersPath,
+  getListNFTsByAccountPath,
 } from "../orders/utils";
 import {
   Chain,
@@ -416,6 +417,40 @@ export class OpenSeaAPI {
     return response;
   }
 
+  /**
+   * Fetch NFTs owned by an account.
+   * @param address The address of the account
+   * @param limit The number of NFTs to retrieve. Must be greater than 0 and less than 51.
+   * @param next Cursor to retrieve the next page of NFTs
+   * @param retries Number of times to retry if the service is unavailable for any reason.
+   * @param chain The chain to query. Defaults to the chain set in the constructor.
+   * @returns The {@link ListNFTsResponse} returned by the API.
+   */
+  public async getNFTsByAccount(
+    address: string,
+    limit: number | undefined = undefined,
+    next: string | undefined = undefined,
+    retries = 1,
+    chain = this.chain,
+  ): Promise<ListNFTsResponse> {
+    let response;
+    try {
+      response = await this.get<ListNFTsResponse>(
+        getListNFTsByAccountPath(chain, address),
+        {
+          limit,
+          next,
+        },
+      );
+    } catch (error) {
+      _throwOrContinue(error, retries);
+      await delay(1000);
+      return this.getNFTsByAccount(address, limit, next, retries - 1, chain);
+    }
+
+    return response;
+  }
+
   /**
    * Fetch metadata, traits, ownership information, and rarity for a single NFT.
    * @param chain The NFT's chain.

src/orders/utils.ts

@@ -47,6 +47,10 @@ export const getListNFTsByContractPath = (chain: Chain, address: string) => {
   return `/v2/chain/${chain}/contract/${address}/nfts`;
 };
 
+export const getListNFTsByAccountPath = (chain: Chain, address: string) => {
+  return `/v2/chain/${chain}/account/${address}/nfts`;
+};
+
 export const getNFTPath = (
   chain: Chain,
   address: string,

test/integration/getNFTs.spec.ts

@@ -38,6 +38,14 @@ suite("SDK: NFTs", () => {
     assert(response.next, "Response should have a next cursor");
   });
 
+  test("Get NFTs By Account", async () => {
+    const address = "0xfBa662e1a8e91a350702cF3b87D0C2d2Fb4BA57F";
+    const response = await sdk.api.getNFTsByAccount(address);
+    assert(response, "Response should exist.");
+    assert.equal(response.nfts.length, 50, "Response should include 50 NFTs");
+    assert(response.next, "Response should have a next cursor");
+  });
+
   test("Get NFT", async () => {
     const tokenAddress = "0x4768cbf202f365fbf704b9b9d397551a0443909b"; // Roo Troop
     const identifier = "2";