Download OpenAPI specification:Download
Documentation to access api powering Roll app by third-party applications. You can find a reference example app implementation here. If you wish to register as a third-party developer on Roll, you can apply here. Error codes can be one as following:
> Possible Error Codes
Invalid Oauth Token: 1001 | HTTP 401
Invalid API Key: 1002 | HTTP 401
Insufficient Permissions: 1003 | HTTP 403
Invalid request body: 1005 | HTTP 400
Invalid request parameter: 1006 | HTTP 400
Record not found: 1004 | HTTP 400
Unexpected error: 1006 | HTTP 500
Retrieve information about the user's balance for a specific token.
userID required | string The ID of the user. |
tokenID required | string The ID of the token. |
amount required | number <double> The amount to check for. |
{- "data": {
- "hasBalance": true
}, - "error": "string"
}
Retrieve token balances for a specific user.
userID required | string The ID of the user. |
{- "data": [
- {
- "token": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "symbol": "string",
- "name": "string",
- "decimals": 0,
- "totalSupply": "string",
- "currentSupply": "string",
- "creatorUserID": "85b9f113-1633-4420-a8f1-38003a290a49"
}, - "value": "string"
}
], - "error": "string"
}
userID required | string The user's unique identifier |
tokenID required | string The token's unique identifier |
{- "data": {
- "token": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "symbol": "string",
- "name": "string",
- "decimals": 0,
- "totalSupply": "string",
- "currentSupply": "string",
- "creatorUserID": "85b9f113-1633-4420-a8f1-38003a290a49"
}, - "value": "string"
}, - "error": "string"
}
Retrieve information about tokens.
symbol | string Filter tokens by symbol. |
limit | integer <int32> Limit the number of tokens to be retrieved. |
offset | integer <int32> Offset for the tokens to be retrieved. |
contractAddress | string Filter tokens by contract address. |
{- "data": {
- "limit": 0,
- "offset": 0,
- "sort": "string",
- "totalRows": 0,
- "rows": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "symbol": "string",
- "decimals": 0,
- "logo": "string",
- "contractAddress": "string",
- "currentSupply": "string",
- "totalSupply": "string"
}
]
}, - "errors": "string"
}
Retrieve information about the creator of a specific token.
tokenID required | string The ID of the token. |
{- "data": {
- "userID": "2c3821b8-1cdb-4b77-bcd8-a1da701e46aa",
- "username": "string",
- "name": "string"
}, - "error": "string"
}
transactionID required | string |
{- "data": {
- "token": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "symbol": "string",
- "name": "string",
- "decimals": 0,
- "totalSupply": "string",
- "currentSupply": "string",
- "creatorUserID": "85b9f113-1633-4420-a8f1-38003a290a49"
}, - "fromUser": {
- "userID": "2c3821b8-1cdb-4b77-bcd8-a1da701e46aa",
- "username": "string",
- "name": "string"
}, - "toUser": {
- "userID": "2c3821b8-1cdb-4b77-bcd8-a1da701e46aa",
- "username": "string",
- "name": "string"
}, - "amount": "100",
- "status": "pending",
- "type": "transfer",
- "createdAt": "timestamp"
}, - "error": null
}
toUsername required | string |
tokenID required | string |
amount required | string |
message | string |
{- "toUsername": "rollusername",
- "tokenID": "aaa-aaa",
- "amount": "100",
- "message": "some message"
}
{- "data": {
- "token": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "symbol": "string",
- "name": "string",
- "decimals": 0,
- "totalSupply": "string",
- "currentSupply": "string",
- "creatorUserID": "85b9f113-1633-4420-a8f1-38003a290a49"
}, - "fromUser": {
- "userID": "2c3821b8-1cdb-4b77-bcd8-a1da701e46aa",
- "username": "string",
- "name": "string"
}, - "toUser": {
- "userID": "2c3821b8-1cdb-4b77-bcd8-a1da701e46aa",
- "username": "string",
- "name": "string"
}, - "amount": "100",
- "status": "pending",
- "type": "transfer",
- "createdAt": "timestamp"
}, - "error": null
}
{- "data": {
- "userID": "2c3821b8-1cdb-4b77-bcd8-a1da701e46aa",
- "username": "string",
- "name": "string"
}, - "error": null
}
platformName required | string |
platformUserID required | string |
tokenUUID required | string |
{- "data": {
- "token": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "symbol": "string",
- "decimals": 0,
- "logo": "string",
- "contractAddress": "string",
- "currentSupply": "string",
- "totalSupply": "string"
}, - "amount": 0
}, - "error": "string"
}
platformName required | string |
platformUserID required | string |
{- "data": [
- {
- "token": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "symbol": "string",
- "decimals": 0,
- "logo": "string",
- "contractAddress": "string",
- "currentSupply": "string",
- "totalSupply": "string"
}, - "amount": 0
}
], - "error": "string"
}
platformName required | string |
platformUserID required | string |
{- "userID": "2c3821b8-1cdb-4b77-bcd8-a1da701e46aa",
- "username": "string",
- "name": "string",
- "platformUserID": "string",
- "userType": "string"
}
create a multisend transaction
toUsername required | string |
tokenID required | string |
amount required | string |
message | string |
[- {
- "toUsername": "rollusername",
- "tokenID": "aaa-aaa",
- "amount": "100",
- "message": "some message"
}
]
{- "data": {
- "uuid": "2916689a-0b51-4a5f-850e-887cc9aa65d9",
- "totalTxnCount": 10
}, - "error": null
}
Retrieve information about the status of a multisend by UUID
uuid required | string The UUID of the multisend. |
{- "data": {
- "uuid": "2916689a-0b51-4a5f-850e-887cc9aa65d9",
- "status": "processing/completed",
- "totalTxnSubmitted": 10,
- "totalTxnCount": 4
}, - "error": null
}
Retrieve information about the transactions associated with a multisend UUID
uuid required | string The UUID of the multisend. |
{- "data": [
- {
- "token": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "symbol": "string",
- "name": "string",
- "decimals": 0,
- "totalSupply": "string",
- "currentSupply": "string",
- "creatorUserID": "85b9f113-1633-4420-a8f1-38003a290a49"
}, - "fromUser": {
- "userID": "2c3821b8-1cdb-4b77-bcd8-a1da701e46aa",
- "username": "string",
- "name": "string"
}, - "toUser": {
- "userID": "2c3821b8-1cdb-4b77-bcd8-a1da701e46aa",
- "username": "string",
- "name": "string"
}, - "amount": "100",
- "status": "pending",
- "type": "transfer",
- "createdAt": "timestamp"
}
], - "error": "string"
}
Retrieve summary information about a multisend by UUID
uuid required | string The UUID of the multisend. |
{- "data": {
- "platform": "discord",
- "status": "completed/processing",
- "totalFailedToSubmit": 0,
- "totalTxnSubmitted": 1,
- "token": {
- "symbol": "OBEY",
- "uuid": "e88f0102-2916-5cbb-a7ae-2db506fd88d2"
}, - "amount": {
- "maxDenomination": 3,
- "minDenomination": 3000000000000000000,
- "decimals": 18
}, - "success": [
- "externalUserID8"
], - "failure": [
- {
- "userID": "externalUserID6",
- "reason": "failed to send transaction"
}
]
}, - "error": "string"
}
create a multisend transaction v2
tokenID required | string |
amount required | string |
mode required | string postponed or immediate if not specified defaults to immediate where need to specify forms |
{- "forms": [
- {
- "toUsername": "john_doe",
- "tokenID": "TOKEN",
- "amount": "100",
- "message": "Sending you tokens"
}
]
}
{- "data": {
- "uuid": "2916689a-0b51-4a5f-850e-887cc9aa65d9",
- "status": "processing",
- "totalTxnCount": 10
}, - "error": null
}
Update a MultiSend transaction identified by its ID
id required | string <uuid> ID of the MultiSend transaction |
JSON payload to updated a MultiSend transaction with
triggerDeadline | string <date-time> |
Array of objects or objects (child-transfer) |
{- "triggerDeadline": "2019-08-24T14:15:22Z",
- "transfers": [
- {
- "toUsername": "john_doe",
- "tokenID": "TOKEN",
- "amount": "100",
- "message": "Sending you tokens"
}
]
}
{- "data": "string",
- "error": {
- "code": 0,
- "message": "string",
- "error": "string"
}
}
Trigger a postponed MultiSend transaction identified by its ID
id required | string <uuid> ID of the MultiSend transaction |
{- "data": "string",
- "error": {
- "code": 0,
- "message": "string",
- "error": "string"
}
}