# NFT API

{% hint style="warning" %}
In Q1 2025, the Chiliz team will decommission several endpoints and features. This is to ensure that the Socios.com API remains focused on the Socios.com app features, and to bring it always closer to the Web3 ecosystem.&#x20;

Don't worry! We will provide you with alternatives right here on this documentation site.

You will find more information [in this guide](https://connect.socios.com/partner-api/2025-api-update-overview), and in each API section of this site.
{% endhint %}

{% hint style="danger" %}
**NFT API endpoints that are decommissioned with alternatives**

The following endpoint will soon not be available anymore, and we encourage you to use one of the alternative we suggest here:

* `GET /user/nfts`: Get NFT data for currently logged-in user.
* `GET /nft/{id}`: Get data on a single NFT.

\
**NFT API endpoints that are decommissioned with no alternative**

The following endpoints cannot be easily replaced by an alternative.

* `POST /admin/nft/smart-contract`: Create an NFT smart contract.
* `POST /admin/nft/collectible-definition`: Create an NFT collection.
* `POST /admin/nft/{collectibleId}/asset-upload`: Upload a collection of media.
* `POST /admin/nft/{collectibleDefinition}/mint`: Mint a collection of media.

Sadly, if you do rely on one of these, you will have to remove the feature from your service.
{% endhint %}

## Socios.com NFT API

The NFT API aims to provide all the information about NFTs that are held by the user. You will be able to retrieve the full list of NFTs along with all its details including NFT image, name, collection, date of creation, and owner.

## Using the NFT API&#x20;

{% hint style="info" %}
If you're a new user and do not have access to the Socios.com portal yet, see [prerequisites](https://connect.socios.com/partner-api/prerequisites "mention").
{% endhint %}

1. Once you've logged in to the Socios.com API portal, select **NFT**.

<figure><img src="https://31329255-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMDcaoJLMj5Y3jzFMTONF%2Fuploads%2FnACNKfu52PTjQgML3cur%2FScreenshot%202023-02-22%20at%206.00.34%20PM.png?alt=media&#x26;token=c31db6aa-9f7a-4111-8cb5-58b7162ae571" alt=""><figcaption></figcaption></figure>

2. Click the **Try Out** button next to the API URL.

<figure><img src="https://31329255-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMDcaoJLMj5Y3jzFMTONF%2Fuploads%2FQbg6GOAT1ujkV2lVVzkn%2Fimage.png?alt=media&#x26;token=0e3ef3ad-5114-452a-b628-e773f39fa107" alt=""><figcaption></figcaption></figure>

3. You'll see the following modal, indicating registering steps completed. \
   Click the **Try Out** button.

![](https://31329255-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMDcaoJLMj5Y3jzFMTONF%2Fuploads%2FtXaCCWzW4hvhXV1L9fO1%2Fimage.png?alt=media\&token=7b61a069-48a9-4921-bd8f-ccfa4adf467c)

4. On the **Security** page that is now displayed, *OAuth* is already selected. Click on the **Get Test Key** button.&#x20;

<figure><img src="https://31329255-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMDcaoJLMj5Y3jzFMTONF%2Fuploads%2Fm14RtfU2QCdPEmbLXCd1%2Fimage.png?alt=media&#x26;token=f0240a4c-91a7-4ca7-8569-0207c7cbfd09" alt=""><figcaption></figcaption></figure>

5. Once the test key is generated, you can display it using the <img src="https://31329255-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMDcaoJLMj5Y3jzFMTONF%2Fuploads%2FbOs5V6HzE1FDsxyfYUCh%2Fimage.png?alt=media&#x26;token=a58c5a36-10b0-499b-ad64-11eda7c15914" alt="" data-size="line"> icon.&#x20;

<figure><img src="https://31329255-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMDcaoJLMj5Y3jzFMTONF%2Fuploads%2FihsHEEKN8mq1lOnooZgk%2Fimage.png?alt=media&#x26;token=66e2221f-ea71-46e8-bf18-9b6189c9acfc" alt=""><figcaption></figcaption></figure>

## **Subscription**

1. On the **Subscriptions** page then click on the **SUBSCRIPTION & KEY GENERATION WIZARD** button.

<figure><img src="https://31329255-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMDcaoJLMj5Y3jzFMTONF%2Fuploads%2F38wVW4nlOCwlZPvq4zlh%2Fimage.png?alt=media&#x26;token=d4090dc8-d615-4e89-88f1-1525b34b0feb" alt=""><figcaption></figcaption></figure>

2. Then, enter valid details in the **Create application** form fields:

<figure><img src="https://31329255-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMDcaoJLMj5Y3jzFMTONF%2Fuploads%2FaaPNrUA7cmWazt5zPB9t%2Fimage.png?alt=media&#x26;token=d2463815-9f9c-45c4-a938-1ad3ee465491" alt=""><figcaption></figcaption></figure>

| Parameter                           | Description                                           |
| ----------------------------------- | ----------------------------------------------------- |
| Application Name                    | Enter name of the Application                         |
| Shared Quota for Application Tokens | The amount of tokens generated for each application   |
| Application Description             | (Optional). A brief description about the application |

3. In the *Subscribe to new application* step, enter the **Application** name you want to use. \
   Select a *Business Plan* from the dropdown menu, and click **Next.**

Please note, there may be restrictions on the available plans for now.&#x20;

<figure><img src="https://31329255-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMDcaoJLMj5Y3jzFMTONF%2Fuploads%2F69SlDKwz0HMeb8umTBVO%2Fimage.png?alt=media&#x26;token=659f5ece-3932-47ed-bc7d-d552b64559fc" alt=""><figcaption></figcaption></figure>

4. On the *Generate Keys* tab, once you've carefully reviewed the page, select **NEXT**.

<figure><img src="https://31329255-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMDcaoJLMj5Y3jzFMTONF%2Fuploads%2FJLsUkb0t3jlPQE7cJiSo%2Fimage.png?alt=media&#x26;token=bbbc1303-5616-4a02-aa49-4c7460b1a55e" alt=""><figcaption></figcaption></figure>

5. On the *Generate Access Token* tab, enter a valid description in the **Scopes** field. Select **NEXT**.

<figure><img src="https://31329255-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMDcaoJLMj5Y3jzFMTONF%2Fuploads%2FkUf0c3bDn1UshHdYoGVh%2Fimage.png?alt=media&#x26;token=01bd2cc6-1523-46e8-b184-70255c0e89d2" alt=""><figcaption></figcaption></figure>

6. On the *Copy Access Token* tab, select ![](https://31329255-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMDcaoJLMj5Y3jzFMTONF%2Fuploads%2FkQq2AwEL1rl07fIDExOF%2Fimage.png?alt=media\&token=773d6678-8f8a-4877-9c4b-90f6c426ffb5) to copy the Access Token. Once copied, click **FINISH**.&#x20;

<figure><img src="https://31329255-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMDcaoJLMj5Y3jzFMTONF%2Fuploads%2FYGdgJG9ArdWA6X4QlI3w%2Fimage.png?alt=media&#x26;token=69b443f0-eb85-485c-bcac-45ab45a46229" alt=""><figcaption></figcaption></figure>

7. You can view your newly created subscription under the **Subscriptions** section.

<figure><img src="https://31329255-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMDcaoJLMj5Y3jzFMTONF%2Fuploads%2FFQLDQ9HVfKBxhcV2s6G8%2FScreenshot%202023-02-23%20at%203.54.49%20PM.png?alt=media&#x26;token=d2bb02e3-26c9-4e73-bca9-1f833229a2c7" alt=""><figcaption></figcaption></figure>
