metadata

AddContractsToTokenDirectory

SecurityApiKeyAuth

Request

Request Body schema: application/json

	Array of objects (ContractInfo) []ContractInfo
featureIndexes	Array of numbers []uint8

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Admin/AddContractsToTokenDirectory

Request samples

Payload
curl

application/json

{"contracts": [{"address": "string",
"bytecodeHash": "string",
"chainId": 0,
"contentHash": 0,
"decimals": 0,
"deployed": true,
"extensions": {"blacklist": true,
"description": "string",
"featured": true,
"link": "string",
"ogImage": "string",
"ogName": "string",
"originAddress": "string",
"originChainId": 0,
"verified": true,
"verifiedBy": "string"
},
"logoURI": "string",
"name": "string",
"symbol": "string",
"type": "string",
"updatedAt": "string"
}
],
"featureIndexes": [0
]
}

Response samples

application/json

{"ok": true
}

GetFeatureIndex

SecurityApiKeyAuth

Request

Request Body schema: application/json

chainHandle	string
contractAddress	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Admin/GetFeatureIndex

Request samples

Payload
curl

application/json

{"chainHandle": "string",
"contractAddress": "string"
}

Response samples

application/json

{"featured": 0
}

ListTokenDirectory

SecurityApiKeyAuth

Request

Request Body schema: application/json

chainID	number
includeTestnets	boolean
onlyFeatured	boolean
	object (Page)

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Admin/ListTokenDirectory

Request samples

Payload
curl

application/json

{"chainID": 0,
"includeTestnets": true,
"onlyFeatured": true,
"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
}
}

Response samples

application/json

{"collections": [{"address": "string",
"bytecodeHash": "string",
"chainId": 0,
"contentHash": 0,
"decimals": 0,
"deployed": true,
"extensions": {"blacklist": true,
"description": "string",
"featured": true,
"link": "string",
"ogImage": "string",
"ogName": "string",
"originAddress": "string",
"originChainId": 0,
"verified": true,
"verifiedBy": "string"
},
"logoURI": "string",
"name": "string",
"symbol": "string",
"type": "string",
"updatedAt": "string"
}
],
"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
}
}

ModifyFeatureIndex

SecurityApiKeyAuth

Request

Request Body schema: application/json

chainHandle	string
contractAddress	string
featured	number

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Admin/ModifyFeatureIndex

Request samples

Payload
curl

application/json

{"chainHandle": "string",
"contractAddress": "string",
"featured": 0
}

Response samples

application/json

{"ok": true
}

RemoveContractsFromTokenDirectory

SecurityApiKeyAuth

Request

Request Body schema: application/json

chainHandle	string
contracts	Array of strings []string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Admin/RemoveContractsFromTokenDirectory

Request samples

Payload
curl

application/json

{"chainHandle": "string",
"contracts": ["string"
]
}

Response samples

application/json

{"ok": true
}

CreateAsset

SecurityApiKeyAuth

Request

Request Body schema: application/json

	object (Asset)
projectId	number

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Collections/CreateAsset

Request samples

Payload
curl

application/json

{"asset": {"collectionId": 0,
"filename": "string",
"filesize": 0,
"height": 0,
"id": 0,
"metadataField": "string",
"mimeType": "string",
"tokenId": "string",
"updatedAt": "string",
"url": "string",
"width": 0
},
"projectId": 0
}

Response samples

application/json

{"asset": {"collectionId": 0,
"filename": "string",
"filesize": 0,
"height": 0,
"id": 0,
"metadataField": "string",
"mimeType": "string",
"tokenId": "string",
"updatedAt": "string",
"url": "string",
"width": 0
}
}

CreateCollection

NOTE: projectID is optional. If it's passed it will be used, otherwise the projectID will be retrieved based on the X-Access-Key. As well, user's still need to pass Authorization header for the user's auth. For more information see: https://github.com/0xsequence/builder/tree/master/api#sequence-stack-and-user-project-permissions

SecurityApiKeyAuth

Request

Request Body schema: application/json

	object (Collection)
projectId	number

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Collections/CreateCollection

Request samples

Payload
curl

application/json

