TradePort

https://www.tradeport.xyz/docs
Admin
TradePort offers NFT data APIs and a trading SDK for developers to integrate NFT data, trading, and...
Tokens:18,443
Snippets:70
Trust Score:8.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### Tradeport Aptos Trading SDK - Getting Started

Source: https://www.tradeport.xyz/docs/nft-trading-sdk/aptos-sdk/changelog

Provides instructions on how to get started with the Aptos NFT Trading SDK. This section covers initial setup and basic usage for interacting with NFTs on the Aptos blockchain.

```markdown
# @tradeport/aptos-trading-sdk
## 0.0.1
Introducing the Aptos NFT Trading SDK
Last updated on August 19, 2025
Getting Started
```

--------------------------------

### Install Sui NFT Trading SDK

Source: https://www.tradeport.xyz/docs/nft-trading-sdk/sui-sdk/getting-started

Installs the Sui NFT Trading SDK using npm or yarn. This is the first step to integrating NFT trading functionality into your application.

```npm
npm i @tradeport/sui-trading-sdk
```

```yarn
yarn add @tradeport/sui-trading-sdk
```

--------------------------------

### Install Aptos NFT Trading SDK

Source: https://www.tradeport.xyz/docs/nft-trading-sdk/aptos-sdk/getting-started

Installs the Aptos NFT Trading SDK using npm. This is the first step to integrating NFT trading functionality into your application.

```bash
npm i @tradeport/aptos-trading-sdk
```

--------------------------------

### NFT Data API - Code Snippet Usage

Source: https://www.tradeport.xyz/docs/nft-data-api/reference

Get started quickly with the NFT Data API by using code snippets found in the UI components on TradePort.xyz. These snippets show the exact queries used for UI components and can be copied or run directly in the API Explorer. Look for the code snippet toggle on the upper right corner of any UI component.

```APIDOC
Code Snippet Examples:
  - Copy code snippets from TradePort.xyz UI components.
  - Snippets display exact queries used for UI components.
  - Can be copied or run directly in the API Explorer.
  - Find snippets via the toggle on the upper right corner of UI components.
```

--------------------------------

### Fetch NFT Listings

Source: https://www.tradeport.xyz/docs/nft-data-api/examples/nfts

Retrieves the current listings for a specific NFT, including listing status, price, marketplace, and seller information.

```GraphQL
query fetchNftListings($collectionId:uuid!,$tokenId:String!) {
  sui{
    nfts(
      where: {
        collection_id: { _eq:$collectionId }
        token_id: { _eq:$tokenId }
      }
    ) {
      name
      token_id
      listings(where: { listed: { _eq:true } },order_by: { price: asc }) {
        id
        listed
        price
        market_name
        seller
        block_time
      }
    }
  }
}
```

--------------------------------

### Sui SDK: Buy Listings Example

Source: https://www.tradeport.xyz/docs/nft-trading-sdk/sui-sdk/calling-methods

Demonstrates how to use the `buyListings` method from the Sui SDK to purchase NFT listings. It shows the integration with wallet signing methods provided by `@mysten/dapp-kit` and highlights the necessary inputs like listing IDs and wallet addresses.

```TypeScript
import {useSignAndExecuteTransaction} from '@mysten/dapp-kit'
const{mutate:signAndExecuteTransaction}=useSignAndExecuteTransaction()
consttransaction=awaitsuiTradingClient.buyListings({
  listingIds: [listing.id],
  walletAddress:'0x...'
})
awaitsignAndExecuteTransaction({transaction})
```

--------------------------------

### Querying Collections across Supported Chains

Source: https://www.tradeport.xyz/docs/nft-data-api/overview

Provides an example GraphQL query to fetch collection data, demonstrating how to specify the desired blockchain chain (e.g., Sui) at the root level of the query.

```APIDOC
query fetchCollectionInfo{
  sui{
    collections{
      id
      slug
      title
      cover_url
      supply
      description
      floor
      volume
    }
  }
}
```

--------------------------------

### Fetch NFT Info

Source: https://www.tradeport.xyz/docs/nft-data-api/examples/nfts

Retrieves detailed information about a specific NFT, including its name, token ID, media details, owner, and chain state.

