logo
API docs by Redocly

Roll App (1.0.0)

Download OpenAPI specification:Download

E-mail: [email protected] URL: http://tryroll.com/ License: Apache 2.0 Terms of Service

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
Reference Application

Balance

Operations to get Roll token balances

Check if user has a certain balance of a specific token

Retrieve information about the user's balance for a specific token.

Authorizations:
oauth2_client_credentials
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": "string"
}

Get user token balances

Retrieve token balances for a specific user.

Authorizations:
oauth2_client_credentials
path Parameters
userID
required
string

The ID of the user.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "error": "string"
}

Get user balance

Authorizations:
oauth2_client_credentials
path Parameters
userID
required
string

The user's unique identifier

tokenID
required
string

The token's unique identifier

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": "string"
}

Token

Operations to get Roll token information

Get tokens

Retrieve information about tokens.

Authorizations:
None
query Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "errors": "string"
}

Get token creator information

Retrieve information about the creator of a specific token.

Authorizations:
None
path Parameters
tokenID
required
string

The ID of the token.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": "string"
}

Transaction

Operations to perform transactions on Roll

Get a transaction by ID

Authorizations:
oauth2_authorization_code
path Parameters
transactionID
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": null
}

Send a transaction

Authorizations:
oauth2_authorization_code
Request Body schema: application/json
toUsername
required
string
tokenID
required
string
amount
required
string
message
string

Responses

Request samples

Content type
application/json
{
  • "toUsername": "rollusername",
  • "tokenID": "aaa-aaa",
  • "amount": "100",
  • "message": "some message"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": null
}

User

Operations to get Roll user information

Get a user by ID

Authorizations:
oauth2_client_credentials
path Parameters
userID
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": null
}

Get current logged-in user information

Authorizations:
oauth2_client_credentials

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": null
}

Platform

Operations to get platform user information on roll

Get users deposit address

Authorizations:
oauth2_authorization_code
path Parameters
platformName
required
string
platformUserID
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": "string"
}

Get users balance for token

Authorizations:
oauth2_authorization_code
path Parameters
platformName
required
string
platformUserID
required
string
tokenUUID
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": "string"
}

Get users balances

Authorizations:
oauth2_authorization_code
path Parameters
platformName
required
string
platformUserID
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "error": "string"
}

Create platrform user

Authorizations:
None
path Parameters
platformName
required
string
platformUserID
required
string

Responses

Response samples

Content type
application/json
{
  • "userID": "2c3821b8-1cdb-4b77-bcd8-a1da701e46aa",
  • "username": "string",
  • "name": "string",
  • "profilePic": "http://example.com",
  • "platformUserID": "string",
  • "userType": "string"
}

Multisend

Operations to perform multisend transactions on Roll

Create multisend

create a multisend transaction

Authorizations:
oauth2_authorization_code
Request Body schema: application/json
Array
Any of
toUsername
required
string
tokenID
required
string
amount
required
string
message
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": null
}

Get multisend status by UUID

Retrieve information about the status of a multisend by UUID

Authorizations:
None
path Parameters
uuid
required
string

The UUID of the multisend.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": null
}

Get transactions by multisend UUID

Retrieve information about the transactions associated with a multisend UUID

Authorizations:
None
path Parameters
uuid
required
string

The UUID of the multisend.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "error": "string"
}

Get summary of multisend by UUID

Retrieve summary information about a multisend by UUID

Authorizations:
None
path Parameters
uuid
required
string

The UUID of the multisend.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": "string"
}

Multisend V2

Create multisend v2

create a multisend transaction v2

Authorizations:
oauth2_authorization_code
Request Body schema: application/json
Any of
tokenID
required
string
amount
required
string
mode
required
string

postponed or immediate if not specified defaults to immediate where need to specify forms

Responses

Request samples

Content type
application/json
{
  • "forms": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": null
}

Update a MultiSend transaction

Update a MultiSend transaction identified by its ID

Authorizations:
oauth2_authorization_code
path Parameters
id
required
string <uuid>

ID of the MultiSend transaction

Request Body schema: application/json

JSON payload to updated a MultiSend transaction with

triggerDeadline
string <date-time>
Array of objects or objects (child-transfer)

Responses

Request samples

Content type
application/json
{
  • "triggerDeadline": "2019-08-24T14:15:22Z",
  • "transfers": [
    ]
}

Response samples

Content type
application/json
{
  • "data": "string",
  • "error": {
    }
}

Trigger a postponed MultiSend transaction

Trigger a postponed MultiSend transaction identified by its ID

Authorizations:
oauth2_authorization_code
path Parameters
id
required
string <uuid>

ID of the MultiSend transaction

Responses

Response samples

Content type
application/json
{
  • "data": "string",
  • "error": {
    }
}