{"collection": {"assets": [{"collectionId": 0,
"filename": "string",
"filesize": 0,
"height": 0,
"id": 0,
"metadataField": "string",
"mimeType": "string",
"tokenId": "string",
"updatedAt": "string",
"url": "string",
"width": 0
}
],
"baseURIs": {"contractMetadataURI": "string",
"tokenMetadataURI": "string"
},
"createdAt": "string",
"deletedAt": "string",
"id": 0,
"metadata": {"attributes": [{"property1": { },
"property2": { }
}
],
"description": "string",
"externalLink": "string",
"image": "string",
"name": "string",
"properties": {"property1": { },
"property2": { }
}
},
"private": true,
"projectId": 0,
"revealKey": "string",
"updatedAt": "string"
},
"projectId": 0
}

Response samples

application/json

{"collection": {"assets": [{"collectionId": 0,
"filename": "string",
"filesize": 0,
"height": 0,
"id": 0,
"metadataField": "string",
"mimeType": "string",
"tokenId": "string",
"updatedAt": "string",
"url": "string",
"width": 0
}
],
"baseURIs": {"contractMetadataURI": "string",
"tokenMetadataURI": "string"
},
"createdAt": "string",
"deletedAt": "string",
"id": 0,
"metadata": {"attributes": [{"property1": { },
"property2": { }
}
],
"description": "string",
"externalLink": "string",
"image": "string",
"name": "string",
"properties": {"property1": { },
"property2": { }
}
},
"private": true,
"projectId": 0,
"revealKey": "string",
"updatedAt": "string"
}
}

CreateContractCollection

SecurityApiKeyAuth

Request

Request Body schema: application/json

	object (ContractCollection)
projectId	number

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Collections/CreateContractCollection

Request samples

Payload
curl

application/json

{"contractCollection": {"chainId": 0,
"collectionId": 0,
"contractAddress": "string",
"id": 0
},
"projectId": 0
}

Response samples

application/json

{"contractCollection": {"chainId": 0,
"collectionId": 0,
"contractAddress": "string",
"id": 0
}
}

CreateToken

SecurityApiKeyAuth

Request

Request Body schema: application/json

collectionId	number
private	boolean
projectId	number
	object (TokenMetadata)

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Collections/CreateToken

Request samples

Payload
curl

application/json

{"collectionId": 0,
"private": true,
"projectId": 0,
"token": {"animationUrl": "string",
"assets": [{"collectionId": 0,
"filename": "string",
"filesize": 0,
"height": 0,
"id": 0,
"metadataField": "string",
"mimeType": "string",
"tokenId": "string",
"updatedAt": "string",
"url": "string",
"width": 0
}
],
"attributes": [{"property1": { },
"property2": { }
}
],
"audio": "string",
"backgroundColor": "string",
"decimals": 0,
"description": "string",
"externalUrl": "string",
"image": "string",
"imageData": "string",
"name": "string",
"properties": {"property1": { },
"property2": { }
},
"tokenId": "string",
"updatedAt": "string",
"video": "string"
}
}

Response samples

application/json

{"assets": [{"collectionId": 0,
"filename": "string",
"filesize": 0,
"height": 0,
"id": 0,
"metadataField": "string",
"mimeType": "string",
"tokenId": "string",
"updatedAt": "string",
"url": "string",
"width": 0
}
],
"token": {"animationUrl": "string",
"assets": [{"collectionId": 0,
"filename": "string",
"filesize": 0,
"height": 0,
"id": 0,
"metadataField": "string",
"mimeType": "string",
"tokenId": "string",
"updatedAt": "string",
"url": "string",
"width": 0
}
],
"attributes": [{"property1": { },
"property2": { }
}
],
"audio": "string",
"backgroundColor": "string",
"decimals": 0,
"description": "string",
"externalUrl": "string",
"image": "string",
"imageData": "string",
"name": "string",
"properties": {"property1": { },
"property2": { }
},
"tokenId": "string",
"updatedAt": "string",
"video": "string"
}
}

DeleteAsset

SecurityApiKeyAuth

Request

Request Body schema: application/json

assetId	number
projectId	number

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Collections/DeleteAsset