```GraphQL
query fetchNftInfo($collectionId:uuid!,$tokenId:String!) {
  sui{
    nfts(
      where: {
        collection_id: { _eq:$collectionId }
        token_id: { _eq:$tokenId }
      }
    ) {
      name
      token_id
      media_type
      media_url
      ranking
      collection_id
      version
      owner
      burned
      chain_state
      properties
      staked
      staked_owner
    }
  }
}
```

--------------------------------

### Fetch Collection Info using graphql-request

Source: https://www.tradeport.xyz/docs/nft-data-api/overview

Shows how to fetch NFT collection information using graphql-request and graphql-tag libraries in JavaScript. Includes setup for the GraphQL client and making the request.

```javascript
import {GraphQLClient} from "graphql-request"
import gql from "graphql-tag"
const query=gql`
  query fetchCollectionInfo($collectionId: uuid!) {
    sui {
      collections(where: { id: { _eq: $collectionId } }) {
        slug
        title
        cover_url
        supply
        verified
      }
    }
  }
  `
const variables={
  collectionId:"4827d37b-5574-404f-b030-d26912ad7461"
}
const client=new GraphQLClient("https://api.indexer.xyz/graphql",{
  headers:{
"x-api-key":YOUR_API_KEY,
"x-api-user":YOUR_API_USER
}
})
await client.request(query,variables)
```

--------------------------------

### Fetch NFT Attributes

Source: https://www.tradeport.xyz/docs/nft-data-api/examples/nfts

Retrieves the attributes of a specific NFT, including their type, value, and rarity.

```GraphQL
query fetchNftAttributes($collectionId:uuid!,$tokenId:String!) {
  sui{
    nfts(
      where: {
        collection_id: { _eq:$collectionId }
        token_id: { _eq:$tokenId }
      }
    ) {
      attributes{
        type
        value
        rarity
      }
    }
  }
}
```

--------------------------------

### Fetch NFT Bids

Source: https://www.tradeport.xyz/docs/nft-data-api/examples/nfts

Retrieves active bids for a specific NFT, including bid details, bidder, and the marketplace contract name.

```GraphQL
query fetchNftBids($collectionId:uuid!,$tokenId:String!) {
  sui{
    nfts(
      where: {
        collection_id: { _eq:$collectionId }
        token_id: { _eq:$tokenId }
      }
    ) {
      bids(
        where: { status: { _eq:"active" } }
        order_by: { price: desc }
      ) {
        id
        price
        created_tx_id
        bidder
        receiver
        remaining_count
        status
        market_contract{
          name
        }
      }
    }
  }
}
```

--------------------------------

### Search Collections

Source: https://www.tradeport.xyz/docs/nft-data-api/examples/collections

Enables searching for NFT collections based on a text query. The search can be paginated and returns basic collection details such as ID, supply, floor price, slug, title, and volume.

```APIDOC
querycollectionSearch($text:String,$offset:Int,$limit:Int) {
  sui {
    collections_search(
      args: { text:$text }
      offset:$offset
      limit:$limit
    ) {
      id
      supply
      floor
      slug
      semantic_slug
      title
      usd_volume
      volume
      cover_url
      verified
    }
  }
}
```

--------------------------------

### Fetch Collection Info

Source: https://www.tradeport.xyz/docs/nft-data-api/examples/collections

Retrieves detailed information about a specific NFT collection using its slug or semantic slug. It supports querying by either identifier and highlights the use of the `_or` operator for flexibility. The response includes data like title, description, floor price, volume, supply, and social links.

```APIDOC
queryfetchCollectionInfo($slug:String) {
  sui {
    collections(
      where: {
        _or: [{ semantic_slug: { _eq:$slug } }, { slug: { _eq:$slug } }]
      }
    ) {
      id
      title
      slug
      semantic_slug
      description
      floor
      volume
      usd_volume
      cover_url
      supply
      verified
      discord
      twitter
      website
    }
  }
}
```

--------------------------------

### Fetch Collection Items

Source: https://www.tradeport.xyz/docs/nft-data-api/examples/collections

Retrieves a paginated list of NFTs belonging to a specific collection. It allows filtering by various criteria using the `where` argument and sorting using `order_by`. The query supports pagination with `offset` and `limit` parameters.

