![](https://pbs.twimg.com/media/FW2V0ACXkAY64eA.jpg:large)

## **Introduction to NMKR Studio API**

The NMKR Studio API (Application Programming Interface) allows you to implement the features from NMKR Studio to your own website or DApp. 

The API works similarly to other API’s, whereby you are able to utilise the HTTP Get and Post Requests to invoke our Server-Side code to run methods.

The API essentially provides all the functionality we offer in NMKR Studio, through a programmatic interface. Everything from uploading your NFTs, to providing a Payment Link for NMKR Pay, setting up whitelists, can be done via the API.

If you are looking to do something more advanced or simply prefer using code rather than a user interface, the API might be the right solution for you. 

The API is available for the Testnet (preprod) and for the Mainnet.
We are currently running the Version 2 of our API and are constantly adding new endpoints in order to make more features available for you.


**Who is using the API**

The API is designed to be used by competent programmers who have knowledge in the following areas:

- API's
- Front-end Web Development
- Back-end Web Development
- General programming

What is the NMKR Studio API ?

![](https://pbs.twimg.com/media/FW2V0ACXkAY64eA.jpg:large)

## **NMKR API Features**

Discover what the NMKR API with it's numerous endpoints can do for you.

Add these endpoints to your [curl](https://docs.nmkr.io/nmkr-studio-api/get-started-with-the-api#example-curl), in order to use the in your applications.
Example:

`curl -X 'GET' \`  
 ` 'https://studio-api.nmkr.io/v2/endpoint...`  
`  -H 'accept: text/plain' \`  
  `-H 'Authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxx'`  


If you want to try these endpoints before integrating them, please use the [Swagger](https://studio-api.nmkr.io/swagger/index.html).

![](https://media.discordapp.net/attachments/1051122644591841321/1321598184015007854/image.png?ex=676dd1b9&is=676c8039&hm=f1a742b20dd8e280bb29714ed79d2cac7d0c83774d77d9c78e63d59a50d5cf26&=&format=webp&quality=lossless&width=472&height=420)

![](https://media.discordapp.net/attachments/1051122644591841321/1321599469090897981/image.png?ex=676dd2eb&is=676c816b&hm=fde2474b328bea2f1010a51678eb76f1b494985ea59ffefacc661a2ce410c021&=&format=webp&quality=lossless&width=442&height=420)

![](https://media.discordapp.net/attachments/1051122644591841321/1321599971811786864/image.png?ex=676dd363&is=676c81e3&hm=4ba88f6f67e40cff4bab28f701a5deca9d3934711f2f977cc44f73132e7f1208&=&format=webp&quality=lossless&width=434&height=420) ![](https://media.discordapp.net/attachments/1051122644591841321/1321600232538116241/image.png?ex=676dd3a1&is=676c8221&hm=bcd4e183eaa58150889cf62b377971e2fd5f5eb0d0ccf27c4834ee7d39f0b44c&=&format=webp&quality=lossless&width=613&height=420)

![](https://media.discordapp.net/attachments/1051122644591841321/1321602618904285185/image.png?ex=676dd5da&is=676c845a&hm=d802128ef93643d0bb8e409699936e4dd61e13d028c004c2ec2be9ee34a5a9c6&=&format=webp&quality=lossless&width=493&height=420)

![](https://media.discordapp.net/attachments/1051122644591841321/1321602883468394549/image.png?ex=676dd619&is=676c8499&hm=5e8a40bbec5ed36442603a8c63e9040a3ab1543ca3aa03ad0f907f4c027667bd&=&format=webp&quality=lossless&width=463&height=420)

![](https://media.discordapp.net/attachments/1051122644591841321/1321604102186336317/image.png?ex=676dd73c&is=676c85bc&hm=ecf33325a3268ebd526c3dc93637ee8e184a6afa13867e5adc7956044e8f6dc7&=&format=webp&quality=lossless&width=660&height=321)

API Features

![](https://pbs.twimg.com/media/FW2V0ACXkAY64eA.jpg:large)

## **Swagger API Endpoint**

[Swagger API endpoint](https://studio-api.nmkr.io/swagger/index.html) 

Swagger API Endpoint 

Introduction - NMKR Studio API

![](https://pbs.twimg.com/media/FW2V0ACXkAY64eA.jpg:large)

## **API Swagger**

Use the Swagger to test the API on main and testnet

**What is the Swagger**

Swagger is a web-based user interface that allows you to test all API Method Calls. All of the code is pre-written, allowing you to 'drop in' your specific parameters and verify that the results are as expected before taking the time to implement it yourself. You can also use Swagger to better understand any errors you may be experiencing, and we recommend that you do so before contacting our support teams.

**Interface Structure**

You will also see that each method can be expanded to reveal various useful options and information:

- Description
- Parameters

1 . These are the inputs required for this specific method call

- Possible Responses

1 . These are all of the possible, pre defined HTTP response codes + data that the API will respond with, based on the result of your attempted method call


- Try-it-out

1 . Execute

- Run the test method call

1 . Actual Response

- The Specific HTTP Response to this specific attempted method call

**Using the Swagger**

To learn how to use the swagger, please read [Getting Started with the Swagger](https://docs.nmkr.io/nmkr-studio-api/api-swagger/get-started-with-the-swagger) and [Swagger Responses and Error Codes](https://docs.nmkr.io/nmkr-studio-api/api-swagger/swagger-responses-and-error-codes).

Note - the Project and NFT UID's are now both random strings that cannot be predicted, this extra security feature means that attackers cannot 'guess' the ID, making certain attacks more difficult even if the API Key is compromised.

Note - NEVER EXPOSE YOUR API KEY, IF YOU DO, DELETE IT AND MAKE A NEW ONE IMMEDIATELY.

**Swagger Mainnet**

[Swagger UI](https://studio-api.nmkr.io/swagger/index.html)

**Swagger Testnet (preprod)**

[Swagger UI](https://studio-api.preprod.nmkr.io/swagger/index.html)

API Swagger

![](https://pbs.twimg.com/media/FW2V0ACXkAY64eA.jpg:large)

## **Get Started with the Swagger**

How to get started with the Swagger

**Set up API Key first**

Before you get started with the API Swagger you have to create your Authentication Token or API Key first in NMKR Studio. Depending on the network you are going to use, you need to **[create an API](https://docs.nmkr.io/nmkr-studio/account/api-keys) Key in either the [testnet account](https://studio.preprod.nmkr.io/login/), or the [mainnet account](https://studio.nmkr.io/login/).**

**Global Page Authentication**

The first action before you can try it out, is to add your API key in the global page authorisation panel. If you do not do this, you will ALWAYS receive a 401 Error when using Swagger UI.

To do this, navigate to the top right of the page and select the 'Authorize' Button. You will then be greeted by a pop up, where you should copy and paste your [API Key](https://docs.nmkr.io/nmkr-studio/account/api-keys#manage-your-api-keys) mentioned previously.

![](https://docs.nmkr.io/~gitbook/image?url=https%3A%2F%2Fcontent.gitbook.com%2Fcontent%2Fbv1NlCoA0UqqILhTF1t0%2Fblobs%2FSeKPxPLzBFxDgFoGTeQs%2FScreenshot%25202022-12-02%2520at%252001.06.35.png&width=400&dpr=3&quality=100&sign=d39d87c7&sv=2)

**Example Workflow - Try it out!**

**1) Select the Endpoint**

Click on the Endpoint to expand more details and to test the Endpoint

![](https://docs.nmkr.io/~gitbook/image?url=https%3A%2F%2Fcontent.gitbook.com%2Fcontent%2Fbv1NlCoA0UqqILhTF1t0%2Fblobs%2FhV6L3GadToYZ3OTye2rj%2FScreenshot%25202022-12-02%2520at%252001.09.55.png&width=400&dpr=3&quality=100&sign=c93a5fd8&sv=2)

**2) Activate the panel**

Click "Try it out" to activate the panel.

![](https://docs.nmkr.io/~gitbook/image?url=https%3A%2F%2Fcontent.gitbook.com%2Fcontent%2Fbv1NlCoA0UqqILhTF1t0%2Fblobs%2FECGHwlsJurPDY5C9k9A1%2FScreenshot%25202022-12-02%2520at%252001.11.52.png&width=400&dpr=3&quality=100&sign=52049903&sv=2)

**3) Add the requested details**
If the Authorization is requested, please make sure that it is the same as you specified as [global authentication](https://docs.nmkr.io/nmkr-studio-api/api-swagger/get-started-with-the-swagger#global-page-authentication) and then click on "Execute".

![](https://docs.nmkr.io/~gitbook/image?url=https%3A%2F%2Fcontent.gitbook.com%2Fcontent%2Fbv1NlCoA0UqqILhTF1t0%2Fblobs%2FdJz2ILll28Ny2PCpOnui%2FScreenshot%25202022-12-02%2520at%252001.15.02.png&width=400&dpr=3&quality=100&sign=c8b7807a&sv=2)

**4) Responses**

The NMKR Studio API will respond a) with the Curl and b) with the Request URL

![](https://docs.nmkr.io/~gitbook/image?url=https%3A%2F%2Fcontent.gitbook.com%2Fcontent%2Fbv1NlCoA0UqqILhTF1t0%2Fblobs%2FpF2uhUhyIS9We2UvBfN8%2FScreenshot%25202022-12-02%2520at%252001.17.59.png&width=400&dpr=3&quality=100&sign=90f92ab&sv=2)

And it will also respond with some Codes. Please read the [Swagger Responses and Error Codes](https://docs.nmkr.io/nmkr-studio-api/api-swagger/swagger-responses-and-error-codes) to understand what they mean. 

The following is a response that says that the call is 

**A) invalid; Reason: "Wallet address already exists".**

![](https://docs.nmkr.io/~gitbook/image?url=https%3A%2F%2Fcontent.gitbook.com%2Fcontent%2Fbv1NlCoA0UqqILhTF1t0%2Fblobs%2FyUomkW0mIzZLTkPfIGNJ%2FScreenshot%25202022-12-02%2520at%252001.21.41.png&width=400&dpr=3&quality=100&sign=243bf265&sv=2)

**B) valid and executed.**

![](https://docs.nmkr.io/~gitbook/image?url=https%3A%2F%2Fcontent.gitbook.com%2Fcontent%2Fbv1NlCoA0UqqILhTF1t0%2Fblobs%2FBAtthAlYr3ZvMLEKvMcb%2FScreenshot%25202022-12-02%2520at%252001.23.51.png&width=400&dpr=3&quality=100&sign=999a6dd0&sv=2)

Please keep in mind that if you upload the metadata in a payload, the metadata must be escaped. 
[Online JSON Escape /Unescape Tool](https://www.freeformatter.com/json-escape.html#before-output)https://www.freeformatter.com/json-escape.html#before-output

Get Started with the Swagger

![](https://pbs.twimg.com/media/FW2V0ACXkAY64eA.jpg:large)

## **Swagger Responses and Error Codes**

Learn about the meaning of the different responses

**Understanding Responses**
There are many HTTP Responses, so we are going to cover those that are most relevant to the NMKR Studio API.

HTTP response Codes are made up of 3 digits:

- First Digit is the category
- Second and Third Digits define the subcategory

**2xx Codes**

Codes beginning with **2** mean that you submitted a valid API method call, that executed correctly. At a high level, you will be looking to see the '200' response, which is literally translated to mean 'OK' this is good and means that the method executed correctly.

**4xx Codes**

Codes beginning with **4** mean that you submitted an invalid API method call, the NMKR Studio Servers handled this and returned information about what was wrong. You can then compare this with the Swagger Documentation to fix the error. Common responses will be '401' where there is an issue with your API Key and '404' where the UID of the project/NFT was not found.

**5xx Codes**

Codes beginning with **5** mean that there has been an issue on the server side. These will be rarer that 2's or 4's and may not be related to the way you have constructed your method call. The '503' error for example will appear in the unlikely event that our API service is unavailable.

You will see that every method has a predefined set of likely responses, with the additional information of what the response payload will return with.

Swagger Responses and Error Codes

![](https://pbs.twimg.com/media/FW2V0ACXkAY64eA.jpg:large)

## **API Examples**

This is a collection of API examples

In this section we will provide a collection of API examples that should make it easier for you to [get started with the API](https://docs.nmkr.io/nmkr-studio-api/get-started-with-the-api) and to build your own Curls.

Before you now begin to copy and paste the Examples and replace the individual values, please maker sure that you understand the [API structure](https://docs.nmkr.io/nmkr-studio-api/introduction-nmkr-studio-api) and its [responses](https://docs.nmkr.io/nmkr-studio-api/api-swagger/swagger-responses-and-error-codes). 
A great way to learn how to use the API is the [API Swagger](https://docs.nmkr.io/nmkr-studio-api/api-swagger). The Swagger is available for the Testnet and Mainnet and allows you to try the code before you add it into your DApps.

Please make also sure to understand the [fundamentals of the API ](https://docs.nmkr.io/nmkr-studio-api/introduction-nmkr-studio-api)and the possible [Responses and Error Codes](https://docs.nmkr.io/nmkr-studio-api/api-swagger/swagger-responses-and-error-codes).

API Examples

![](https://pbs.twimg.com/media/FW2V0ACXkAY64eA.jpg:large)

**Create a project via NMKR Studio API**

To create a project, you want to use the following endpoint.

**Endpoint**

`/v2/CreateProject`  

First, please define the request body of the project.
You can already specify project details in the request body, such as policy locking date, price list, and whitelisting. Please remove what is not needed by you and give the details accordingly for the fields that are important.

**Request Body**

```
{
  "projectname": "string",
  "description": "string",
  "projecturl": "string",
  "tokennamePrefix": "string",
  "twitterHandle": "string",
  "policyExpires": true,
  "policyLocksDateTime": "2022-12-06T12:40:50.306Z",
  "payoutWalletaddress": "string",
  "payoutWalletaddressUsdc": "string",
  "maxNftSupply": 0,
  "policy": {
    "policyId": "string",
    "privateVerifykey": "string",
    "privateSigningkey": "string",
    "policyScript": "string"
  },
  "metadataTemplate": "string",
  "addressExpiretime": 0,
  "pricelist": [
    {
      "countNft": 0,
      "priceInLovelace": 0,
      "isActive": true,
      "validFrom": "2022-12-06T12:40:50.306Z",
      "validTo": "2022-12-06T12:40:50.306Z"
    }
  ],
  "additionalPayoutWallets": [
    {
      "payoutWallet": "string",
      "valuePercent": 0,
      "valueFixInLovelace": 0
    }
  ],
  "saleConditions": [
    {
      "condition": "walletcontainspolicyid",
      "policyId1": "string",
      "policyId2": "string",
      "policyId3": "string",
      "policyId4": "string",
      "policyId5": "string",
      "minOrMaxValue": 0,
      "description": "string",
      "isActive": true,
      "policyProjectname": "string",
      "whitelistedAddresses": [
        "string"
      ],
      "blacklistedAddresses": [
        "string"
      ],
      "onlyOneSalePerWhitelistAddress": true
    }
  ],
  "enableFiat": true,
  "enableDecentralPayments": true,
  "enableCrossSaleOnPaymentgateway": true,
  "activatePayinAddress": true,
  "paymentgatewaysalestart": "2022-12-06T12:40:50.306Z"
}
```   

As there are many optional fields, the following are mandatory to create your project:

 ` "projectname": "string",`

 ```
 "policyExpires": true,
  "policyLocksDateTime": "2023-12-06T12:46:19.695Z",

or you import a policy ID with:

  "policy": {
    "policyId": "string",
    "privateVerifykey": "string",
    "privateSigningkey": "string",
    "policyScript": "string"
  },
```

  `"maxNftSupply": 0,`

  `"addressExpiretime": 0,`


Please keep in mind that if you upload the metadata in a payload, the metadata must be escaped. 
[Online JSON Escape /Unescape Tool](https://www.freeformatter.com/json-escape.html#before-output)https://www.freeformatter.com/json-escape.html#before-output

**Curl**  
Once you specified your body with the components that are important for you.
You can send the Curl. The following is an example with a specified policy locking time a max Supply of 1, which means all tokens in there are only available to mint once (NFTs). Further, the payout wallet address and one price as well as a sales start is specified. 

```
curl -X 'POST' \
  'https://studio-api.nmkr.io/v2/CreateProject' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer 0858c944c6ddxyzxyz1726da25' \
  -H 'Content-Type: application/json' \
  -d '{
  "projectname": "New Project",
  "description": "test",
  "projecturl": "string",
  "tokennamePrefix": "string",
  "twitterHandle": "string",
  "policyExpires": true,
  "policyLocksDateTime": "2023-12-06T12:46:19.695Z",
  "payoutWalletaddress": "addr1qxmrwr0sra35xjjdtugkasqqp2gsj969n6fdwt0fa6vxa5d98nu7s4l35sdwl6088e9f23ju7apk9hss7s9sgn3k9upqt2gwa8",
  "maxNftSupply": 1,
  "addressExpiretime": 20,
  "pricelist": [
    {
      "countNft": 1,
      "priceInLovelace": 10000000,
      "isActive": true,
      "validFrom": "2022-12-06T12:46:19.695Z",
      "validTo": "2023-12-06T12:46:19.695Z"
    }
  ],
  "enableDecentralPayments": true,
  "enableCrossSaleOnPaymentgateway": true,
  "activatePayinAddress": true,
  "paymentgatewaysalestart": "2022-12-08T12:46:19.695Z"
}'
```

**Response**  
A successful Curl will now return with the following response, which also contains the project ID of the newly created project. As there wasn't any metadata template in the request body, the response contains the [standard metadata template](https://docs.nmkr.io/nmkr-studio/project/metadata-template). And as there were no Policy Keys given to import an existing policy, a new one was created.

```
{
  "projectId": 41845,
  "metadata": "{\n  \"721\": {\n    \"<policy_id>\": {\n      \"<asset_name>\": {\n        \"name\": \"<display_name>\",\n        \"image\": \"<ipfs_link>\",\n        \"mediaType\": \"<mime_type>\",\n        \"description\": \"<description>\",\n        \"files\": [\n          {\n            \"name\": \"<display_name>\",\n            \"mediaType\": \"<mime_type>\",\n            \"src\": \"<ipfs_link>\"\n          }\n        ]\n      }\n    },\n    \"version\": \"1.0\"\n  }\n}",
  "policyId": "93c09ec87047f3309621fd4d48f9c5dfbxyz6d4b6a3fd015066eebe7",
  "policyScript": "{\n  \"type\": \"all\",\n  \"scripts\": [\n    {\n      \"type\": \"sig\",\n      \"keyHash\": \"ac636184a369b69d80xyzc5bxyz1a85c317bcc80f26bd4dfbfe60607\"\n    },\n    {\n      \"slot\": 110340895,\n      \"type\": \"before\"\n    }\n  ]\n}",
  "policyExpiration": "2023-12-06T12:46:19.695Z",
  "uid": "ef28ec63-3af1-4751-8b4f-b6a3373a6519"
}
```




Create Project

![](https://pbs.twimg.com/media/FW2V0ACXkAY64eA.jpg:large)

## **Upload a file to your project**

With the following endpoint, you are able to upload a token and optional to also define placeholder values or also a complete metadata code for the metadata override.

Please keep in mind that if you upload the metadata in a payload, the metadata must be escaped. 
[Online JSON Escape /Unescape Tool](https://www.freeformatter.com/json-escape.html#before-output)https://www.freeformatter.com/json-escape.html#before-output

**Endpoint**

`/v2/UploadNft`

**Body**  
Define the body for the request fitting for your token upload. Please remove the fields that don't apply for your upload. You have the option of uploading the file as BASE64 Content, URL Link, or IPFS Hash. If you submit Metadata, it will be used instead of the project's Metadatatemplate. You may submit either Metadata or MetadataPlaceholder, but not both.


```
{
  "tokenname": "string",
  "displayname": "string",
  "description": "string",
  "previewImageNft": {
    "mimetype": "string",
    "fileFromBase64": "string",
    "fileFromsUrl": "string",
    "fileFromIPFS": "string"
  },
  "subfiles": [
    {
      "subfile": {
        "mimetype": "string",
        "fileFromBase64": "string",
        "fileFromsUrl": "string",
        "fileFromIPFS": "string"
      },
      "description": "string",
      "metadataPlaceholder": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "metadataPlaceholder": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "metadataOverride": "string",
  "priceInLovelace": 0
}
```

For this example, we specified the body like that:

```
{
  "tokenname": "thetoken1",
  "displayname": "The Token 1",
  "description": "This is a test",
  "previewImageNft": {
    "mimetype": "image/png",
    "fileFromIPFS": "QmfA66piVcujJoSmL1fu1beJS2agvadXbzwv4hX4dnzqWY"
  },
  "subfiles": [
    {
      "subfile": {
        "mimetype": "image/png",
        "fileFromIPFS": "QmPep292dYH9CXH9AcMgbcEohXUc3P8ERbAfw7r9HM3AdY"
      }
    }
  ],
  "metadataPlaceholder": [
    {
      "name": "background",
      "value": "green"
    }
  ]
}

```

Instead of giving the metadata via MetadataOverride, we used the metadataPlaceholder method to define custom fields. Please keep in mind that this placeholder method only works, if the custom fields are specified in the [metadata template](https://docs.nmkr.io/nmkr-studio/project/metadata-template).

If you want to use the Metadata Override, [please read here](https://docs.nmkr.io/nmkr-studio-api/api-examples/project/upload-file-and-metadata#using-the-metadata-override-instead-of-the-placeholder).

**Curl**

```
curl -X 'POST' \
  'https://studio-api.nmkr.io/v2/UploadNft/1420d55a-e194-4aa6-b57d-6d0f0d3b0738' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer 1ac2cb0abea146f7bb8a90701dad311c' \
  -H 'Content-Type: application/json' \
  -d '{
  "tokenname": "thetoken1",
  "displayname": "The Token 1",
  "description": "This is a test",
  "previewImageNft": {
    "mimetype": "image/png",
    "fileFromIPFS": "QmfA66piVcujJoSmL1fu1beJS2agvadXbzwv4hX4dnzqWY"
  },
  "subfiles": [
    {
      "subfile": {
        "mimetype": "image/png",
        "fileFromIPFS": "QmPep292dYH9CXH9AcMgbcEohXUc3P8ERbAfw7r9HM3AdY"
      }
    }
  ],
  "metadataPlaceholder": [
    {
      "name": "background",
      "value": "green"
    }
  ]
}'
```

**Response**

```
{
  "nftId": 13174329,
  "nftUid": "8deedfd7-6aa4-45df-be6b-27efa51b8ec3",
  "ipfsHashMainnft": "QmfA66piVcujJoSmL1fu1beJS2agvadXbzwv4hX4dnzqWY",
  "ipfsHashSubfiles": [
    "QmPep292dYH9CXH9AcMgbcEohXUc3P8ERbAfw7r9HM3AdY"
  ],
  "metadata": "{\n  \"721\": {\n    \"63cb7af8c980f0867940e765f36fa53ac948d9af51179742291a553e\": {\n      \"thetoken1\": {\n        \"name\": \"The Token 1\",\n        \"image\": \"ipfs://QmfA66piVcujJoSmL1fu1beJS2agvadXbzwv4hX4dnzqWY\",\n        \"mediaType\": \"image/png\",\n        \"description\": \"This is a test\",\n        \"files\": [\n          {\n            \"name\": \"The Token 1\",\n            \"mediaType\": \"image/png\",\n            \"src\": \"ipfs://QmPep292dYH9CXH9AcMgbcEohXUc3P8ERbAfw7r9HM3AdY\"\n          }\n        ]\n      }\n    },\n    \"version\": \"1.0\"\n  }\n}",
  "assetId": "63cb7af8c980f0867940e765f36fa53ac948d9af51179742291a553e746865746f6b656e31"
}

```

**Using the Metadata Override instead of the Placeholder**  
In case you want to submit a complete 721 Metadata JSON, please keep in mint that you have to remove the MetadataPlaceholder fields in the request body and use the Metadata override field.

`  "metadataOverride": "string",`


Continue to send your Curl as you would with the placeholder method, adding the escaped  **metadata** to the field:

 ` "metadataOverride": "{\r\n  \"721\": {\r\n    \"63cb7af8c980f0867940e765f36fa53ac948d9af51179742291a553e\": {\r\n      \"thetoken1\": {\r\n        \"name\": \"The Token 1\",\r\n        \"image\": \"ipfs:\/\/QmfA66piVcujJoSmL1fu1beJS2agvadXbzwv4hX4dnzqWY\",\r\n        \"mediaType\": \"image\/png\",\r\n        \"background\": \"green\",\r\n        \"description\": \"This is a test\",\r\n        \"files\": [\r\n          {\r\n            \"name\": \"The Token 1\",\r\n            \"mediaType\": \"image\/png\",\r\n            \"src\": \"ipfs:\/\/QmPep292dYH9CXH9AcMgbcEohXUc3P8ERbAfw7r9HM3AdY\"\r\n          }\r\n        ]\r\n      }\r\n    },\r\n    \"version\": \"1.0\"\r\n  }\r\n}",`

Upload File and Metadata

![](https://pbs.twimg.com/media/FW2V0ACXkAY64eA.jpg:large)

## **Create a Payment Link for random Token sales via NMKR Pay**

With this endpoint you have the flexibility to add your own custom Queue or Whitelisting system in Front of the purchasing process of random tokens via NMKR Pay. 

To create a unique random payment transaction that allows your customer to buy a random token via [NMKR Pay](https://docs.nmkr.io/nmkr-studio/set-up-sales/nmkr-pay), we call the API endpoint:

`/v2/CreatePaymentTransaction`

**Curl request**  
As always with the NMKR API, the API Key / Authentication Token is given in the header:
Further you specify the "projectUid" (not the Project ID) and also the "nftUid" (not the token ID) as well as the token count.

```
curl --location --request POST 'https://studio-api.nmkr.io/v2/CreatePaymentTransaction' \
--header 'authorization: <<api_key>>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "projectUid": "<<project_uid>>",
  "paymentTransactionType": "nmkr_pay_random",
  "customProperties": {},
 
  "paymentgatewayParameters": {
    
        "mintnfts":{
    "countNfts": 1
        }
  },
  "customerIpAddress": "0.0.0.0"
}'
```


**Response**  
The response given by NMKR Studio will now identify the project by the UID and the price of the tokens from the [pricelist](https://docs.nmkr.io/nmkr-studio/set-up-sales/manage-prices-pricelist).
The field "nmkrPayUrl" now contains a [random payment link](https://docs.nmkr.io/nmkr-studio/set-up-sales/nmkr-pay/set-up-nmkr-pay#share-the-payment-link-or-integrate-to-website) to buy the Token via [NMKR Pay](https://docs.nmkr.io/nmkr-studio/set-up-sales/nmkr-pay) with all its [features](https://docs.nmkr.io/nmkr-studio/set-up-sales/nmkr-pay#nmkr-pay-vs.-pay-in-address).

```
{
    "paymentTransactionUid": "Tb38ed487c9274cd1b34266b40d97ea08",
    "projectUid": "05f6694c-a399-45fd-8dc4-d9fc9a7343b0",
    "paymentTransactionType": "nmkr_pay_random",
    "customProperties": {},
    "state": "prepared",
    "transactionParameters": null,
    "paymentTransactionCreated": "2022-12-01T00:49:18.158886+00:00",
    "paymentgatewayResults": {
        "priceInLovelace": null,
        "fee": null,
        "minUtxo": null,
        "mintNfts": {
            "countNfts": 1,
            "reserveNfts": []
        },
        "additionalPriceInTokens": []
    },
    "paymentTransactionSubStateResult": null,
    "auctionResults": null,
    "directSaleResults": null,
    "decentralParameters": null,
    "mintAndSendResults": null,
    "cbor": null,
    "signedCbor": null,
    "expires": null,
    "signGuid": null,
    "fee": null,
    "txHash": null,
    "nmkrPayUrl": "https://pay.nmkr.io/?mtid=Tb38ed487c9274cd1b34266b40d97ea08",
    "referencedTransaction": null,
    "customeripaddress": "0.0.0.0",
    "referer": null
}
```



Create unique NMKR Pay Link for random Token sales

Generate a payment address that can be used to mint a single NFT with a payment in ADA + any other Cardano Native Tokens

With this Curl request you will be able to create payment addresses for your customers that can be paid with Custom Native Tokens. This workaround does not use the prices in the pricelist of your project.

**Curl request format**

The curl request should be sent in the format shown below.
Please keep in mint that every parameter that is specified needs to be specified with value in the curl request.

There is a technical required minimum of 5.5 ADA that needs to be charged with every Token payment.


The API is also not accounting for any decimal points that you have specified in the Token Registry.


```
curl -X 'GET' \
  'https://studio-api.nmkr.io/v2/GetPaymentAddressForRandomNftSale/<project_UID>/<Token_count>/<Lovelace>/127.0.0.1?referer=<referer>&customproperty=<custom_property>&optionalreceiveraddress=<receiver_address>&optionalpriceintokenpolicyid=<token_policy_Id>&optionalpriceintokenassetnameinhex=<assetname_in_HEX>&optionalpriceintokencount=<price_in_tokens>' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer <your API Key>'
```

**Curl request example**

```
curl -X 'GET' \
  'https://studio-api.nmkr.io/v2/GetPaymentAddressForRandomNftSale/86ed0fa4-bb87-4ac7-95fa-f86140a175d7/1/5500000/127.0.0.1?optionalpriceintokenpolicyid=5dac8536653edc12f6f5e1045d8164b9f59998d3bdc300fc92843489&optionalpriceintokenassetnameinhex=4E4D4B52&optionalpriceintokencount=4' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer <your API Key>'
```


**Response**

According to your specified parameters, the payment address would be given in the response to this curl. This address can now be used to mint the assets if the correct amount of ADA and custom native tokens is being sent to it.

```
{
  "paymentAddress": "addr1v908nestz7uz40xlyqhkmtr94vt7rj39ps2jugsr6s9y2tgk6q5u8",
  "paymentAddressId": 502211,
  "expires": "2023-09-17T14:52:49.459975+00:00",
  "adaToSend": "5.5",
  "debug": "",
  "priceInEur": 1.29,
  "priceInUsd": 1.38,
  "priceInJpy": 203.69,
  "priceInBtc": 5.1832554E-05,
  "effectivedate": "2023-09-17T14:03:41",
  "priceInLovelace": 5500000,
  "additionalPriceInTokens": [
    {
      "countToken": 4,
      "policyId": "5dac8536653edc12f6f5e1045d8164b9f59998d3bdc300fc92843489",
      "assetNameInHex": "4e4d4b52",
      "multiplier": 1,
      "totalCount": 4,
      "assetName": "NMKR",
      "decimals": 0
    }
  ],
  "sendbackToUser": 2000000
}
```

Get Payment Address for single NFT sales with native Tokens

Create a Payment Link to sell multiple specific Tokens in one transaction via NMKR Pay

With this endpoint you have the flexibility to add your own custom Queue or Whitelisting system in front of the purchasing process of multiple specific tokens via NMKR Pay.

To create a specific payment transaction that allows your customer to buy multiple specific tokens via [NMKR Pay](https://docs.nmkr.io/nmkr-studio/set-up-sales/nmkr-pay), we call the API endpoint:

`/v2/CreatePaymentTransaction`

As always with the NMKR API, the API Key / Authentication Token is given in the header:
Further you specify the "projectUid" (not the Project ID) and also the "nftUids" (not the token ID) of the tokens you want to sell as well as the token count for each.

```
curl --request POST \
--url https://studio-api.nmkr.io/v2/CreatePaymentTransaction \
--header 'Content-Type: application/json' \
--header 'authorization: <your API Key>' \
--data '{
"projectUid": "9e2d000a-ed53-4db4-819b-25cdab41fd47",
"paymentTransactionType": "nmkr_pay_specific",
"paymentgatewayParameters": {
"mintNfts": {
"reserveNfts": [
{
"nftUid": "608bf1ba-79e5-4e84-b011-e12e0ed0999f",
"tokencount": 1
},
{
"nftUid": "5cd4bebb-c0c5-48ed-ab25-58aa19639840",
"tokencount": 1
}
]
}
},
"customerIpAddress": "1.2.3.4"
}'
```

**Response**

The response given by NMKR Studio will now identify the project and tokens by the UID, the price of the tokens, that was either [specified in the token itself](https://docs.nmkr.io/nmkr-studio/token/edit#static-price-with-specific-sales) or the [pricelist](https://docs.nmkr.io/nmkr-studio/set-up-sales/manage-prices-pricelist).
The field "nmkrPayUrl" now contains a [specific payment link](https://docs.nmkr.io/nmkr-studio/set-up-sales/nmkr-pay/specific-payment-links) to buy the Tokens via [NMKR Pay](https://docs.nmkr.io/nmkr-studio/set-up-sales/nmkr-pay) with all its [features](https://docs.nmkr.io/nmkr-studio/set-up-sales/nmkr-pay#nmkr-pay-vs.-pay-in-address).



```
{
  "paymentTransactionUid": "Ta1a88a1cf1744c76889396c9ae916a88",
  "projectUid": "9e2d000a-ed53-4db4-819b-25cdab41fd47",
  "paymentTransactionType": "nmkr_pay_specific",
  "customProperties": {},
  "state": "prepared",
  "transactionParameters": [
    {
      "tokencount": 1,
      "policyId": null,
      "tokenname": "ThatsWhy0038",
      "tokennameHex": "546861747357687930303338"
    },
    {
      "tokencount": 1,
      "policyId": null,
      "tokenname": "ThatsWhy0042",
      "tokennameHex": "546861747357687930303432"
    }
  ],
  "paymentTransactionCreated": "2023-08-17T12:31:06.2258978+00:00",
  "paymentgatewayResults": {
    "priceInLovelace": 80000000,
    "fee": null,
    "minUtxo": null,
    "mintNfts": {
      "countNfts": 1,
      "reserveNfts": [
        {
          "nftUid": "608bf1ba-79e5-4e84-b011-e12e0ed0999f",
          "tokencount": 1,
          "tokennameHex": "546861747357687930303338",
          "policyId": null,
          "nftId": 286521,
          "lovelace": null
        },
        {
          "nftUid": "5cd4bebb-c0c5-48ed-ab25-58aa19639840",
          "tokencount": 1,
          "tokennameHex": "546861747357687930303432",
          "policyId": null,
          "nftId": 286525,
          "lovelace": null
        }
      ]
    },
    "additionalPriceInTokens": []
  },
  "paymentTransactionSubStateResult": null,
  "auctionResults": null,
  "directSaleResults": null,
  "directSaleOfferResults": null,
  "decentralParameters": null,
  "mintAndSendResults": null,
  "smartContractInformation": null,
  "cbor": "",
  "signedCbor": "",
  "expires": null,
  "signGuid": null,
  "fee": null,
  "txHash": null,
  "nmkrPayUrl": "https://pay.nmkr.io/?mtid=Ta1a88a1cf1744c76889396c9ae916a88",
  "referencedTransaction": null,
  "customeripaddress": "1.2.3.4",
  "referer": null
}
```

Create NMKR Pay Link for a multi-specific Tokens sale

![](https://pbs.twimg.com/media/FW2V0ACXkAY64eA.jpg:large)

## **Mint a token of a project manually with the API**

This example shows you how you [mint and send a random token](https://docs.nmkr.io/nmkr-studio-api/api-examples/minting/manual-minting#mint-and-send-random-via-api) of your project and also how to [mint and send a specific token](https://docs.nmkr.io/nmkr-studio-api/api-examples/minting/manual-minting#mint-and-send-specific-via-api).

**Mint and send random via API**

To mint a token randomly selected out of your project to a specific wallet address, you are going to use the endpoint:

`/v2/MintAndSendRandom`

**Curl**

```
curl -X 'GET'
'https://studio-api.nmkr.io/v2/MintAndSendRandom/1420d55a-e194-4aa6-b57d-6d0f0d3b0738/1/addr1qxmrwr0sra35xjjdtugkasqqp2gsj969n6fdwt0fa6vxa5d98nu7s4l35sdwl6088e9f23ju7apk9hss7s9sgn3k9upqt2gwa8'
-H 'accept: text/plain'
-H 'Authorization: Bearer 1ac2cb0abea1xyzxyza90701dad311c'
```

There are basically just three things that need to be specified in the Curl to make this endpoint work; the UID of the project, the count of tokens and the address that receives the tokens.

**Response**

The response will now show you, that the token is reserved for minting. The mint and send jobs are written in a queue and processed in batches.


```
{
  "mintAndSendId": 189657,
  "sendedNft": [
    {
      "id": 13174323,on
      "uid": "a438d3bd-95be-4f3a-be19-1f3b44e7ded6",
      "name": "0002",
      "displayname": null,
      "detaildata": null,
      "ipfsLink": "ipfs://QmfA66piVcujJoSmL1fu1beJS2agvadXbzwv4hX4dnzqWY",
      "gatewayLink": "https://gw3.easy-ipfs.com/ipfs/QmfA66piVcujJoSmL1fu1beJS2agvadXbzwv4hX4dnzqWY",
      "state": "reserved",
      "minted": false,
      "policyId": null,
      "assetId": null,
      "assetname": null,
      "fingerprint": null,
      "initialMintTxHash": null,
      "series": null,
      "tokenamount": 0,
      "price": null,
      "selldate": null,
      "paymentGatewayLinkForSpecificSale": null
    }
  ]
}
```

Your token will now be processed within the next few moments. If you want to verify that the token is actually minted, please call the following endpoint:

`/v2/GetNftDetailsById`

This endpoint will respond with the state and some more details about the token.

**Mint and send specific via API**

The endpoint you are calling to mint and send a specific token of a project to a wallet address is:

`/v2/MintAndSendSpecific`

**Curl**

```
```
curl -X 'GET' \
  'https://studio-api.nmkr.io/v2/MintAndSendSpecific/1420d55a-e194-4aa6-b57d-6d0f0d3b0738/ef8b821c-56fc-497f-b5cd-b72c20e74510/1/addr1qxjylrcjy5vf2vvjzgm7v7lfccm3k86yxg2v0lgfgged94498nu7s4l35sdwl6088e9f23ju7apk9hss7s9sgn3k9upq6adfun' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer 1ac2cb0abea146f7bb8a90701dad311c'
```

In this Curl you are specifying the project UID, the token UID, the count and the receiver address.

**Response**


{
  "mintAndSendId": 189658,
  "sendedNft": [
    {
      "id": 13174322,
      "uid": "ef8b821c-56fc-497f-b5cd-b72c20e74510",
      "name": "0001",
      "displayname": null,
      "detaildata": null,
      "ipfsLink": "ipfs://QmfA66piVcujJoSmL1fu1beJS2agvadXbzwv4hX4dnzqWY",
      "gatewayLink": "https://gw3.easy-ipfs.com/ipfs/QmfA66piVcujJoSmL1fu1beJS2agvadXbzwv4hX4dnzqWY",
      "state": "reserved",
      "minted": false,
      "policyId": null,
      "assetId": null,
      "assetname": null,
      "fingerprint": null,
      "initialMintTxHash": null,
      "series": null,
      "tokenamount": 0,
      "price": null,
      "selldate": null,
      "paymentGatewayLinkForSpecificSale": null
    }
  ]
}
```

Your token will now be processed within the next few moments. If you want to verify that the token is actually minted, please call the following endpoint:

`/v2/GetNftDetailsById`

This endpoint will respond with the state and some more details about the token.



Manual Minting

![](https://pbs.twimg.com/media/FW2V0ACXkAY64eA.jpg:large)

## **Sell already minted tokens via NMKR Pay**

The NMKR Studio API can be used to set up a Secondary Sale of an already minted token.
This allows you to list and sell any Token for a specified price via NMKR Pay.

Please keep in mind that you can only sell tokens that are in your possession.
You will be later asked to lock this token in the smart contract during the listing process.

**API Endpoint**

In order to sell an already minted NFT we need to create a payment transaction with NMKR Studio via the following API endpoint:

`/v2/CreatePaymentTransaction`

**Payload**

The payload to create the payment transaction should be look like the following.
The Authentication token / API Key must be given in the header!
Please replace the <placeholders> (PolicyID, TokenName, Price in Lovelace as integer) with the according information.

```
{
    "projectUid": "176fb45d-bbc9-4d9a-9374-a6efe442874d",
    "paymentTransactionType": "Smartcontract_directsale",
    "customProperties": null,
    "transactionParameters": [
        {
            "tokencount": 1,
            "policyId": "<PolicyId>",
            "tokenname": "<TokenName>"
        }
    ],
    "paymentgatewayParameters": null,
    "decentralParameters": null,
    "auctionParameters": null,
    "directSaleParameters": {
        "priceInLovelace": <Price in Lovelace as integer>
    },
    "customerIpAddress": "0.0.0.0",
    "paymentTransactionNotifications": null,
    "referer": null
}
```

The projectUid in the payload above can be any random UID of any project in NMKR Studio. This is only neccessary to utilize NMKR Pay and is not related to the token that will be listed. To ease the process here, we already added a random Uid.

**Curl example**

```
curl -X 'POST' \
  'https://studio-api.nmkr.io/v2/CreatePaymentTransaction' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer 1ac2cb0abea146xyzxyz8a90701dad311c' \
  -H 'Content-Type: application/json' \
  -d '{
    "projectUid": "176fb45d-bbc9-4d9a-9374-a6efe442874d",
    "paymentTransactionType": "Smartcontract_directsale",
    "customProperties": null,
    "transactionParameters": [
        {
            "tokencount": 1,
            "policyId": "63cb7af8c980f0867940e765f36fa53ac948d9af51179742291a553e",
            "tokenname": "0001"
        }
    ],
    "paymentgatewayParameters": null,
    "decentralParameters": null,
    "auctionParameters": null,
    "directSaleParameters": {
        "priceInLovelace": 123000000
    },
    "customerIpAddress": "0.0.0.0",
    "paymentTransactionNotifications": null,
    "referer": null
}'
```

**Response**

You will now receive the following response, where the <Placeholders> will be automatically replaced by NMKR Studio. Please copy the <paymentTransactionUid> for the next step.


```
{
  "paymentTransactionUid": "<paymentTransactionUid>",
  "projectUid": "<NMKR Studio Project Id>",
  "paymentTransactionType": "smartcontract_directsale",
  "customProperties": {},
  "state": "prepared",
  "transactionParameters": [
    {
      "tokencount": 1,
      "policyId": "<PolicyId>",
      "tokenname": "<TokenName in hex format>"
    }
  ],
  "paymentTransactionCreated": "<Creation Date and Time>",
  "paymentgatewayResults": null,
  "paymentTransactionSubStateResult": {
    "paymentTransactionSubstate": "waitingforlocknft",
    "lastTxHash": null
  },
  "auctionResults": null,
  "directSaleResults": {
    "sellingPrice": <Selling price in Lovelace as integer>,
    "marketplaceAmount": <<Market place fee in Lovelace as integer>,
    "sellerAmount": <Seller amount Price in Lovelace as integer>,
    "royaltyAmount": <Royalty amount in Lovelace as integer>,
    "additionalPayoutAmount": null,
    "lockedInAmount": <Locked in amount in Lovelace as integer>,
    "sellerAddress": null,
    "buyerAddress": null,
    "sellerTxHash": null,
    "sellerTxCreate": null
  },
  "decentralParameters": null,
  "mintAndSendResults": null,
  "cbor": null,
  "signedCbor": null,
  "expires": null,
  "signGuid": null,
  "fee": null,json
  "txHash": null
}
```

**Generate NMKR Pay Links**

The NMKR Pay links for the listing, as well as the sales can now be generated with the <paymentTransactionUid> that was given in the previous response.

**NMKR Pay link for Listing**

Replace the <paymentTransactionUid> with the value that was given in the [response](https://docs.nmkr.io/nmkr-studio-api/api-examples/smart-contract/secondary-sales-via-nmkr-pay#response).

`https://pay.nmkr.io/?adsid=<paymentTransactionUid>&a=list`

You can now use this link to list your token on the smart contract by signing the transaction via NMKR Pay.

The unlisting feature is currently being developed.

**NMKR Pay link for Sales**

Replace the <paymentTransactionUid> with the value that was given in the [response](https://docs.nmkr.io/nmkr-studio-api/api-examples/smart-contract/secondary-sales-via-nmkr-pay#response).

`https://pay.nmkr.io/?adsid=<paymentTransactionUid>&a=manage`

This link can be used to cancel the token listing once the token was listed in the smart contract.
The token will be sent back to the wallet.

A listing can only be cancelled from the wallet that was used for the listing.

Secondary Sales via NMKR Pay

![](https://pbs.twimg.com/media/FW2V0ACXkAY64eA.jpg:large)

## **API Open Source Contributions**

In this topic we collect valuable external ressources that utilize our API

**Unity Component for the NMKR API** 

Nmkr.cs by [Davide Lucchesi](https://twitter.com/studiomalaka) is a component that helps to access the NMKR Studio API from Unity.
It implements all the current endpoints and schemas as documented at the official API swagger.

[GitHub - Odiobill/Nmkr: The simplest way to use the Nmkr-Studio API from Unity](https://github.com/Odiobill/Nmkr)


**Get your resource added here**

If you also have some valuable contributions that use our API and you want to see shared with the  community, please reach out to us via support@nmkr.io. 
Thank you! 

API Open Source Contributions

The NMKR Studio API (Application Programming Interface) allows you to implement the features from NMKR Studio to your own website or DApp. 

The API works similarly to other API’s, whereby you are able to utilise the HTTP Get and Post Requests to invoke our Server-Side code to run methods.

The API essentially provides all the functionality we offer in NMKR Studio, through a programmatic interface. Everything from uploading your NFTs, to providing a Payment Link for NMKR Pay, setting up whitelists, can be done via the API.

If you are looking to do something more advanced or simply prefer using code rather than a user interface, the API might be the right solution for you. 

NMKR Studio API

Course Details

Level

Ratings

Modules

Lessons

Holder $WORK Price

Contact Us

Documentation

Navigation