Request samples

Payload
curl

application/json

{"assetId": 0,
"projectId": 0
}

Response samples

application/json

{"status": true
}

DeleteCollection

SecurityApiKeyAuth

Request

Request Body schema: application/json

collectionId	number
projectId	number

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Collections/DeleteCollection

Request samples

Payload
curl

application/json

{"collectionId": 0,
"projectId": 0
}

Response samples

application/json

{"status": true
}

DeleteContractCollection

SecurityApiKeyAuth

Request

Request Body schema: application/json

chainId	number
contractAddress	string
projectId	number

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Collections/DeleteContractCollection

Request samples

Payload
curl

application/json

{"chainId": 0,
"contractAddress": "string",
"projectId": 0
}

Response samples

application/json

{"ok": true
}

DeleteToken

SecurityApiKeyAuth

Request

Request Body schema: application/json

collectionId	number
projectId	number
tokenId	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Collections/DeleteToken

Request samples

Payload
curl

application/json

{"collectionId": 0,
"projectId": 0,
"tokenId": "string"
}

Response samples

application/json

{"status": true
}

GetAsset

SecurityApiKeyAuth

Request

Request Body schema: application/json

assetId	number
projectId	number

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Collections/GetAsset

Request samples

Payload
curl

application/json

{"assetId": 0,
"projectId": 0
}

Response samples

application/json

{"asset": {"collectionId": 0,
"filename": "string",
"filesize": 0,
"height": 0,
"id": 0,
"metadataField": "string",
"mimeType": "string",
"tokenId": "string",
"updatedAt": "string",
"url": "string",
"width": 0
}
}

GetCollection

SecurityApiKeyAuth

Request

Request Body schema: application/json

collectionId	number
projectId	number

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Collections/GetCollection

Request samples

Payload
curl

application/json

{"collectionId": 0,
"projectId": 0
}

Response samples

application/json

{"collection": {"assets": [{"collectionId": 0,
"filename": "string",
"filesize": 0,
"height": 0,
"id": 0,
"metadataField": "string",
"mimeType": "string",
"tokenId": "string",
"updatedAt": "string",
"url": "string",
"width": 0
}
],
"baseURIs": {"contractMetadataURI": "string",
"tokenMetadataURI": "string"
},
"createdAt": "string",
"deletedAt": "string",
"id": 0,
"metadata": {"attributes": [{"property1": { },
"property2": { }
}
],
"description": "string",
"externalLink": "string",
"image": "string",
"name": "string",
"properties": {"property1": { },
"property2": { }
}
},
"private": true,
"projectId": 0,
"revealKey": "string",
"updatedAt": "string"
}
}

GetContractCollection

SecurityApiKeyAuth

Request

Request Body schema: application/json

chainId	number
contractAddress	string
projectId	number

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Collections/GetContractCollection

Request samples

Payload
curl

application/json

{"chainId": 0,
"contractAddress": "string",
"projectId": 0
}

Response samples

application/json

{"contractCollection": {"chainId": 0,
"collectionId": 0,
"contractAddress": "string",
"id": 0
}
}

GetToken

SecurityApiKeyAuth

Request

Request Body schema: application/json

collectionId	number
projectId	number
tokenId	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Collections/GetToken

Request samples

Payload
curl

application/json

{"collectionId": 0,
"projectId": 0,
"tokenId": "string"
}

Response samples

application/json

{"assets": [{"collectionId": 0,
"filename": "string",
"filesize": 0,
"height": 0,
"id": 0,
"metadataField": "string",
"mimeType": "string",
"tokenId": "string",
"updatedAt": "string",
"url": "string",
"width": 0
}
],
"token": {"animationUrl": "string",
"assets": [{"collectionId": 0,
"filename": "string",
"filesize": 0,
"height": 0,
"id": 0,
"metadataField": "string",
"mimeType": "string",
"tokenId": "string",
"updatedAt": "string",
"url": "string",
"width": 0
}
],
"attributes": [{"property1": { },
"property2": { }
}
],
"audio": "string",
"backgroundColor": "string",
"decimals": 0,
"description": "string",
"externalUrl": "string",
"image": "string",
"imageData": "string",
"name": "string",
"properties": {"property1": { },
"property2": { }
},
"tokenId": "string",
"updatedAt": "string",
"video": "string"
}
}