```APIDOC
queryfetchCollectionItems(
  $where:nfts_bool_exp!
  $order_by: [nfts_order_by!]
  $offset:Int
  $limit:Int!
) {
  sui {
    nfts(where:$where,order_by:$order_by,offset:$offset,limit:$limit) {
      id
      token_id
      name
      media_url
      media_type
      ranking
      owner
    }
  }
}
```

--------------------------------

### Fetch Collection Activity

Source: https://www.tradeport.xyz/docs/nft-data-api/examples/collections

Retrieves recent on-chain activities related to NFTs, such as sales and mints. The query allows filtering by various criteria and supports pagination. It returns details about the action, price, involved parties, and associated NFT information.

```APIDOC
queryfetchCollectionActivity(
  $where:recent_actions_bool_exp
  $offset:Int
  $limit:Int!
) {
  sui {
    recent_actions(
      where:$where
      order_by: [{ block_time: desc }, { tx_index: desc }]
      offset:$offset
      limit:$limit
    ) {
      id
      type
      price
      usd_price
      sender
      receiver
      tx_id
      block_time
      market_name
      bought_on_tradeport
      nft {
        id
        name
        media_url
        media_type
        ranking
      }
    }
  }
}
```

--------------------------------

### Fetch NFT Transaction History

Source: https://www.tradeport.xyz/docs/nft-data-api/examples/nfts

Retrieves the transaction history for a specific NFT, filtering by action types, offset, and limit. Includes details like transaction ID, type, price, and timestamps.

```GraphQL
query fetchNftTransactionHistory(
  $collectionId:uuid!
  $tokenId:String!
  $actionTypes: [action_type!]
  $offset:Int
  $limit:Int!
) {
  sui{
    actions(
      where: {
        collection_id: { _eq:$collectionId }
        nft: { token_id: { _eq:$tokenId } }
        type: { _in:$actionTypes }
      }
      order_by: [{ block_time: desc }, { tx_index: desc }]
      offset:$offset
      limit:$limit
    ) {
      id
      type
      price
      sender
      receiver
      tx_id
      block_time
      market_name
    }
  }
}
```

--------------------------------

### Fetch Trending Collections

Source: https://www.tradeport.xyz/docs/nft-data-api/examples/collections

Retrieves a list of trending NFT collections based on specified periods and metrics. The query allows pagination and returns collection identifiers, trading counts, volume data, and core collection details.

```APIDOC
queryfetchTrendingCollections(
  $period:TrendingPeriod!
  $trending_by:TrendingBy!
  $offset:Int=0
  $limit:Int!
) {
  sui {
    collections_trending(
      period:$period
      trending_by:$trending_by
      offset:$offset
      limit:$limit
    ) {
      collection_id
      current_trades_count
      current_usd_volume
      current_volume
      previous_trades_count
      previous_usd_volume
      previous_volume
      collection {
        id
        slug
        semantic_slug
        title
        supply
        cover_url
        floor
        usd_volume
        volume
        verified
      }
    }
  }
}
```

--------------------------------

### Fetch Collection Bids

Source: https://www.tradeport.xyz/docs/nft-data-api/examples/collections

Fetches active bids for NFTs within a collection. The query uses a `where` argument to filter bids and `order_by` for sorting. It returns bid details such as bidder, price, and remaining count.

```APIDOC
queryfetchCollectionBids($where:bids_bool_exp!,$order_by: [bids_order_by!]) {
  sui {
    bids(where:$where,order_by:$order_by) {
      id
      nonce
      bidder
      price
      remaining_count
    }
  }
}
```

--------------------------------

### Fetch Collection Holders

Source: https://www.tradeport.xyz/docs/nft-data-api/examples/collections

Retrieves information about the holders of an NFT collection, identified by its slug. It allows sorting holders based on trending metrics and supports pagination. The output includes holder addresses and their holding statistics.

```APIDOC
queryfetchCollectionHolders(
  $slug:String!
  $trending_by:HoldersBy!
  $offset:Int=0
  $limit:Int!
) {
  sui {
    collection_holders(
      slug:$slug
      trending_by:$trending_by
      offset:$offset
      limit:$limit
    ) {
      collection_id
      current_holdings
      owner
      minted
      sold
      sold_volume
      total_holding_time
      total_holdings
    }
  }
}
```

--------------------------------

### Fetch Collection Stats

Source: https://www.tradeport.xyz/docs/nft-data-api/examples/collections

