Skip to main content

Create Token by External ID

Create a token association for an external token ID.

Endpoint: POST /api/v1/integration/tokens/external/{external_id}

Authentication: Required (Bearer token)

Required Headers:

Authorization: Bearer <access_token>
X-Target-Server: integration
Content-Type: application/json

Path Parameters

ParameterTypeRequiredDescription
external_idstringYesExternal token ID

Request Body

{
"is_all_market": true,
"market_ids": []
}

Request Parameters

FieldTypeRequiredDescription
is_all_marketbooleanYesWhether to associate the token with all markets
market_idsarray (string)NoArray of market IDs to associate with the token (required if is_all_market is false)

Response

Status: 201 Created

Returns the created token object with full details.

{
"id": "43075f5d-8e7b-4b90-ba44-c85f3d9346d7",
"node_id": "e40efce4-38a3-46c4-a202-e8db95d0409c",
"distributor_id": "084a5159-1546-4ade-a7ba-956e0234a417",
"currency_token_id": "6f75c60f-21cc-419f-b0e9-f75655b9fb6a",
"chain_id": 17000,
"name": "Estimates test",
"description": "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.",
"symbol": "ES",
"value": 0.00044000000000000007,
"supply": 1000000,
"external_id": "693d6f791f8a9198aba44f50",
"contract": {
"address": "0x70f1d2c056bf9f6956d2d2ce045d3db33dee3c05",
"hash": "0x0af2fa067ab8725b44e1a77f8f9702f763e0fe68cc58a3cfd1987c6290fe24e6"
},
"rules": {
"max_purchase_limit": 100,
"min_purchase_limit": 1
},
"status": 2,
"integration": {
"chain_id": 17000,
"abi": "[{\"anonymous\":false,\"inputs\":[{\"indexed\":false,\"internalType\":\"address\",\"name\":\"user\",\"type\":\"address\"},{\"indexed\":false,\"internalType\":\"address\",\"name\":\"house\",\"type\":\"address\"},{\"indexed\":false,\"internalType\":\"address\",\"name\":\"payment\",\"type\":\"address\"},{\"indexed\":false,\"internalType\":\"uint256\",\"name\":\"price\",\"type\":\"uint256\"},{\"indexed\":false,\"internalType\":\"uint256\",\"name\":\"count\",\"type\":\"uint256\"},{\"indexed\":false,\"internalType\":\"uint256\",\"name\":\"timestamp\",\"type\":\"uint256\"}],\"name\":\"ListEvent\",\"type\":\"event\"},{\"anonymous\":false,\"inputs\":[{\"indexed\":false,\"internalType\":\"address\",\"name\":\"user\",\"type\":\"address\"},{\"indexed\":false,\"internalType\":\"address\",\"name\":\"house\",\"type\":\"address\"},{\"indexed\":false,\"internalType\":\"address\",\"name\":\"payment\",\"type\":\"address\"},{\"indexed\":false,\"internalType\":\"uint256\",\"name\":\"price\",\"type\":\"uint256\"},{\"indexed\":false,\"internalType\":\"uint256\",\"name\":\"count\",\"type\":\"uint256\"},{\"indexed\":false,\"internalType\":\"uint256\",\"name\":\"timestamp\",\"type\":\"uint256\"}],\"name\":\"ListingBuyEvent\",\"type\":\"event\"},{\"anonymous\":false,\"inputs\":[{\"indexed\":false,\"internalType\":\"address\",\"name\":\"user\",\"type\":\"address\"},{\"indexed\":false,\"internalType\":\"address\",\"name\":\"house\",\"type\":\"address\"},{\"indexed\":false,\"internalType\":\"uint256\",\"name\":\"timestamp\",\"type\":\"uint256\"}],\"name\":\"ListingDelistEvent\",\"type\":\"event\"},{\"anonymous\":false,\"inputs\":[{\"indexed\":false,\"internalType\":\"address\",\"name\":\"user\",\"type\":\"address\"},{\"indexed\":false,\"internalType\":\"address\",\"name\":\"house\",\"type\":\"address\"},{\"indexed\":false,\"internalType\":\"uint256\",\"name\":\"newPrice\",\"type\":\"uint256\"},{\"indexed\":false,\"internalType\":\"uint256\",\"name\":\"minbuycount\",\"type\":\"uint256\"},{\"indexed\":false,\"internalType\":\"uint256\",\"name\":\"maxbuycount\",\"type\":\"uint256\"},{\"indexed\":false,\"internalType\":\"uint256\",\"name\":\"tokenAmount\",\"type\":\"uint256\"},{\"indexed\":false,\"internalType\":\"uint256\",\"name\":\"timestamp\",\"type\":\"uint256\"}],\"name\":\"ListingUpdateEvent\",\"type\":\"event\"},{\"inputs\":[{\"internalType\":\"uint256\",\"name\":\"amount\",\"type\":\"uint256\"},{\"internalType\":\"address\",\"name\":\"_houseTokenAddress\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"_paymentToken\",\"type\":\"address\"}],\"name\":\"buy\",\"outputs\":[],\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"address\",\"name\":\"_tokenAddress\",\"type\":\"address\"}],\"name\":\"delist\",\"outputs\":[],\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"address\",\"name\":\"_tokenAddress\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"_paymentToken\",\"type\":\"address\"},{\"internalType\":\"uint256\",\"name\":\"_price\",\"type\":\"uint256\"},{\"internalType\":\"uint256\",\"name\":\"_tokenAmount\",\"type\":\"uint256\"},{\"internalType\":\"uint256\",\"name\":\"_minbuycount\",\"type\":\"uint256\"},{\"internalType\":\"uint256\",\"name\":\"_maxbuycount\",\"type\":\"uint256\"}],\"name\":\"list\",\"outputs\":[],\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"address\",\"name\":\"_tokenAddress\",\"type\":\"address\"},{\"internalType\":\"uint256\",\"name\":\"_newPrice\",\"type\":\"uint256\"},{\"internalType\":\"uint256\",\"name\":\"_minbuycount\",\"type\":\"uint256\"},{\"internalType\":\"uint256\",\"name\":\"_maxbuycount\",\"type\":\"uint256\"},{\"internalType\":\"uint256\",\"name\":\"_tokenAmount\",\"type\":\"uint256\"}],\"name\":\"update\",\"outputs\":[],\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"address\",\"name\":\"_houseTokenAddress\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"_user\",\"type\":\"address\"}],\"name\":\"viewCanHaveMaxAmount\",\"outputs\":[{\"internalType\":\"uint256\",\"name\":\"\",\"type\":\"uint256\"}],\"stateMutability\":\"view\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"address\",\"name\":\"_tokenAddress\",\"type\":\"address\"}],\"name\":\"viewListing\",\"outputs\":[{\"components\":[{\"internalType\":\"address\",\"name\":\"token\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"paymentToken\",\"type\":\"address\"},{\"internalType\":\"uint256\",\"name\":\"price\",\"type\":\"uint256\"},{\"internalType\":\"uint256\",\"name\":\"tokenAmount\",\"type\":\"uint256\"},{\"internalType\":\"uint256\",\"name\":\"minbuycount\",\"type\":\"uint256\"},{\"internalType\":\"uint256\",\"name\":\"maxbuycount\",\"type\":\"uint256\"}],\"internalType\":\"structLibListing.Listing\",\"name\":\"\",\"type\":\"tuple\"}],\"stateMutability\":\"view\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"address\",\"name\":\"_houseTokenAddress\",\"type\":\"address\"},{\"internalType\":\"address\",\"name\":\"_user\",\"type\":\"address\"},{\"internalType\":\"uint256\",\"name\":\"_amount\",\"type\":\"uint256\"}],\"name\":\"viewUserCanBuy\",\"outputs\":[{\"internalType\":\"bool\",\"name\":\"\",\"type\":\"bool\"}],\"stateMutability\":\"view\",\"type\":\"function\"}]",
"contract_address": "0x73E3Bcd355A64a12a0ab9B1E56f33FC214C9a4e8",
"function_name": "buy",
"currency_token_address": "0x32d55702aef0e031f9264f9bbb20b3f89ee57a95",
"is_approved": false,
"args": [
{
"type": "bigint",
"value": "",
"description": "Quantity"
},
{
"type": "address",
"value": "0x70f1d2c056bf9f6956d2d2ce045d3db33dee3c05",
"description": "Token Address"
},
{
"type": "address",
"value": "0x32d55702aef0e031f9264f9bbb20b3f89ee57a95",
"description": "Currency Token Address"
}
]
},
"meta": {
"images": [
{
"id": "2aa8232c-ff92-4df7-ab32-44a4c54289eb",
"url": "https://fra1.digitaloceanspaces.com/apex/test/token/690f1f5325f3e7e1753791e7/images/7516cfa0-d7f9-47aa-85aa-55aaf20ed934.jpeg",
"is_default": true,
"hash": "23823e7ae6f93f7a0e544a0c8608693313e1b480efbcf73bce76de3ff3443fb9",
"created_at": "2025-12-24T09:33:58.035483Z"
},
{
"id": "ec649c60-3366-4c8e-83ab-6a75d390cb42",
"url": "https://fra1.digitaloceanspaces.com/apex/test/token/690f1f5325f3e7e1753791e7/images/7516cfa0-d7f9-47aa-85aa-55aaf20ed934.jpeg",
"is_default": false,
"hash": "23823e7ae6f93f7a0e544a0c8608693313e1b480efbcf73bce76de3ff3443fb9",
"created_at": "2025-12-24T09:33:58.030698Z"
}
],
"documents": [
{
"id": "1e0746ec-6ed2-446a-811f-7b4fc77c4afb",
"name": "İş Portfoy Detaylı Rapor.pdf",
"url": "https://fra1.digitaloceanspaces.com/apex/test/token/690f1f5325f3e7e1753791e7/documents/86ac9576-9d05-4530-b242-5ea3c730ad26.pdf",
"type": 1,
"hash": "124aedd51677d3b24e6f101d17141a16e36c59cc41f1303a30ae6ecd2f055bda",
"created_at": "2025-12-24T09:33:58.032104Z"
},
{
"id": "8ec46223-3822-4deb-9dbc-73df2a09b012",
"name": "İş Portfoy Detaylı Rapor.pdf",
"url": "https://fra1.digitaloceanspaces.com/apex/test/token/690f1f5325f3e7e1753791e7/documents/86ac9576-9d05-4530-b242-5ea3c730ad26.pdf",
"type": 1,
"hash": "124aedd51677d3b24e6f101d17141a16e36c59cc41f1303a30ae6ecd2f055bda",
"created_at": "2025-12-24T09:33:58.036019Z"
}
]
},
"created_at": "2025-12-24T09:33:58.023369Z",
"updated_at": "2025-12-24T09:33:58.023369Z"
}

Example cURL Request

curl -X POST 'https://<base-url>/api/v1/integration/tokens/external/693d6f791f8a9198aba44f50' \
-H "Content-Type: application/json" \
-H "X-Target-Server: integration" \
-H "Authorization: Bearer <access_token>" \
-d '{
"is_all_market": true,
"market_ids": []
}'