ListCollections

SecurityApiKeyAuth

Request

Request Body schema: application/json

	object (Page)
projectId	number

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Collections/ListCollections

Request samples

Payload
curl

application/json

{"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
},
"projectId": 0
}

Response samples

application/json

{"collections": [{"assets": [{"collectionId": 0,
"filename": "string",
"filesize": 0,
"height": 0,
"id": 0,
"metadataField": "string",
"mimeType": "string",
"tokenId": "string",
"updatedAt": "string",
"url": "string",
"width": 0
}
],
"baseURIs": {"contractMetadataURI": "string",
"tokenMetadataURI": "string"
},
"createdAt": "string",
"deletedAt": "string",
"id": 0,
"metadata": {"attributes": [{"property1": { },
"property2": { }
}
],
"description": "string",
"externalLink": "string",
"image": "string",
"name": "string",
"properties": {"property1": { },
"property2": { }
}
},
"private": true,
"projectId": 0,
"revealKey": "string",
"updatedAt": "string"
}
],
"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
}
}

ListContractCollections

SecurityApiKeyAuth

Request

Request Body schema: application/json

collectionId	number
	object (Page)
projectId	number

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Collections/ListContractCollections

Request samples

Payload
curl

application/json

{"collectionId": 0,
"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
},
"projectId": 0
}

Response samples

application/json

{"contractCollections": [{"chainId": 0,
"collectionId": 0,
"contractAddress": "string",
"id": 0
}
],
"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
}
}

ListTokens

SecurityApiKeyAuth

Request

Request Body schema: application/json

collectionId	number
	object (Page)
projectId	number

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Collections/ListTokens

Request samples

Payload
curl

application/json

{"collectionId": 0,
"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
},
"projectId": 0
}

Response samples

application/json

{"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
},
"tokens": [{"animationUrl": "string",
"assets": [{"collectionId": 0,
"filename": "string",
"filesize": 0,
"height": 0,
"id": 0,
"metadataField": "string",
"mimeType": "string",
"tokenId": "string",
"updatedAt": "string",
"url": "string",
"width": 0
}
],
"attributes": [{"property1": { },
"property2": { }
}
],
"audio": "string",
"backgroundColor": "string",
"decimals": 0,
"description": "string",
"externalUrl": "string",
"image": "string",
"imageData": "string",
"name": "string",
"properties": {"property1": { },
"property2": { }
},
"tokenId": "string",
"updatedAt": "string",
"video": "string"
}
]
}

PublishCollection

SecurityApiKeyAuth

Request

Request Body schema: application/json

collectionId	number
projectId	number
recursive	boolean

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Collections/PublishCollection

Request samples

Payload
curl

application/json

{"collectionId": 0,
"projectId": 0,
"recursive": true
}

Response samples

application/json

{"collection": {"assets": [{"collectionId": 0,
"filename": "string",
"filesize": 0,
"height": 0,
"id": 0,
"metadataField": "string",
"mimeType": "string",
"tokenId": "string",
"updatedAt": "string",
"url": "string",
"width": 0
}
],
"baseURIs": {"contractMetadataURI": "string",
"tokenMetadataURI": "string"
},
"createdAt": "string",
"deletedAt": "string",
"id": 0,
"metadata": {"attributes": [{"property1": { },
"property2": { }
}
],
"description": "string",
"externalLink": "string",
"image": "string",
"name": "string",
"properties": {"property1": { },
"property2": { }
}
},
"private": true,
"projectId": 0,
"revealKey": "string",
"updatedAt": "string"
}
}

UnpublishCollection

SecurityApiKeyAuth

Request

Request Body schema: application/json

collectionId	number
projectId	number

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Collections/UnpublishCollection

Request samples

Payload
curl

application/json

{"collectionId": 0,
"projectId": 0
}

Response samples

application/json