Fetches statistical data for a given NFT collection, identified by its slug. This includes total mint volume, total sales, daily volume, and daily sales in both native currency and USD. The query requires a non-nullable slug parameter.

```APIDOC
queryfetchCollectionStats($slug:String!) {
  sui {
    collection_stats(slug:$slug) {
      total_mint_volume
      total_mint_usd_volume
      total_mints
      total_sales
      total_usd_volume
      total_volume
      day_volume
      day_sales
      day_usd_volume
    }
  }
}
```

--------------------------------

### Initialize Sui Trading Client

Source: https://www.tradeport.xyz/docs/nft-trading-sdk/sui-sdk/getting-started

Initializes the SuiTradingClient by providing your API Key and API User. These credentials are used by the SDK to fetch necessary data from the NFT Data API for transaction creation.

```typescript
import {SuiTradingClient} from "@tradeport/sui-trading-sdk"

const suiTradingClient = new SuiTradingClient({
  apiKey: YOUR_API_KEY,
  apiUser: YOUR_API_USER
})
```

--------------------------------

### Initialize Aptos Trading Client

Source: https://www.tradeport.xyz/docs/nft-trading-sdk/aptos-sdk/getting-started

Initializes the Aptos trading client by providing your API Key and API User. These credentials are used by the SDK to fetch data from the NFT Data API for transaction payload creation.

```typescript
import {aptosTradingClient} from "@tradeport/aptos-trading-sdk"
const aptosTradingClient = new aptosTradingClient({
  apiKey: YOUR_API_KEY,
  apiUser: YOUR_API_USER
})
```

--------------------------------

### Sui NFT Trading SDK Overview

Source: https://www.tradeport.xyz/docs/nft-trading-sdk/sui-sdk/changelog

Introduction to the Sui NFT Trading SDK, detailing its purpose and capabilities for interacting with NFTs on the Sui blockchain.

```APIDOC
SDK Name: @tradeport/sui-trading-sdk
Version: 0.0.1
Description: Introducing the Sui NFT Trading SDK
Last Updated: August 19, 2025
```

--------------------------------

### Aptos SDK: Call Buy Listings Method

Source: https://www.tradeport.xyz/docs/nft-trading-sdk/aptos-sdk/calling-methods

Demonstrates how to call the `buyListings` method from the Aptos NFT Trading SDK and sign the resulting transaction payload using a wallet adapter.

```TypeScript
import {useWallet} from '@aptos-labs/wallet-adapter-react'
const{signAndSendTransaction}=useWallet()
constpayload=awaitaptosTradingClient.buyListings({
	listingIds: ["5381c4a4-5c42-424e-a10e-80d24fc411c2"]
})
awaitsignAndSendTransaction(payload)
```

--------------------------------

### Fetch Collection Attributes

Source: https://www.tradeport.xyz/docs/nft-data-api/examples/collections

Retrieves the attributes (traits) associated with a collection and their rarity. This query requires the collection's ID and returns attributes categorized by type and value.

```APIDOC
queryfetchCollectionAttributes($collectionId:uuid!) {
  sui {
    collection_attributes(
      where: { collection_id: { _eq:$collectionId } }
    ) {
      id
      type:trait_type
      value
      rarity
    }
  }
}
```

--------------------------------

### Buy Listings

Source: https://www.tradeport.xyz/docs/nft-trading-sdk/aptos-sdk/reference

Buys one or multiple NFTs from listings. Accepts an array of listing IDs as input.

```javascript
constpayload=awaitaptosTradingClient.buyListings({
	listingIds: [listing1.id,listing2.id]
})
awaitsignAndSendTransaction(payload)
```

--------------------------------

### Buy NFT Listings

Source: https://www.tradeport.xyz/docs/nft-trading-sdk/sui-sdk/reference

Allows users to buy/sweep one or multiple NFT listings from any marketplace. Requires listing IDs and the user's wallet address.

```typescript
const transaction = await suiTradingClient.buyListings({
  listingIds: [listing1.id, listing2.id],
  walletAddress: connectedWalletId
});
await signAndSendTransaction({ transaction });
```

--------------------------------

### TradePort Dev Tools Overview

Source: https://www.tradeport.xyz/docs/index

TradePort offers two primary tools for developers: the NFT Data API for fetching comprehensive NFT data via GraphQL, and the NFT Trading SDK, a TypeScript library simplifying NFT trading operations like buying, selling, and transferring.

