# API Endpoints

## NFT Base API Endpoints

{% hint style="info" %}
Default prefix for NFT Base is `/api/nft`
{% endhint %}

### List of Assets Endpoints

| Endpoint                                                                                 | Description                         | Type |
| ---------------------------------------------------------------------------------------- | ----------------------------------- | ---- |
| [​/assets​](/developers/sdk/nft/api-endpoints/assets.md#all-assets)                      | Returns all assets                  | GET  |
| [​/assets/:id​](/developers/sdk/nft/api-endpoints/assets.md#asset-by-id)                 | Returns asset by id                 | GET  |
| [​/assets/:id/wallets​](/developers/sdk/nft/api-endpoints/assets.md#wallet-owning-asset) | Returns the wallet owning an asset  | GET  |
| [​/assets/wallet/:id​](/developers/sdk/nft/api-endpoints/assets.md#wallet-assets)        | Returns the assets that wallet owns | GET  |
| [​/assets/search​](/developers/sdk/nft/api-endpoints/assets.md#search-by-asset)          | Search assets                       | POST |
| /assets/claim                                                                            | Claims an asset                     | POST |

### List of Burn Endpoints

| Endpoint                                                              | Description        | Type |
| --------------------------------------------------------------------- | ------------------ | ---- |
| [​/burns​](/developers/sdk/nft/api-endpoints/burns.md#all-burns)      | Returns all burns  | GET  |
| [​/burns/:id​](/developers/sdk/nft/api-endpoints/burns.md#burn-by-id) | Returns burn by id | GET  |

### List of Collection Endpoints

| Endpoint                                                                                          | Description                            | Type |
| ------------------------------------------------------------------------------------------------- | -------------------------------------- | ---- |
| [​/collections​](/developers/sdk/nft/api-endpoints/collections.md#all-collections)                | Returns all collections                | GET  |
| [​/collections/:id​](/developers/sdk/nft/api-endpoints/collections.md#collection-by-id)           | Returns collection by id               | GET  |
| [​/collections/:id/schema​](/developers/sdk/nft/api-endpoints/collections.md#collection-schema)   | Returns the schema of a collection     | GET  |
| [​/collections/:id/wallets​](/developers/sdk/nft/api-endpoints/collections.md#collections-wallet) | Returns the wallet owning a collection | GET  |
| [​/collections/search​](/developers/sdk/nft/api-endpoints/collections.md#search-collection)       | Search collections                     | POST |
| [​/collections/:id/assets​](/developers/sdk/nft/api-endpoints/collections.md#collection-assets)   | Returns the assets of a collection     | GET  |

### List of **Configuration** Endpoints

| Endpoint                                                                                     | Description                | Type |
| -------------------------------------------------------------------------------------------- | -------------------------- | ---- |
| [​/configurations​](/developers/sdk/nft/api-endpoints/base-configurations.md#configurations) | Returns all configurations | GET  |

### List of Transfer Endpoints

| Endpoint                                                                          | Description            | Type |
| --------------------------------------------------------------------------------- | ---------------------- | ---- |
| [​/transfers​](/developers/sdk/nft/api-endpoints/transfers.md#all-transfers)      | Returns all transfers  | GET  |
| [​/transfers/:id​](/developers/sdk/nft/api-endpoints/transfers.md#transfer-by-id) | Returns transfer by id | GET  |

## NFT Exchange API Endpoints

{% hint style="info" %}
Default prefix for NFT Exchange is `/api/nft/exchange`
{% endhint %}

### List of Auction Endpoints

| Endpoint                                                                                          | Description                          | Type |
| ------------------------------------------------------------------------------------------------- | ------------------------------------ | ---- |
| [​/auctions​](/developers/sdk/nft/api-endpoints/auctions.md#all-auctions)                         | Returns all active auctions          | GET  |
| [​/auctions/:id​](/developers/sdk/nft/api-endpoints/auctions.md#auction-by-id)                    | Returns auction by id                | GET  |
| [​/auctions/:id/wallets​](/developers/sdk/nft/api-endpoints/auctions.md#auctions-wallet)          | Returns the wallet owning an auction | GET  |
| [​/auctions/search​](/developers/sdk/nft/api-endpoints/auctions.md#search-auctions)               | Search auctions                      | POST |
| [​/auctions/canceled​](/developers/sdk/nft/api-endpoints/auctions.md#canceled-auctions)           | Returns all canceled auctions        | GET  |
| [​/auctions/canceled/:id​](/developers/sdk/nft/api-endpoints/auctions.md#canceled-auctions-by-id) | Returns canceled auction by :id      | GET  |

### List of Bid Endpoints

| Endpoint                                                                              | Description                     | Type |
| ------------------------------------------------------------------------------------- | ------------------------------- | ---- |
| [​/bids​](/developers/sdk/nft/api-endpoints/bids.md#all-bids)                         | Returns all bids                | GET  |
| [​/bids/:id​](/developers/sdk/nft/api-endpoints/bids.md#bids-by-id)                   | Returns bid by id               | GET  |
| [​/bids/:id/wallets​](/developers/sdk/nft/api-endpoints/bids.md#bids-wallet)          | Returns the wallet owning a bid | GET  |
| [​/bids/search​](/developers/sdk/nft/api-endpoints/bids.md#search-bids)               | Search bids                     | POST |
| [​/bids/canceled​](/developers/sdk/nft/api-endpoints/bids.md#canceled-bids)           | Returns all canceled bids       | GET  |
| [​/bids/canceled/:id​](/developers/sdk/nft/api-endpoints/bids.md#canceled-bids-by-id) | Returns canceled bids by id     | GET  |

### List of **Configuration** Endpoints

| Endpoint                                                                                         | Description                | Type |
| ------------------------------------------------------------------------------------------------ | -------------------------- | ---- |
| [​/configurations​](/developers/sdk/nft/api-endpoints/exchange-configurations.md#configurations) | Returns all configurations | GET  |

### List of Trade Endpoints

| Endpoint                                                                      | Description         | Type |
| ----------------------------------------------------------------------------- | ------------------- | ---- |
| [​/trades​](/developers/sdk/nft/api-endpoints/trades.md#all-trades)           | Returns all trades  | GET  |
| [​/trades/:id​](/developers/sdk/nft/api-endpoints/trades.md#trade-by-id)      | Returns trade by id | GET  |
| [​/trades/search​](/developers/sdk/nft/api-endpoints/trades.md#search-trades) | Search trades       | POST |

## NFT Client

{% hint style="info" %}
A Light Typescript Client Supporting NFT REST API
{% endhint %}

### Installation

#### [yarn](https://classic.yarnpkg.com/lang/en/)

```
yarn add @protokol/client
```

#### [pnpm](https://pnpm.js.org/)

```
pnpm add @protokol/client
```

#### [npm](https://www.npmjs.com/)

```
npm install @protokol/client
```

### Initialization

```typescript
import { ProtokolConnection } from "@protokol/client";

const connection = new ProtokolConnection("https://explorer.protokol.sh/api");
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.protokol.com/developers/sdk/nft/api-endpoints.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.