{"collection": {"assets": [{"collectionId": 0,
"filename": "string",
"filesize": 0,
"height": 0,
"id": 0,
"metadataField": "string",
"mimeType": "string",
"tokenId": "string",
"updatedAt": "string",
"url": "string",
"width": 0
}
],
"baseURIs": {"contractMetadataURI": "string",
"tokenMetadataURI": "string"
},
"createdAt": "string",
"deletedAt": "string",
"id": 0,
"metadata": {"attributes": [{"property1": { },
"property2": { }
}
],
"description": "string",
"externalLink": "string",
"image": "string",
"name": "string",
"properties": {"property1": { },
"property2": { }
}
},
"private": true,
"projectId": 0,
"revealKey": "string",
"updatedAt": "string"
}
}

UpdateAsset

SecurityApiKeyAuth

Request

Request Body schema: application/json

	object (Asset)
projectId	number

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Collections/UpdateAsset

Request samples

Payload
curl

application/json

{"asset": {"collectionId": 0,
"filename": "string",
"filesize": 0,
"height": 0,
"id": 0,
"metadataField": "string",
"mimeType": "string",
"tokenId": "string",
"updatedAt": "string",
"url": "string",
"width": 0
},
"projectId": 0
}

Response samples

application/json

{"asset": {"collectionId": 0,
"filename": "string",
"filesize": 0,
"height": 0,
"id": 0,
"metadataField": "string",
"mimeType": "string",
"tokenId": "string",
"updatedAt": "string",
"url": "string",
"width": 0
}
}

UpdateCollection

SecurityApiKeyAuth

Request

Request Body schema: application/json

	object (Collection)
projectId	number

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Collections/UpdateCollection

Request samples

Payload
curl

application/json

{"collection": {"assets": [{"collectionId": 0,
"filename": "string",
"filesize": 0,
"height": 0,
"id": 0,
"metadataField": "string",
"mimeType": "string",
"tokenId": "string",
"updatedAt": "string",
"url": "string",
"width": 0
}
],
"baseURIs": {"contractMetadataURI": "string",
"tokenMetadataURI": "string"
},
"createdAt": "string",
"deletedAt": "string",
"id": 0,
"metadata": {"attributes": [{"property1": { },
"property2": { }
}
],
"description": "string",
"externalLink": "string",
"image": "string",
"name": "string",
"properties": {"property1": { },
"property2": { }
}
},
"private": true,
"projectId": 0,
"revealKey": "string",
"updatedAt": "string"
},
"projectId": 0
}

Response samples

application/json

{"collection": {"assets": [{"collectionId": 0,
"filename": "string",
"filesize": 0,
"height": 0,
"id": 0,
"metadataField": "string",
"mimeType": "string",
"tokenId": "string",
"updatedAt": "string",
"url": "string",
"width": 0
}
],
"baseURIs": {"contractMetadataURI": "string",
"tokenMetadataURI": "string"
},
"createdAt": "string",
"deletedAt": "string",
"id": 0,
"metadata": {"attributes": [{"property1": { },
"property2": { }
}
],
"description": "string",
"externalLink": "string",
"image": "string",
"name": "string",
"properties": {"property1": { },
"property2": { }
}
},
"private": true,
"projectId": 0,
"revealKey": "string",
"updatedAt": "string"
}
}

UpdateContractCollection

SecurityApiKeyAuth

Request

Request Body schema: application/json

	object (ContractCollection)
projectId	number

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Collections/UpdateContractCollection

Request samples

Payload
curl

application/json

{"contractCollection": {"chainId": 0,
"collectionId": 0,
"contractAddress": "string",
"id": 0
},
"projectId": 0
}

Response samples

application/json

{"ok": true
}

UpdateToken

SecurityApiKeyAuth

Request

Request Body schema: application/json

collectionId	number
private	boolean
projectId	number
	object (TokenMetadata)
tokenId	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Collections/UpdateToken

Request samples

Payload
curl

application/json