```English
NFT Data API: GraphQL API for fetching NFT metadata, ownership, trading history, listings, etc.
NFT Trading SDK: TypeScript library for integrating NFT trading (buy, sweep, list, bid, sell, transfer) with simplified transaction payload creation.
```

--------------------------------

### List NFTs for Sale

Source: https://www.tradeport.xyz/docs/nft-trading-sdk/aptos-sdk/reference

Lists one or multiple NFTs for sale. If an NFT is already listed, this action will relist it. Requires NFT IDs and their list prices.

```javascript
constpayload=awaitaptosTradingClient.listNfts({
  nfts: [
{
      id:nft.id,
      listPriceInOctas:1000000000
}
  ],
})
awaitsignAndSendTransaction(payload)
```

--------------------------------

### Place NFT Bid

Source: https://www.tradeport.xyz/docs/nft-trading-sdk/aptos-sdk/reference

Places a bid on an individual NFT. Requires the NFT ID and the bid amount.

```javascript
constpayload=awaitaptosTradingClient.placeNftBid({
  nftId:nft.id,
  bidAmountInOctas:500000000
})
awaitsignAndSendTransaction(payload)
```

--------------------------------

### List NFTs for Sale

Source: https://www.tradeport.xyz/docs/nft-trading-sdk/sui-sdk/reference

Enables users to list NFTs for sale. If an NFT is already listed, this action will relist it. Requires NFT IDs and the desired listing price in Sui.

```typescript
const tx = await suiTradingClient.listNfts({
  nfts: [
    {
      id: nft.id,
      listPriceInMist: 50000000000
    },
  ],
  walletAddress: connectedWalletId
});
await signAndSendTransaction({ transaction });
```

--------------------------------

### Accept Collection Bid (Instant Sell)

Source: https://www.tradeport.xyz/docs/nft-trading-sdk/sui-sdk/reference

Facilitates the acceptance of a collection bid, effectively performing an instant sell. Requires the bid ID and the ID of the NFT being used to fulfill the bid.

```typescript
const transaction = await suiTradingClient.acceptCollectionBid({
  bidId: bid.id,
  nftId: nft.id,
  walletAddress: connectedWalletId
});
await signAndSendTransaction({ transaction });
```

--------------------------------

### Fetch Collection Floor History

Source: https://www.tradeport.xyz/docs/nft-data-api/examples/collections

Retrieves the historical floor price data for an NFT collection over a specified period. The query requires the collection's slug and the desired time period, returning timestamps and corresponding USD values.

```APIDOC
queryfetchCollectionFloorHistory(
  $slug:String!
  $period:CollectionFloorPeriod!
  $offset:Int!
  $limit:Int!
) {
  sui {
    collection_floors(
      slug:$slug
      period:$period
      offset:$offset
      limit:$limit
    ) {
      time
      usd_value
      value
    }
  }
}
```

--------------------------------

### Place Collection Bid

Source: https://www.tradeport.xyz/docs/nft-trading-sdk/aptos-sdk/reference

Places a bid on an entire NFT collection. Allows specifying the bid amount and the number of bids to create.

```javascript
constpayload=awaitaptosTradingClient.placeCollectionBid({
  collectionId:collection.id,
  bidAmountInOctas:14600000000,
  numOfBids:1
})
awaitsignAndSendTransaction(payload)
```

--------------------------------

### Accept Collection Bid

Source: https://www.tradeport.xyz/docs/nft-trading-sdk/aptos-sdk/reference

Accepts a bid on an NFT collection, effectively performing an instant sell for a specific NFT within that collection. Requires the collection bid ID and the NFT ID being sold.

```javascript
constpayload=awaitaptosTradingClient.acceptCollectionBid({
	bidId:bid.id,
	nftId:nft.id
})
awaitsignAndSendTransaction(payload)
```

--------------------------------

### Fetch Collection Info using Axios

Source: https://www.tradeport.xyz/docs/nft-data-api/overview

Demonstrates how to fetch NFT collection information from the NFT Data API using the axios library in JavaScript. Includes query, variables, and request configuration.