{"collectionId": 0,
"private": true,
"projectId": 0,
"token": {"animationUrl": "string",
"assets": [{"collectionId": 0,
"filename": "string",
"filesize": 0,
"height": 0,
"id": 0,
"metadataField": "string",
"mimeType": "string",
"tokenId": "string",
"updatedAt": "string",
"url": "string",
"width": 0
}
],
"attributes": [{"property1": { },
"property2": { }
}
],
"audio": "string",
"backgroundColor": "string",
"decimals": 0,
"description": "string",
"externalUrl": "string",
"image": "string",
"imageData": "string",
"name": "string",
"properties": {"property1": { },
"property2": { }
},
"tokenId": "string",
"updatedAt": "string",
"video": "string"
},
"tokenId": "string"
}

Response samples

application/json

{"token": {"animationUrl": "string",
"assets": [{"collectionId": 0,
"filename": "string",
"filesize": 0,
"height": 0,
"id": 0,
"metadataField": "string",
"mimeType": "string",
"tokenId": "string",
"updatedAt": "string",
"url": "string",
"width": 0
}
],
"attributes": [{"property1": { },
"property2": { }
}
],
"audio": "string",
"backgroundColor": "string",
"decimals": 0,
"description": "string",
"externalUrl": "string",
"image": "string",
"imageData": "string",
"name": "string",
"properties": {"property1": { },
"property2": { }
},
"tokenId": "string",
"updatedAt": "string",
"video": "string"
}
}

AbortContractSync

SecurityApiKeyAuth

Request

Request Body schema: application/json

taskID

number

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Metadata/AbortContractSync

Request samples

Payload
curl

application/json

{"taskID": 0
}

Response samples

application/json

{"ok": true
}

AddContractToMintMonitor

SecurityApiKeyAuth

Request

Request Body schema: application/json

chainID	string
contractAddress	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Metadata/AddContractToMintMonitor

Request samples

Payload
curl

application/json

{"chainID": "string",
"contractAddress": "string"
}

Response samples

application/json

{"ok": true
}

CancelRefreshJob

SecurityApiKeyAuth

Request

Request Body schema: application/json

taskId

number

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Metadata/CancelRefreshJob

Request samples

Payload
curl

application/json

{"taskId": 0
}

Response samples

application/json

{"ok": true
}

ContractSyncJobStatus

SecurityApiKeyAuth

Request

Request Body schema: application/json

taskID

number

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Metadata/ContractSyncJobStatus

Request samples

Payload
curl

application/json

{"taskID": 0
}

Response samples

application/json

{"refreshTask": {"createdAt": "string",
"hash": "string",
"id": 0,
"lastRanAt": "string",
"payload": ["string"
],
"queue": "string",
"runAt": "string",
"status": "PENDING",
"try": 0
},
"syncTask": {"createdAt": "string",
"hash": "string",
"id": 0,
"lastRanAt": "string",
"payload": ["string"
],
"queue": "string",
"runAt": "string",
"status": "PENDING",
"try": 0
}
}

DirectoryGetCollections

SecurityApiKeyAuth

Request

Request Body schema: application/json

chainId	number
includeTestnets	boolean
onlyFeatured	boolean
	object (Page)

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Metadata/DirectoryGetCollections

Request samples

Payload
curl

application/json

{"chainId": 0,
"includeTestnets": true,
"onlyFeatured": true,
"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
}
}

Response samples

application/json

{"collections": [{"address": "string",
"bytecodeHash": "string",
"chainId": 0,
"contentHash": 0,
"decimals": 0,
"deployed": true,
"extensions": {"blacklist": true,
"description": "string",
"featured": true,
"link": "string",
"ogImage": "string",
"ogName": "string",
"originAddress": "string",
"originChainId": 0,
"verified": true,
"verifiedBy": "string"
},
"logoURI": "string",
"name": "string",
"symbol": "string",
"type": "string",
"updatedAt": "string"
}
],
"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
}
}

DirectoryGetNetworks

Token Directory. NOTE: this only searches the 'token-directory' items. Use 'SearchContracts' or 'SearchTokens' for everything else.

SecurityApiKeyAuth

Request

Request Body schema: application/json

includeTestnets	boolean
onlyFeatured	boolean

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Metadata/DirectoryGetNetworks

Request samples

Payload
curl

application/json

{"includeTestnets": true,
"onlyFeatured": true
}

Response samples

application/json

{"networks": [0
]
}

DirectorySearchCollections