```javascript
import axios from "axios"
const query=`
  query fetchCollectionInfo($collectionId: uuid!) {
    sui {
      collections(where: { id: { _eq: $collectionId } }) {
        slug
        title
        cover_url
        supply
        verified
      }
    }
  }
`
const variables={
  collectionId:"4827d37b-5574-404f-b030-d26912ad7461"
}
const res=await axios({
  url:"https://api.indexer.xyz/graphql",
  method:'post',
  data:{
query,
variables
},
  headers:{
"x-api-key":YOUR_API_KEY,
"x-api-user":YOUR_API_USER
}
})
```

--------------------------------

### NFT Data API - GraphQL Schema Exploration

Source: https://www.tradeport.xyz/docs/nft-data-api/reference

Explore the GraphQL schema and make queries directly in the API Explorer. This tool allows users to build queries without prior GraphQL experience. Note that the API Explorer is rate-limited with demo API keys, affecting performance and response size. Production use requires a dedicated API key.

```APIDOC
API Explorer:
  - Explore GraphQL schema and make queries.
  - No prior GraphQL experience required.
  - Rate-limited with demo API keys (performance/response size limitations).
  - For production, obtain an API key and pass it in 'Request Headers'.
```

--------------------------------

### Accept Bids on Individual NFTs

Source: https://www.tradeport.xyz/docs/nft-trading-sdk/sui-sdk/reference

Allows users to accept bids placed on their individual NFTs. Requires the UUIDs of the bids to be accepted and the user's wallet address.

```typescript
const transaction = await suiTradingClient.acceptNftBids({ bidIds: [bid.id], walletAddress: connectedWalletId });
await signAndSendTransaction({ transaction });
```

--------------------------------

### Fetch Wallet Bids

Source: https://www.tradeport.xyz/docs/nft-data-api/examples/wallets

Fetches a list of bids made by a specific wallet, including bid details, associated NFT information, and marketplace contract information.

```APIDOC
queryfetchWalletBids(
$where:bids_bool_exp!
$order_by: [bids_order_by!]
$offset:Int
$limit:Int!
) {
aptos{
bids(where:$where,order_by:$order_by,offset:$offset,limit:$limit) {
id
bidder
price
price_str
type
nonce
status
nft{
id
token_id
name
media_url
media_type
ranking
}
collection{
id
title
slug
}
market_contract{
key
name
}
}
}
}
```

--------------------------------

### Place Bid on a Collection

Source: https://www.tradeport.xyz/docs/nft-trading-sdk/sui-sdk/reference

Enables users to place a bid on an entire NFT collection. Users specify the collection ID, bid amount, and the number of bids to create.

```typescript
const transaction = await suiTradingClient.placeCollectionBid({
  collectionId: collection.id,
  bidAmountInMist: 10000000000,
  numOfBids: 2,
  walletAddress: connectedWalletId
});
await signAndSendTransaction({ transaction });
```

--------------------------------

### Accept NFT Bid

Source: https://www.tradeport.xyz/docs/nft-trading-sdk/aptos-sdk/reference

Accepts a bid that was placed on an individual NFT. Requires the bid ID.

```javascript
constpayload=awaitaptosTradingClient.acceptNftBid({ bidId:bid.id})
awaitsignAndSendTransaction(payload)
```

--------------------------------

### Fetch Wallet Collections

Source: https://www.tradeport.xyz/docs/nft-data-api/examples/wallets

Fetches information about NFT collections associated with a wallet, including collection ID, slug, title, cover image URL, and floor price.

```APIDOC
queryfetchWalletCollections(
$where:collections_bool_exp!
$order_by: [collections_order_by!]
) {
aptos{
collections(where:$where,order_by:$order_by) {
id
slug
title
cover_url
floor
}
}
}
```

--------------------------------

### Place Bids on Individual NFTs

Source: https://www.tradeport.xyz/docs/nft-trading-sdk/sui-sdk/reference

Allows users to place bids on one or multiple individual NFTs. Requires NFT IDs and the bid amount in Sui.

```typescript
const transaction = await suiTradingClient.placeNftBids({
  nfts: [
    {
      id: nft.id,
      bidAmountInMist: 10000000000
    }
  ],
  walletAddress: connectedWalletId
});
await signAndSendTransaction({ transaction });
```

--------------------------------

### Claim Accepted Bid NFT

Source: https://www.tradeport.xyz/docs/nft-trading-sdk/aptos-sdk/reference