SecurityApiKeyAuth

Request

Request Body schema: application/json

chainId	number
includeTestnets	boolean
onlyFeatured	boolean
	object (Page)
query	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Metadata/DirectorySearchCollections

Request samples

Payload
curl

application/json

{"chainId": 0,
"includeTestnets": true,
"onlyFeatured": true,
"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
},
"query": "string"
}

Response samples

application/json

{"collections": [{"address": "string",
"bytecodeHash": "string",
"chainId": 0,
"contentHash": 0,
"decimals": 0,
"deployed": true,
"extensions": {"blacklist": true,
"description": "string",
"featured": true,
"link": "string",
"ogImage": "string",
"ogName": "string",
"originAddress": "string",
"originChainId": 0,
"verified": true,
"verifiedBy": "string"
},
"logoURI": "string",
"name": "string",
"symbol": "string",
"type": "string",
"updatedAt": "string"
}
],
"page": {"after": { },
"before": { },
"column": "string",
"more": true,
"page": 0,
"pageSize": 0,
"sort": [{"column": "string",
"order": "DESC"
}
],
"totalRecords": 0
}
}

EnqueueTokensForRefresh

SecurityApiKeyAuth

Request

Request Body schema: application/json

chainID	string
contractAddress	string
refreshAll	boolean
tokenIDs	Array of strings []string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Metadata/EnqueueTokensForRefresh

Request samples

Payload
curl

application/json

{"chainID": "string",
"contractAddress": "string",
"refreshAll": true,
"tokenIDs": ["string"
]
}

Response samples

application/json

{"taskId": 0
}

GetContractInfo

Contract Info -- returns contract meta-info for contracts found in registered chain's token-lists

SecurityApiKeyAuth

Request

Request Body schema: application/json

chainID	string
contractAddress	string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Metadata/GetContractInfo

Request samples

Payload
curl

application/json

{"chainID": "string",
"contractAddress": "string"
}

Response samples

application/json

{"contractInfo": {"address": "string",
"bytecodeHash": "string",
"chainId": 0,
"contentHash": 0,
"decimals": 0,
"deployed": true,
"extensions": {"blacklist": true,
"description": "string",
"featured": true,
"link": "string",
"ogImage": "string",
"ogName": "string",
"originAddress": "string",
"originChainId": 0,
"verified": true,
"verifiedBy": "string"
},
"logoURI": "string",
"name": "string",
"symbol": "string",
"type": "string",
"updatedAt": "string"
}
}

GetContractInfoBatch

SecurityApiKeyAuth

Request

Request Body schema: application/json

chainID	string
contractAddresses	Array of strings []string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Metadata/GetContractInfoBatch

Request samples

Payload
curl

application/json

{"chainID": "string",
"contractAddresses": ["string"
]
}

Response samples

application/json

{"contractInfoMap": {"property1": {"address": "string",
"bytecodeHash": "string",
"chainId": 0,
"contentHash": 0,
"decimals": 0,
"deployed": true,
"extensions": {"blacklist": true,
"description": "string",
"featured": true,
"link": "string",
"ogImage": "string",
"ogName": "string",
"originAddress": "string",
"originChainId": 0,
"verified": true,
"verifiedBy": "string"
},
"logoURI": "string",
"name": "string",
"symbol": "string",
"type": "string",
"updatedAt": "string"
},
"property2": {"address": "string",
"bytecodeHash": "string",
"chainId": 0,
"contentHash": 0,
"decimals": 0,
"deployed": true,
"extensions": {"blacklist": true,
"description": "string",
"featured": true,
"link": "string",
"ogImage": "string",
"ogName": "string",
"originAddress": "string",
"originChainId": 0,
"verified": true,
"verifiedBy": "string"
},
"logoURI": "string",
"name": "string",
"symbol": "string",
"type": "string",
"updatedAt": "string"
}
}
}

GetNiftyswapTokenQuantity

Niftyswap querying data map of tokenID :: quantity

SecurityApiKeyAuth

Request

Request Body schema: application/json

chainID	string
contractAddress	string
tokenIDs	Array of strings []string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Metadata/GetNiftyswapTokenQuantity

Request samples