Claims an NFT that has been transferred to the user as a result of an accepted collection bid. Requires the NFT ID and checks for specific claimable conditions.

```javascript
constpayload=awaitclaimAcceptedBidNft({ nftId:nft.id})
awaitsignAndSendTransaction(payload)
```

--------------------------------

### Transfer NFTs

Source: https://www.tradeport.xyz/docs/nft-trading-sdk/aptos-sdk/reference

Transfers one or multiple NFTs to a specified recipient wallet address. Requires an array of NFT IDs and the recipient's wallet address.

```javascript
constpayload=awaitaptosTradingClient.transferNfts({
  nftIds: [nft1.id,nft2.id],
  recipientId:recipientWalletAddress,
})
awaitsignAndSendTransaction(payload)
```

--------------------------------

### Fetch Wallet Portfolio Values

Source: https://www.tradeport.xyz/docs/nft-data-api/examples/wallets

Fetches the historical value of a wallet's portfolio over a specified period, providing time-series data for the total value and USD value.

```APIDOC
queryfetchWalletPortfolioValues($wallet:String!,$period:WalletHistory!) {
aptos{
wallet_values(address:$wallet,history:$period) {
time
usd_value
value
}
}
}
```

--------------------------------

### Fetch Wallet Realized P&L

Source: https://www.tradeport.xyz/docs/nft-data-api/examples/wallets

Calculates and retrieves the realized profit and loss for a wallet by analyzing past trades. It includes details of acquired and released NFTs and their associated prices, along with crypto-to-USD rates.

```APIDOC
queryfetchWalletRealizedPnL($wallet:String!) {
aptos{
wallet_trades(address:$wallet) {
acquired_at
acquired_action_type
acquired_price
acquired_usd_price
released_at
released_action_type
released_price
released_usd_price
collection{
id
slug
title
supply
}
nft{
id
token_id
name
media_url
media_type
ranking
}
}
crypto_rates(
where: { crypto: { _eq:"aptos" }, fiat: { _eq:"USD" } }
    ) {
rate
}
}
}
```

--------------------------------

### Fetch Wallet Ownership

Source: https://www.tradeport.xyz/docs/nft-data-api/examples/wallets

Retrieves a list of NFTs owned by a specific wallet, including details like token ID, name, media URL, ranking, and ownership status. It also includes collection information and listing status.

```APIDOC
queryfetchWalletOwnership(
$where:nfts_bool_exp
$order_by: [nfts_order_by!]
$offset:Int
$limit:Int!
) {
aptos{
nfts(where:$where,order_by:$order_by,offset:$offset,limit:$limit) {
id
token_id
name
media_url
media_type
ranking
owner
delegated_owner
burned
staked
version
collection{
id
title
}
listings(where: { listed: { _eq:true } },order_by: { price: asc }) {
id
price
}
}
}
}
```

--------------------------------

### Fetch Wallet Unrealized P&L

Source: https://www.tradeport.xyz/docs/nft-data-api/examples/wallets

Retrieves the unrealized profit and loss for a wallet by examining current holdings. It includes details of acquired NFTs, their purchase prices, and current collection floor prices, along with crypto-to-USD rates.

```APIDOC
queryfetchWalletUnrealizedPnL($wallet:String!) {
aptos{
wallet_holdings(address:$wallet) {
acquired_at
acquired_action_type
acquired_price
acquired_usd_price
collection{
id
slug
title
supply
floor
}
nft{
id
token_id
name
media_url
media_type
ranking
}
}
crypto_rates(
where: { crypto: { _eq:"aptos" }, fiat: { _eq:"USD" } }
    ) {
rate
}
}
}
```

--------------------------------

### Sui NFT Metadata - Basic Fields

Source: https://www.tradeport.xyz/docs/sui-nft-standards/metadata-requirements

Defines the essential fields required for a Sui NFT to be displayed on TradePort. This includes the NFT's name, a URL for its media, and a description.

```APIDOC
NFT Object Fields:
  - name: The name of the individual NFT.
  - image_url: The URL (preferably IPFS URI) pointing to the NFT's media file. Supports standard image and video formats.
  - description: The description of the collection.
```

--------------------------------

### Unlist a Listing

Source: https://www.tradeport.xyz/docs/nft-trading-sdk/aptos-sdk/reference