Payload
curl

application/json

{"chainID": "string",
"contractAddress": "string",
"tokenIDs": ["string"
]
}

Response samples

application/json

{"quantity": {"property1": "string",
"property2": "string"
}
}

GetNiftyswapUnitPrices

map of tokenID :: price

SecurityApiKeyAuth

Request

Request Body schema: application/json

chainID	string
contractAddress	string
fresh	boolean
	object (GetNiftyswapUnitPricesRequest)

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Metadata/GetNiftyswapUnitPrices

Request samples

Payload
curl

application/json

{"chainID": "string",
"contractAddress": "string",
"fresh": true,
"req": {"amounts": ["string"
],
"ids": ["string"
],
"swapType": "UNKNOWN"
}
}

Response samples

application/json

{"prices": {"property1": "string",
"property2": "string"
}
}

GetNiftyswapUnitPricesWithQuantities

SecurityApiKeyAuth

Request

Request Body schema: application/json

chainID	string
contractAddress	string
fresh	boolean
	object (GetNiftyswapUnitPricesRequest)

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Metadata/GetNiftyswapUnitPricesWithQuantities

Request samples

Payload
curl

application/json

{"chainID": "string",
"contractAddress": "string",
"fresh": true,
"req": {"amounts": ["string"
],
"ids": ["string"
],
"swapType": "UNKNOWN"
}
}

Response samples

application/json

{"prices": {"property1": {"availableAmount": "string",
"unitAmount": "string",
"unitPrice": "string"
},
"property2": {"availableAmount": "string",
"unitAmount": "string",
"unitPrice": "string"
}
}
}

GetTokenMetadata

GetTokenMetadata - fetch token metadata for a particular contract and respective tokenIDs

SecurityApiKeyAuth

Request

Request Body schema: application/json

chainID	string
contractAddress	string
tokenIDs	Array of strings []string

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Metadata/GetTokenMetadata

Request samples

Payload
curl

application/json

{"chainID": "string",
"contractAddress": "string",
"tokenIDs": ["string"
]
}

Response samples

application/json

{"tokenMetadata": [{"animationUrl": "string",
"assets": [{"collectionId": 0,
"filename": "string",
"filesize": 0,
"height": 0,
"id": 0,
"metadataField": "string",
"mimeType": "string",
"tokenId": "string",
"updatedAt": "string",
"url": "string",
"width": 0
}
],
"attributes": [{"property1": { },
"property2": { }
}
],
"audio": "string",
"backgroundColor": "string",
"decimals": 0,
"description": "string",
"externalUrl": "string",
"image": "string",
"imageData": "string",
"name": "string",
"properties": {"property1": { },
"property2": { }
},
"tokenId": "string",
"updatedAt": "string",
"video": "string"
}
]
}

GetTokenMetadataBatch

GetTokenMetadataBatch allows you to query the token metadata of a batch of contracts and respective tokenIDs where map is contractAddress::[]tokenID => contractAddress::[]TokenMetadata Note, we limit each request to 50 contracts max and 50 tokens max per contract.

SecurityApiKeyAuth

Request

Request Body schema: application/json

chainID	string
	object map<string,[]string>

Responses

200

4XX

Client error

5XX

Server error

post/rpc/Metadata/GetTokenMetadataBatch

Request samples

Payload
curl

application/json

{"chainID": "string",
"contractTokenMap": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

application/json

{"contractTokenMetadata": {"property1": [{"animationUrl": "string",
"assets": [{"collectionId": 0,
"filename": "string",
"filesize": 0,
"height": 0,
"id": 0,
"metadataField": "string",
"mimeType": "string",
"tokenId": "string",
"updatedAt": "string",
"url": "string",
"width": 0
}
],
"attributes": [{"property1": { },
"property2": { }
}
],
"audio": "string",
"backgroundColor": "string",
"decimals": 0,
"description": "string",
"externalUrl": "string",
"image": "string",
"imageData": "string",
"name": "string",
"properties": {"property1": { },
"property2": { }
},
"tokenId": "string",
"updatedAt": "string",
"video": "string"
}
],
"property2": [{"animationUrl": "string",
"assets":