Removes a previously created listing for an NFT. Requires the listing ID.

```javascript
constpayload=awaitaptosTradingClient.unlistListing({
	listingId:listing.id
})
awaitsignAndSendTransaction(payload)
```

--------------------------------

### TradePort NFT Data API - GraphQL Request Structure

Source: https://www.tradeport.xyz/docs/nft-data-api/making-requests

The TradePort NFT Data API is a GraphQL API. This section outlines the fundamental components for constructing requests, including queries, subscriptions, filtering, sorting, distinct operations, and pagination.

```APIDOC
GraphQL API Overview:
  - The TradePort NFT Data API uses GraphQL for efficient data querying.
  - API is consistent across all supported chains.

Request Components:
  - Queries:
    - Construct queries following Hasura's Query documentation.
    - Purpose: Retrieve specific data.
    - Reference: Hasura Query docs (opens in a new tab).
  - Subscriptions:
    - Enable real-time data updates.
    - Reference: Hasura Subscriptions docs (opens in a new tab).
  - Filtering:
    - Use the `where` argument to filter results.
    - Reference: Full Reference (opens in a new tab).
  - Sorting:
    - Use the `order_by` argument to sort results.
    - Reference: Full Reference (opens in a new tab).
  - Distinct Results:
    - Use the `distinct_on` argument to fetch unique results.
    - Reference: Full Reference (opens in a new tab).
  - Pagination:
    - Use `offset` and `limit` arguments for pagination.
    - Reference: Full Reference (opens in a new tab).
```

--------------------------------

### Sui NFT Standards

Source: https://www.tradeport.xyz/docs/nft-trading-sdk/sui-sdk/changelog

Details on Sui NFT standards, including collection contract structure and metadata requirements for NFTs on the Sui blockchain.

```APIDOC
Sui NFT Standards:
- Collection Contract Structure
- Metadata Requirements
```

--------------------------------

### Fetch Wallet Activity

Source: https://www.tradeport.xyz/docs/nft-data-api/examples/wallets

Retrieves a history of actions (transactions) performed by a wallet, including transaction type, price, sender, receiver, block time, and associated NFT and collection details.

```APIDOC
queryfetchWalletActivity(
$where:actions_bool_exp
$offset:Int
$limit:Int!
) {
aptos{
actions(
where:$where
order_by: [{ block_time: desc }, { tx_index: desc }]
offset:$offset
limit:$limit
    ) {
id
type
price
usd_price
sender
receiver
tx_id
block_time
market_name
collection{
id
slug
title
cover_url
}
nft{
id
token_id
name
media_url
media_type
ranking
}
}
}
}
```

--------------------------------

### Fetch Wallet Stats

Source: https://www.tradeport.xyz/docs/nft-data-api/examples/wallets

Retrieves comprehensive statistics for a given wallet address, including counts of listed and unlisted holdings, total value, trading volume (bought and sold), and realized/unrealized profit and loss.

```APIDOC
queryfetchWalletStats($wallet:String!) {
aptos{
wallet_stats(address:$wallet) {
holdings_listed_count
holdings_count
value
usd_value
bought_volume
bought_usd_volume
sold_volume
sold_usd_volume
realized_profit_loss
realized_usd_profit_loss
unrealized_profit_loss
unrealized_usd_profit_loss
}
}
}
```

--------------------------------

### NFT Data API Request Headers

Source: https://www.tradeport.xyz/docs/nft-data-api/overview

Specifies the required headers for making authenticated requests to the NFT Data API's GraphQL endpoint.

```APIDOC
POST https://api.indexer.xyz/graphql

Headers:
  "x-api-key": YOUR_API_KEY,
  "x-api-user": YOUR_API_USER
```

--------------------------------

### Claim NFTs

Source: https://www.tradeport.xyz/docs/nft-trading-sdk/sui-sdk/reference

Claims one or multiple NFTs that are marked as claimable. NFTs are claimable if they are under a 'Trade Hold', inside a kiosk transferred to the user, or received from an accepted collection bid. The function requires NFT IDs and the wallet address.

```javascript
const payload = await uiTradingClient.claimNfts({
  nftIds: [nft1.id, nft2.id],
  walletAddress: connectedWalletId
});
await signAndSendTransaction({ transaction });
```
Tokens:
Raw