TokenD
Documentation Powered by ReDoc

Horizon (3.11.0)

Download OpenAPI specification:Download

Support: [email protected] URL: https://tokend.io License: Apache 2.0

Horizon is the client-facing REST API module that consumes data from the core of the system and makes it more convenient to use the client facing application. It allows submitting transactions to the network, reading history of operations, and checking the state of entities.

IMPORTANT: Note that endpoints not specified in this document or marked as WIP do not guaranty the backwards compability maintenance.

Overview

Horizon uses JSON:API convention to format requests and responses. The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.

Security

TokenD uses the Ed25519 algorithm for authorizing any request or read private data. The use of such cryptographic proof allows building a system where transfer of secrets in an open form is not necessary, which significantly improves the security. Thus, an attacker who has access to one of the servers will not be able to compromise users' secrets.

Request signature implementation is based on IETF HTTP Signatures draft RFC. Implicit headers parameter is not supported; clients must explicitly specify headers used for signing.

The signature algorithm supported is ed25519-sha256, which uses public signer key as keyId.

Both Signature and Authorization HTTP authentication schemas are supported.

The minimum recommended data to sign is the (request-header) and date.

For the following request:

GET /users?type=2 HTTP/1.1
Host: api.tokend.io
Date: Fri, 05 Jan 2018 21:31:40 GMT

Signing string would be:

date: Fri, 05 Jan 2018 21:31:40 GMT
(request-target): get /users?type=2

Note that header names and HTTP method are lowercased.

The next step is to convert the signing string to a byte array using UTF-8 encoding and to take its SHA-256 hash.

For the signing string above, hash would be:

6fcbee4b0a8932784644d33b360bd3eef389ed37dfd66f17e4bfa910ba9d616a

Now, you have to sign hash with a private key and encode the result in Base64. For a seed such as SCDMOOXVNMO6SA22AYUMZDIGLDJMBUTVEGB73FFNTLFJILBJWIU4NQ3D, the encoded signature would be:

w/y3EsliTmQPC6MS88N/kjU/hFVxlIdhFhzfRGv4yIsSokgMpxVqxcC/CmUsAN4t3BKpskGG7+JEWryV8NXvCg==

The result HTTP header included to the request then would be:

Authorization: keyId="GBLTOG6EJS5OWDNQNSCEAVDNMPBY6F73XZHHKR27YE5AKE23ZZEXOLBK",algorithm="ed25519-sha256",signature="w/y3EsliTmQPC6MS88N/kjU/hFVxlIdhFhzfRGv4yIsSokgMpxVqxcC/CmUsAN4t3BKpskGG7+JEWryV8NXvCg==",headers="date (request-target)"

Accounts

Defines access points for accounts and related entities

Account by ID

Allows getting Account with corresponding details.

Note that if we include fees filter - we will receive all the fees applied to a particular account.

For example if someone's, say Bob, account has a several fees applied to itself:

  • first fee applied globally for all accounts for payments of amount from 0 to 100 BTC and is 1% from the payment
  • second fee applied exactly to Bob's account and is 2% of the payment of amounts from 100 to 200 BTC

then we will receive both of them in response because they are applied to Bob's account

path Parameters
id
required
string

Unique identifier of an account

query Parameters
include
string
Enum: "fees" "balances" "balances.asset" "balances.state" "referrer" "limits" "external_system_ids" "role" "role.rules" "kyc_data"
Example: include=balances,balances.asset

🔒 Following relationships require an owner's or admin's signature to be included:

  • balances.state
  • referrer
  • fees
  • role
  • role.rules
  • limits
  • external_system_ids
  • kyc_data

Responses

200

account exists

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

such an account does not exist

get /v3/accounts/{id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/accounts/{id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "included":
    [
    ]
}

Accounts list

Allows to get list of accounts. Admin signature is required.

query Parameters
filter[account]
Array of strings

Filters accounts by account id

filter[role]
Array of integers

Filters accounts by role id

page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

asset exists

400

bad input parameter

get /v3/accounts

TokenD Developer Environment

https://api.achilles.tokend.io/v3/accounts

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "links":
    {
    }
}

Calculate fee

Allows calculating a fee for an account.

path Parameters
asset
required
string

Unique identifier of an asset

fee_type
required
integer

Type of fee

subtype
required
integer

Subtype of fee

amount
required
string

Amount to calculate on which fee is based on

Responses

200

fee does exist and is calculated successfuly

400

bad input parameter

500

internal error occured during the request processing

get /v3/accounts/{id}/calculated_fees

TokenD Developer Environment

https://api.achilles.tokend.io/v3/accounts/{id}/calculated_fees

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Signers for Account

Allows getting Signers of the account with corresponding details.

path Parameters
id
required
string

Unique identifier of an account

query Parameters
include
string
Enum: "role" "role.rules"
Example: include=role,role.rules

For signers, following relationships can be included:

Responses

200

account exists

400

bad input parameter

404

such an account does not exist

get /v3/accounts/{id}/signers

TokenD Developer Environment

https://api.achilles.tokend.io/v3/accounts/{id}/signers

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

Assets

Defines access points for assets

Asset by ID

Allows getting Asset with corresponding details.

path Parameters
id
required
string

Unique identifier of an asset (code)

query Parameters
include
string
Value: "owner"

Relationships that may be used for the included parameter.

Responses

200

asset exists

400

bad input parameter

404

asset does not exist

get /v3/assets/{id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/assets/{id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "included":
    [
    ]
}

Asset List

Allows getting a filtered list of Asset with corresponding details.

query Parameters
filter[policy]
integer

Filters assets by a specified bit mask. Returns the page of assets where at least one bit intersects

filter[types]
integer

Filters assets by a specified types. Returns the page of assets where at least one bit intersects

filter[owner]
string

Filters assets by a specified owner's account address.

filter[state]
string

Filters assets by state.

  • 0 - active
  • 1 - deleted
include
string
Value: "owner"

Relationships that may be used for the included parameter.

page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

asset exists

400

bad input parameter

404

asset does not exist

get /v3/assets

TokenD Developer Environment

https://api.achilles.tokend.io/v3/assets

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

Asset Creation Request by ID

Allows getting CreateAssetRequest by ID

🔒 Requestor's or reviewer's signature is needed

query Parameters
filter[requestor]
string

Filters requests by requestor - source of the operation.

filter[reviewer]
string

Filters requests by reviewer - account assigned to review requests.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.

filter[request_details.asset]
string

Filters asset create requests by asset code.

include
string
Enum: "request_details" "request_details.asset"

Relationships that may be used for the included parameter.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

request does not exist

get /v3/create_asset_requests/{id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/create_asset_requests/{id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "included":
    [
    ]
}

Asset Creation Request List

Allows getting a filtered list of CreateAssetRequest with details

🔒 Requestor's or reviewer's signature is needed

query Parameters
filter[requestor]
string

Filters requests by requestor - source of the operation.

filter[reviewer]
string

Filters requests by reviewer - account assigned to review requests.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.

filter[request_details.asset]
string

Filters asset create requests by asset code.

include
string
Enum: "request_details" "request_details.asset"

Relationships that may be used for the included parameter.

page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

requests do not exist

get /v3/create_asset_requests

TokenD Developer Environment

https://api.achilles.tokend.io/v3/create_asset_requests

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

Update Asset Request by ID

Allows getting UpdateAssetRequest by ID

🔒 Requestor's or reviewer's signature is needed

query Parameters
filter[requestor]
string

Filters requests by requestor - source of the operation.

filter[reviewer]
string

Filters requests by reviewer - account assigned to review requests.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.

filter[request_details.asset]
string

Filters update asset requests by asset code.

include
string
Enum: "request_details" "request_details.asset"

Relationships that may be used for the included parameter.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

request does not exist

get /v3/update_asset_requests/{id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/update_asset_requests/{id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "included":
    [
    ]
}

Update Asset Request List

Allows getting a filtered list of UpdateAssetRequest with details

🔒 Requestor's or reviewer's signature is needed

query Parameters
filter[requestor]
string

Filters requests by requestor - source of the operation.

filter[reviewer]
string

Filters requests by reviewer - account assigned to review requests.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.

filter[request_details.asset]
string

Filters asset update requests by asset code.

include
string
Enum: "request_details" "request_details.asset"

Relationships that may be used for the included parameter.

page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

requests do not exist

get /v3/asset_update_requests

TokenD Developer Environment

https://api.achilles.tokend.io/v3/asset_update_requests

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

Balances

Balance by ID

Allows getting Balance with corresponding details.

path Parameters
id
required
string

Unique identifier of a balance

query Parameters
include
string
Enum: "asset" "state"
Example: include=asset

🔒 Following relationships require an owner's or admin's signature to be included:

  • state

Responses

200

balance exists

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

such a balance does not exist

get /v3/balances/{id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/balances/{id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "included":
    [
    ]
}

Balance List

Allows getting list of balances with corresponding details.

🔒 Admins signature is needed. If filter by asset is provided, the signature of asset's owner is also valid

query Parameters
filter[asset]
string

Filters balances by asset. Returns page of balances for the provided asset

filter[asset_owner]
any

Filters balances by asset owner. Returns page of balances for the provided asset owner

filter[owner]
string

Filters balances by owner. Returns page of balances for the provided owner

filter[amount_lw_or_eq]
integer

Filters balances by amount. Returns page of balances with balance amount lower or equal then provided

filter[amount_gt]
integer

Filters balances by amount. Returns page of balances with balance amount greater then provided

include
string
Enum: "state" "owner"

Relationships that may be used for the included parameter.

page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

Request is successfull

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

get /v3/balances

TokenD Developer Environment

https://api.achilles.tokend.io/v3/balances

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included": [ ],
  • "links":
    {
    }
}

Balances Statistic List

path Parameters
id
required
string

ID of the account

asset_code
required
string

ID of the collection (asset to convert balances to)

query Parameters
page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

balances statistic exist

400

bad input parameter

404

fees do not exist

get /v3/accounts/{id}/balances_statistic/{asset_code}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/accounts/{id}/balances_statistic/{asset_code}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "links":
    {
    }
}

Converted Balances

Allows getting list of balances converted to provided asset.

🔒 Either account or admin signature is needed. If filter by asset owner is provided, the signature of asset's owner is also valid

path Parameters
id
required
string

ID of the account

asset_code
required
string

ID of the collection (asset to convert balances to)

query Parameters
filter[asset_owner]
any

Filters balances by asset owner. Returns page of balances for the provided asset owner

include
string
Enum: "asset" "states" "balance" "balance.state" "balance.asset"
Example: include=states

Relationships that may be used for the include parameter.

Responses

200

balances collection exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

either account or asset to convert states doesn't exist

get /v3/accounts/{id}/converted_balances/{asset_code}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/accounts/{id}/converted_balances/{asset_code}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "included":
    [
    ]
}

Fees

Defines access points for fees

Calculate fee

Allows calculating a fee for an account.

path Parameters
asset
required
string

Unique identifier of an asset

fee_type
required
integer

Type of fee

subtype
required
integer

Subtype of fee

amount
required
string

Amount to calculate on which fee is based on

Responses

200

fee does exist and is calculated successfuly

400

bad input parameter

500

internal error occured during the request processing

get /v3/accounts/{id}/calculated_fees

TokenD Developer Environment

https://api.achilles.tokend.io/v3/accounts/{id}/calculated_fees

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Fee List

Allows getting a filtered list of Fee with corresponding details.

query Parameters
filter[asset]
string

Filters fees by asset. Returns page of fees for the provided asset

filter[fee_type]
integer

Filters fees by type.

filter[subtype]
integer

Filters fees by subtype.

filter[account]
string

Filters fees by account address. Returns only fees which explicitly contains this account in relationships. This means that if the fee was applied exactly for this account - it would be returned in the response. Global fees, fees for account roles and other system-wide fees would be omitted.

For example if someone's, say Bob, account has a several fees applied to itself:

  • first fee applied globally for all accounts for payments from 0 to 100 BTC and is 1% from the payment
  • second fee applied exactly to Bob's account and is 2% of the payment for amounts from 100 to 200 BTC

then we will receive only the second fee in response only it is applied to Bob's account

filter[account_role]
integer

Filters fees by account role.

filter[lower_bound]
integer

Filters fees by lower_bound.

filter[upper_bound]
integer

Filters fees by upper_bound.

include
string
Value: "asset"

Relationships that may be used for the included parameter.

page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

fees exist

400

bad input parameter

404

fees do not exist

get /v3/fees

TokenD Developer Environment

https://api.achilles.tokend.io/v3/fees

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

AMLAlert

Defines access points to AMLAlert Reviewable Requests

AMLAlert by ID

Allows getting CreateAmlAlert by ID

🔒 Requestor's or reviewer's signature is needed

query Parameters
filter[requestor]
string

Filters requests by requestor - source of the operation.

filter[reviewer]
string

Filters requests by reviewer - account assigned to review requests.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.

filter[request_details.balance]
string

Filters create aml alert requests by balance.

include
string
Enum: "request_details" "request_details.balance"

Relationships that may be used for the included parameter.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

request does not exist

get /v3/create_aml_alert_requests/{id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/create_aml_alert_requests/{id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "included":
    [
    ]
}

AMLAlert List

Allows getting a filtered list of CreateAmlAlertRequest with details

🔒 Requestor's or reviewer's signature is needed

query Parameters
filter[requestor]
string

Filters requests by requestor - source of the operation.

filter[reviewer]
string

Filters requests by reviewer - account assigned to review requests.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.

filter[request_details.balance]
string

Filters create aml alert requests by balance.

include
string
Enum: "request_details" "request_details.balance"

Relationships that may be used for the included parameter.

page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

requests do not exist

get /v3/create_aml_alert_requests

TokenD Developer Environment

https://api.achilles.tokend.io/v3/create_aml_alert_requests

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

Issuance

Defines access points to get Issuance Reviewable Requests

Issuance Request by ID

Allows getting CreateIssuance by ID

🔒 Requestor's or reviewer's signature is needed

query Parameters
filter[requestor]
string

Filters requests by requestor - source of the operation.

filter[reviewer]
string

Filters requests by reviewer - account assigned to review requests.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.

filter[request_details.asset]
string

Filters preissuance create requests by asset code.

include
string
Enum: "request_details" "request_details.asset"

Relationships that may be used for the included parameter.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

request does not exist

get /v3/create_issuance_requests/{id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/create_issuance_requests/{id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "included":
    [
    ]
}

Issuance Request List

Allows getting a filtered list of CreateIssuanceRequest with details

🔒 Requestor's, reviewer's or receiving balance owner signature is needed

query Parameters
filter[requestor]
string

Filters requests by requestor - source of the operation.

filter[reviewer]
string

Filters requests by reviewer - account assigned to review requests.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.

filter[request_details.asset]
string

Filters issuance create requests by asset code.

filter[request_details.receiver]
string

Filters requests by receiver balance

include
string
Enum: "request_details" "request_details.asset"

Relationships that may be used for the included parameter.

page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

requests do not exist

get /v3/create_issuance_requests

TokenD Developer Environment

https://api.achilles.tokend.io/v3/create_issuance_requests

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

Withdrawal

Defines access points to get Withdrawal Reviewable Requests

Withdrawal Request by ID

Allows getting CreateWithdraw by ID

🔒 Requestor's or reviewer's signature is needed

query Parameters
filter[requestor]
string

Filters requests by requestor - source of the operation.

filter[reviewer]
string

Filters requests by reviewer - account assigned to review requests.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.

filter[request_details.balance]
string

Filters create_withdraw requests by balance.

filter[request_details.asset]
string

Filters create withdraw requests by asset.

include
string
Enum: "request_details" "request_details.balance" "request_details.asset"

Relationships that may be used for the included parameter.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

request does not exist

get /v3/create_withdraw_requests/{id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/create_withdraw_requests/{id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "included":
    [
    ]
}

Withdrawal Request List

Allows getting a filtered list of CreateWithdrawRequest with details

🔒 Requestor's or reviewer's signature is needed

query Parameters
filter[requestor]
string

Filters requests by requestor - source of the operation.

filter[reviewer]
string

Filters requests by reviewer - account assigned to review requests.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.

filter[request_details.balance]
string

Filters create_withdraw requests by balance.

filter[request_details.asset]
Array of strings

Filters create withdraw requests by assets to be withdrawn.

include
string
Enum: "request_details" "request_details.balance" "request_details.asset"

Relationships that may be used for the included parameter.

page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

requests do not exist

get /v3/create_withdraw_requests

TokenD Developer Environment

https://api.achilles.tokend.io/v3/create_withdraw_requests

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

Atomic Swap

Atomic Swap Ask by ID

Allows getting Atomic Swap Ask with corresponding details.

path Parameters
id
required
string

Unique identifier of an atomic swap ask (id)

query Parameters
include
string
Enum: "base_balance" "owner" "base_asset" "quote_assets"

Relationships that may be used for the included parameter.

Responses

200

atomic swap ask exists

400

bad input parameter

404

asset does not exist

get /v3/atomic_swap_asks/{id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/atomic_swap_asks/{id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "included":
    [
    ]
}

Atomic Swap Ask List

Allows getting a filtered list of Atomic Swap Ask with corresponding details.

query Parameters
filter[base_asset]
integer

Filters atomic swap asks by a base asset.

filter[owner]
string

Filters atomic swap asks by a specified owner's account address.

filter[quote_assets]
Array of strings

Filters atomic swap asks by quote assets. Returns the page of atomic swap asks where all quote assets present.

include
string
Enum: "base_balance" "owner" "base_asset" "quote_assets"

Relationships that may be used for the included parameter.

page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

atomic swap ask exists

400

bad input parameter

404

asset does not exist

get /v3/atomic_swap_asks

TokenD Developer Environment

https://api.achilles.tokend.io/v3/atomic_swap_asks

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

Create Atomic Swap Ask Request by ID

Allows getting CreateAtomicSwapAsk by ID

🔒 Requestor's or reviewer's signature is needed

query Parameters
filter[requestor]
string

Filters requests by requestor - source of the operation.

filter[reviewer]
string

Filters requests by reviewer - account assigned to review requests.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.

filter[request_details.base_balance]
string

Filters create_atomic_swap_ask requests by base balance.

include
string
Enum: "request_details" "request_details.base_balance" "request_details.quote_assets"

Relationships that may be used for the included parameter.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

request does not exist

get /v3/create_atomic_swap_ask_requests/{id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/create_atomic_swap_ask_requests/{id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "included":
    [
    ]
}

Create Atomic Swap Ask Request List

Allows getting a filtered list of CreateAtomicSwapAskRequest with details

🔒 Requestor's or reviewer's signature is needed

query Parameters
filter[requestor]
string

Filters requests by requestor - source of the operation.

filter[reviewer]
string

Filters requests by reviewer - account assigned to review requests.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.

filter[request_details.base_balance]
string

Filters create_atomic_swap_ask requests by balance.

include
string
Enum: "request_details" "request_details.base_balance" "request_details.quote_assets"

Relationships that may be used for the included parameter.

page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

requests do not exist

get /v3/create_atomic_swap_ask_requests

TokenD Developer Environment

https://api.achilles.tokend.io/v3/create_atomic_swap_ask_requests

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

Create Atomic Swap Bid Request by ID

Allows getting CreateAtomicSwapBid by ID

🔒 Requestor's or reviewer's signature is needed

query Parameters
filter[requestor]
string

Filters requests by requestor - source of the operation.

filter[reviewer]
string

Filters requests by reviewer - account assigned to review requests.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.

filter[request_details.quote_asset]
string

Filters create_atomic_swap_bid requests by quote asset.

include
string
Enum: "request_details" "request_details.quote_asset"

Relationships that may be used for the included parameter.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

request does not exist

get /v3/create_atomic_swap_bid_requests/{id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/create_atomic_swap_bid_requests/{id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "included":
    [
    ]
}

Create Atomic Swap Bid Request List

Allows getting a filtered list of CreateAtomicSwapBidRequest with details

🔒 Requestor's or reviewer's signature is needed

query Parameters
filter[requestor]
string

Filters requests by requestor - source of the operation.

filter[reviewer]
string

Filters requests by reviewer - account assigned to review requests.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.

filter[request_details.quote_asset]
string

Filters atomic swap bid requests by quote asset.

filter[request_details.ask_id]
integer

Filters atomic swap bid requests by atomic swap ask id.

filter[request_details.ask_owner]
integer

Filters atomic swap bid requests by atomic swap ask owner id.

include
string
Enum: "request_details" "request_details.quote_asset"

Relationships that may be used for the included parameter.

page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

requests do not exist

get /v3/create_atomic_swap_bid_requests

TokenD Developer Environment

https://api.achilles.tokend.io/v3/create_atomic_swap_bid_requests

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

Swaps

Swap by ID

Allows getting Swap with corresponding details.

🔒 Admin, swap source, or swap destination signature is required

path Parameters
id
required
integer <int64>
Example: 10

Unique identifier of a swap

query Parameters
include
string
Enum: "source_balance" "destination_balance" "asset"

Relationships that may be used for the included parameter.

filter[source]
string

Filters swaps by a specified source's account address.

filter[destination]
string

Filters swaps by a specified destination's account address.

filter[destination_balance]
string

Filters swaps by a specified destination's balance address.

filter[source_balance]
string

Filters swaps by a specified source's balance address.

filter[state]
integer
Example: filter[state]=1

Filters sales by a specified sale state. Available sale states:

  • 1 - open
  • 2 - closed
  • 3 - cancelled

Responses

200

swap exists

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

swap does not exist

get /v3/swaps/{id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/swaps/{id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "included": [ ]
}

Swaps list

Allows getting a filtered list of Swaps with corresponding details.

🔒 Depending on the case, different signatures are required:

  1. if no filters are applied, admin signature is required.

  2. if filter by source is applied, signature of source is required

  3. if filter by destination is applied, signature of destination is required

query Parameters
include
string
Enum: "source_balance" "destination_balance" "asset"

Relationships that may be used for the included parameter.

filter[source]
string

Filters swaps by a specified source's account address.

filter[destination]
string

Filters swaps by a specified destination's account address.

filter[destination_balance]
string

Filters swaps by a specified destination's balance address.

filter[source_balance]
string

Filters swaps by a specified source's balance address.

filter[state]
integer
Example: filter[state]=1

Filters sales by a specified sale state. Available sale states:

  • 1 - open
  • 2 - closed
  • 3 - cancelled
page[cursor]
integer >= 0

Cursor point to the end of the previous page

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

swaps exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

get /v3/swaps

TokenD Developer Environment

https://api.achilles.tokend.io/v3/swaps

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included": [ ],
  • "links":
    {
    }
}

Redemption

Redemption Request by ID

Allows getting Redemption requests by ID

🔒 Requestor's or reviewer's signature is needed

query Parameters
filter[requestor]
string

Filters requests by requestor - source of the operation.

filter[reviewer]
string

Filters requests by reviewer - account assigned to review requests.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.

include
string
Value: "request_details"

Relationships that may be used for the included parameter.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

request does not exist

get /v3/redemption_requests/{id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/redemption_requests/{id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "included":
    [
    ]
}

Redemption Request List

Allows getting a filtered list of Redemption with details

🔒 Requestor's or reviewer's signature is needed

query Parameters
filter[requestor]
string

Filters requests by requestor - source of the operation.

filter[reviewer]
string

Filters requests by reviewer - account assigned to review requests.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.

filter[request_details.base_asset]
string

Filters sale requests by base asset.

filter[request_details.default_quote_asset]
string

Filters sale requests by a default quote asset.

include
string
Enum: "request_details" "request_details.base_asset" "request_details.default_quote_asset" "request_details.quote_assets"

Relationships that may be used for the included parameter.

page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

requests do not exist

get /v3/redemption_requests

TokenD Developer Environment

https://api.achilles.tokend.io/v3/redemption_requests

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

DeferredPayments

CloseDeferredPayment Request by ID

Allows getting a filtered list of CloseDeferredPayment with details

🔒 Requestor's or reviewer's signature is needed

path Parameters
id
required
any
query Parameters
include
string
Value: "request_details"

Relationships that may be used for the included parameter.

page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

requests do not exist

get /v3/close_deferred_payment_requests/{id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/close_deferred_payment_requests/{id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "deferredPayment":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

CloseDeferredPayment Request List

Allows getting a filtered list of CloseDeferredPayment with details

🔒 Requestor's or reviewer's signature is needed

query Parameters
filter[requestor]
string

Filters requests by requestor - source of the operation.

filter[reviewer]
string

Filters requests by reviewer - account assigned to review requests.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.

include
string
Value: "request_details"

Relationships that may be used for the included parameter.

page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

requests do not exist

get /v3/close_deferred_payment_requests

TokenD Developer Environment

https://api.achilles.tokend.io/v3/close_deferred_payment_requests

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "deferredPayment":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

CreateDeferredPayment Request by ID

Allows getting a filtered list of CreateDeferredPayment with details

🔒 Requestor's or reviewer's signature is needed

path Parameters
id
required
any
query Parameters
include
string
Value: "request_details"

Relationships that may be used for the included parameter.

page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

requests do not exist

get /v3/create_deferred_payment_requests/{id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/create_deferred_payment_requests/{id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "deferredPayment":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

CreateDeferredPayment Request List

Allows getting a filtered list of CreateDeferredPayment with details

🔒 Requestor's or reviewer's signature is needed

query Parameters
filter[requestor]
string

Filters requests by requestor - source of the operation.

filter[reviewer]
string

Filters requests by reviewer - account assigned to review requests.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.

filter[request_details.destination]
string

Filters requests by deferred payment destination account

include
string
Value: "request_details"

Relationships that may be used for the included parameter.

page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

requests do not exist

get /v3/create_deferred_payment_requests

TokenD Developer Environment

https://api.achilles.tokend.io/v3/create_deferred_payment_requests

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "deferredPayment":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

DeferredPayment by ID

Allows getting DeferredPayment with corresponding details.

🔒 Admin, deferredPayment source, or deferredPayment destination signature is required

path Parameters
id
required
integer <int64>
Example: 10

Unique identifier of a deferredPayment

query Parameters
filter[destination]
string

Filters deferred_payments by a specified destination's account address.

filter[source_balance]
string

Filters deferred_payments by a specified source's balance address.

Responses

200

deferredPayment exists

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

deferredPayment does not exist

get /v3/deferred_payments/{id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/deferred_payments/{id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "included": [ ]
}

DeferredPayments list

Allows getting a filtered list of DeferredPayments with corresponding details.

🔒 Depending on the case, different signatures are required:

  1. if no filters are applied, admin signature is required.

  2. if filter by source is applied, signature of source is required

  3. if filter by destination is applied, signature of destination is required

query Parameters
filter[destination]
string

Filters deferredPayments by a specified destination's account address.

filter[source_balance]
string

Filters deferredPayments by a specified source's balance address.

filter[source]
string

Filters deferredPayments by a specified source's account address.

filter[asset]
string

Filters deferredPayments by a specified asset code

page[cursor]
integer >= 0

Cursor point to the end of the previous page

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

deferredPayments exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

get /v3/deferred_payments

TokenD Developer Environment

https://api.achilles.tokend.io/v3/deferred_payments

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included": [ ],
  • "links":
    {
    }
}

Signers

Defines access points to get signers

Signers for Account

Allows getting Signers of the account with corresponding details.

path Parameters
id
required
string

Unique identifier of an account

query Parameters
include
string
Enum: "role" "role.rules"
Example: include=role,role.rules

For signers, following relationships can be included:

Responses

200

account exists

400

bad input parameter

404

such an account does not exist

get /v3/accounts/{id}/signers

TokenD Developer Environment

https://api.achilles.tokend.io/v3/accounts/{id}/signers

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

Signer Roles

Signer Role by ID

Allows getting Signer Role with corresponding details.

path Parameters
id
required
string

Unique identifier of the signer role

query Parameters
include
string
Value: "rules"

Relationships that may be used for the included parameter.

Responses

200

signer role exists

400

bad input parameter

404

signer role does not exist

get /v3/signer_roles/{id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/signer_roles/{id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "included":
    [
    ]
}

Signer Role List

Allows getting a list of Signer Role with corresponding details.

query Parameters
include
string
Value: "rules"

Relationships that may be used for the included parameter.

page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

succesfully retrieved page

400

bad input parameter

get /v3/signer_roles

TokenD Developer Environment

https://api.achilles.tokend.io/v3/signer_roles

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

Signer Rules

Signer Rule by ID

Allows getting Signer Rule with corresponding details.

path Parameters
id
required
string

Unique identifier of the signer rule

Responses

200

signer rule exists

400

bad input parameter

404

signer rule does not exist

get /v3/signer_rules/{id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/signer_rules/{id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Signer Rule List

Allows getting a list of Signer Rule with corresponding details.

query Parameters
page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

succesfully retrieved page

400

bad input parameter

get /v3/signer_rules

TokenD Developer Environment

https://api.achilles.tokend.io/v3/signer_rules

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "links":
    {
    }
}

Account Roles

Defines access points to get account role

Account Role by ID

Allows getting Account Role with corresponding details.

path Parameters
id
required
string

Unique identifier of an account role

query Parameters
include
string
Value: "rules"

Relationships that may be used for the included parameter.

Responses

200

account role exists

400

bad input parameter

404

account role does not exist

get /v3/account_roles/{id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/account_roles/{id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "included":
    [
    ]
}

Account Role List

Allows getting a list of Account Role with corresponding details.

query Parameters
include
string
Value: "rules"

Relationships that may be used for the included parameter.

page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

succesfully retrieved page

400

bad input parameter

get /v3/account_roles

TokenD Developer Environment

https://api.achilles.tokend.io/v3/account_roles

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included":
    [
    ]
}

Account Rules

Account Rule by ID

Allows getting Account Rule with corresponding details.

path Parameters
id
required
string

Unique identifier of an account rule

Responses

200

account rule exists

400

bad input parameter

404

account rule does not exist

get /v3/account_rules/{id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/account_rules/{id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Account Rule List

Allows getting a list of Account Rule with corresponding details.

query Parameters
page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

succesfully retrieved page

400

bad input parameter

get /v3/account_rules

TokenD Developer Environment

https://api.achilles.tokend.io/v3/account_rules

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "links":
    {
    }
}

Change Account Role Request

Change Account Role Request by ID

Allows to get ChangeRole by ID

🔒 Requestor's or reviewer's signature is needed

query Parameters
filter[requestor]
string

Filters requests by the requestor - source of the operation.

filter[reviewer]
string

Filters requests by the reviewer - account assigned to review requests.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.

filter[request_details.destination_account]
string

Filters change role requests by destination account.

filter[request_details.account_role_to_set]
string

Filters change role requests by account_role_to_set.

include
string
Enum: "request_details" "request_details.account"

Relationships that may be used for the included parameter.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

request does not exist

get /v3/change_role_requests/{id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/change_role_requests/{id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "included":
    [
    ]
}

Change Account Role Request List

Allows getting a filtered list of ChangeRoleRequest with details

🔒 Requestor's or reviewer's signature is needed

query Parameters
filter[requestor]
string

Filters requests by requestor - source of the operation.

filter[reviewer]
string

Filters requests by reviewer - account assigned to review requests.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks pending tasks bit mask. Returns requests if at least one bit is set.

filter[request_details.destination_account]
string

Filters change_role requests by account to change role.

filter[request_details.account_role_to_set]
string

Filters change_role requests by account_role_to_set.

include
string
Enum: "request_details" "request_details.account"

Relationships that may be used for the included parameter.

page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

requests do not exist

get /v3/change_role_requests

TokenD Developer Environment

https://api.achilles.tokend.io/v3/change_role_requests

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

AMLAlert

Defines access points to AMLAlert Reviewable Requests

AMLAlert by ID

Allows getting CreateAmlAlert by ID

🔒 Requestor's or reviewer's signature is needed

query Parameters
filter[requestor]
string

Filters requests by requestor - source of the operation.

filter[reviewer]
string

Filters requests by reviewer - account assigned to review requests.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.

filter[request_details.balance]
string

Filters create aml alert requests by balance.

include
string
Enum: "request_details" "request_details.balance"

Relationships that may be used for the included parameter.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

request does not exist

get /v3/create_aml_alert_requests/{id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/create_aml_alert_requests/{id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "included":
    [
    ]
}

AMLAlert List

Allows getting a filtered list of CreateAmlAlertRequest with details

🔒 Requestor's or reviewer's signature is needed

query Parameters
filter[requestor]
string

Filters requests by requestor - source of the operation.

filter[reviewer]
string

Filters requests by reviewer - account assigned to review requests.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.

filter[request_details.balance]
string

Filters create aml alert requests by balance.

include
string
Enum: "request_details" "request_details.balance"

Relationships that may be used for the included parameter.

page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

requests do not exist

get /v3/create_aml_alert_requests

TokenD Developer Environment

https://api.achilles.tokend.io/v3/create_aml_alert_requests

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

Limits

Limits List

Allows getting a filtered list of Limits with corresponding details.

query Parameters
filter[asset]
string

Filters limits by asset.

filter[stats_op_type]
integer

Filters limits by statsOpType.

filter[account]
string

Filters limits by account address.

filter[account_role]
integer

Filters limits by account role.

include
string
Value: "asset"

Relationships that may be used for the included parameter.

page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

limits exist

400

bad input parameter

404

limits do not exist

get /v3/limits

TokenD Developer Environment

https://api.achilles.tokend.io/v3/limits

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

Update Limits Request by ID

Allows getting UpdateLimits by ID

🔒 Requestor's or reviewer's signature is needed

query Parameters
filter[requestor]
string

Filters requests by requestor - source of the operation.

filter[reviewer]
string

Filters requests by reviewer - account assigned to review requests.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.

include
string
Value: "request_details"

Relationships that may be used for the included parameter.

Responses

200

requests exist

400

bad input parameter

404

request does not exist

get /v3/update_limits_requests/{id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/update_limits_requests/{id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "included":
    [
    ]
}

Update Limits Request List

Allows getting a filtered list of UpdateLimitsRequest with details

🔒 Requestor's or reviewer's signature is needed

query Parameters
filter[requestor]
string

Filters requests by requestor - source of the operation.

filter[reviewer]
string

Filters requests by reviewer - account assigned to review request.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.

include
string
Value: "request_details"

Relationships that may be used for the included parameter.

page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

requests do not exist

get /v3/update_limits_requests

TokenD Developer Environment

https://api.achilles.tokend.io/v3/update_limits_requests

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

KYC Recovery

KYC Recovery Request By ID

Allows to get KYCRecovery by ID

🔒 Requestor's or reviewer's signature is needed

query Parameters
filter[requestor]
string

Filters requests by the requestor - source of the operation.

filter[reviewer]
string

Filters requests by the reviewer - account assigned to review requests.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.

filter[request_details.target_account]
string

Filters change role requests by destination account.

include
string
Enum: "request_details" "request_details.target_account"

Relationships that may be used for the included parameter.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

request does not exist

get /v3/kyc_recovery_requests/{id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/kyc_recovery_requests/{id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "included":
    [
    ]
}

KYC Recovery Request List

Allows getting a filtered list of KYCRecoveryRequest with details

🔒 Requestor's or reviewer's signature is needed

query Parameters
filter[requestor]
string

Filters requests by requestor - source of the operation.

filter[reviewer]
string

Filters requests by reviewer - account assigned to review requests.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks pending tasks bit mask. Returns requests if at least one bit is set.

filter[request_details.target_account]
string

Filters kyc recovery requests by target account

include
string
Enum: "request_details" "request_details.target_account"

Relationships that may be used for the included parameter.

page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

requests do not exist

get /v3/kyc_recovery_requests

TokenD Developer Environment

https://api.achilles.tokend.io/v3/kyc_recovery_requests

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

Asset Pairs

  • A base asset refers to the underlying assets giving value to a company, investment or loan. Base asset is not fixed. It will appreciate or depreciate according to market forces.
  • A quote asset refers to the last amount at which 1 base asset was traded, meaning the most recent price to which a buyer and seller have agreed as well as the price at which some 1 base asset was transacted

AssetPair by ID

Allows getting AssetPair with corresponding details.

path Parameters
id
required
string <BASE:QUOTE>
Example: BTC:ETH

Unique identifier of an asset pair that consists of two asset codes

query Parameters
include
string
Enum: "base_asset" "quote_asset"
Example: include=base_asset

Relationships that may be used for the include parameter.

Responses

200

asset pair exists

400

bad input parameter

404

asset pair does not exist

get /v3/asset_pairs/{id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/asset_pairs/{id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "included":
    [
    ]
}

AssetPair List

Allows getting a filtered list of AssetPair with corresponding details.

query Parameters
filter[policy]
integer <int32>
Example: filter[policy]=2

Filters asset pairs by a specified bit mask. Returns the page of asset pairs where at least one bit intersects.

filter[base_asset]
string <valid AssetCode>
Example: filter[base_asset]=BTC

Filters asset pairs by a specified base asset of the pair.

filter[quote_asset]
string <valid AssetCode>
Example: filter[quote_asset]=ETH

Filters asset pairs by a specified quote asset of the pair.

filter[asset]
string <valid AssetCode>
Example: filter[asset]=ETH

Filters asset pairs by a specified asset of the pair (no matter whether it is a base or quote asset)

include
string
Enum: "base_asset" "quote_asset"
Example: include=base_asset,quote_asset

Relationships that may be used for the include parameter.

page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

asset pairs that satisfy specified filters

400

bad input parameter

404

asset pair does not exist

get /v3/asset_pairs

TokenD Developer Environment

https://api.achilles.tokend.io/v3/asset_pairs

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

Offers

Offer by ID

Allows getting Offer with corresponding details.

🔒 An owner's or admin's signature is needed to get the data from this endpoint.

path Parameters
id
required
integer <int64>
Example: 10

Unique identifier of an offer

query Parameters
include
string
Enum: "base_asset" "quote_asset"

Relationships that may be used for the included parameter.

Responses

200

offer exists

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

offer does not exist

get /v3/offers/{id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/offers/{id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "included":
    [
    ]
}

Offers List

Allows getting a filtered list of Offer with corresponding details.

🔒 Depending on the case, different signatures are required:

  1. if no filters are applied, admin account's signature is required.

  2. if filters are applied, signature of the account by which the filter was requested is required

query Parameters
filter[base_balance]
string <valid balanceID>
Example: filter[base_balance]=BDLXKLLVS6UIQEDYCZKIC5222GGQLCOTHM4BWXVCBDQMJTUWUFUATV2Q

Filters offers by specified base balance ID

filter[quote_balance]
string <valid balanceID>
Example: filter[quote_balance]=BPGIKLLVS6UIQEDYCJRFH53GJ7GQLCOTHM4BWXVCBDQMJTUWUDPQTVLO

Filters offers by specified quote balance ID

filter[base_asset]
string <valid assetCode>
Example: filter[base_asset]=BTC

Filters offers by specified base asset code

filter[quote_asset]
string <valid assetCode>
Example: filter[quote_asset]=ETH

Filters offers by specified quote asset code

filter[owner]
string <valid accountID>
Example: filter[owner]=GAULFBQKQTFHHHZEIRMYVCGTY47FKWEW7P2BY2YT45HAEODAIJUJH23T

Filters offers by a specified account that created the offer

filter[order_book]
number <int64>
Example: filter[order_book]=2

Filters offers by specified order book ID Defines whether offers are for sale or for trade (0 - secondary market, saleId - for specific sale)

filter[is_buy]
number <int32>
Example: filter[is_buy]=1

Defines whether an offer is on buying or selling the base_asset, or both

  • if is_buy == true -> only buy base_asset offers are filtered
  • if is_buy == false -> only sell base_asset offers are filtered
  • if is_buy is not specified -> both buy and sell base_asset offers are filtered
include
string
Enum: "base_asset" "quote_asset"

Relationships that may be used for the included parameter.

page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

offer exists

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

get /v3/offers

TokenD Developer Environment

https://api.achilles.tokend.io/v3/offers

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

Order Books

An order book is a list of buy and sell orders for a specified asset pair organized by price level. An order book lists the amount of asset being bid or offered at each price point. It does not identify market participants behind buy and sell orders.

OrderBook by ID Deprecated

Returns the list of placed offers without private details.

path Parameters
id
required
integer <int64>

ID of an order book: 0 for the secondary market and sale ID otherwise

query Parameters
base_asset
string <valid assetCode>
Example:

Base asset of requested offers

quote_asset
string <valid assetCode>
Example:

Quote asset of requested offers

is_buy
number

Defines whether an offer is on buying or selling the base_asset

include
string
Enum: "base_asset" "quote_asset"

Relationships that may be used for the included parameter.

Responses

200

order book exists

400

bad input parameter

404

order book does not exist

get /v3/order_book/{id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/order_book/{id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

OrderBook by ID

Returns the list of placed offers without private details.

path Parameters
id
required
string
Example: BTC:ETH:0

ID of the resource, formatted as base:quote:order_book_id, where order_book_id is 0 for secondary market, sale ID otherwise

query Parameters
max_entries
integer <uint64>
Example: max_entries=10

Defines quantity of entries that will be returned in the response

include
string
Enum: "buy_entries" "sell_entries" "base_asset" "quote_asset"

Relationships that may be used for the included parameter.

Responses

200

order book exists

400

bad input parameter

404

order book does not exist

get /v3/order_books/{id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/order_books/{id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "included":
    [
    ]
}

Crowd Investing

Create Sale Request by ID

Allows getting CreateSale by ID

🔒 Requestor's or reviewer's signature is needed

query Parameters
filter[requestor]
string

Filters requests by requestor - source of the operation.

filter[reviewer]
string

Filters requests by reviewer - account assigned to review requests.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.

filter[request_details.base_asset]
string

Filters create_sale requests by base asset.

filter[request_details.default_quote_asset]
string

Filters create_sale requests by default quote asset.

include
string
Enum: "request_details" "request_details.base_asset" "request_details.default_quote_asset" "request_details.quote_assets"

Relationships that may be used for the included parameter.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

request does not exist

get /v3/create_sale_requests/{id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/create_sale_requests/{id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "included":
    [
    ]
}

Create Sale Request List

Allows getting a filtered list of CreateSaleRequest with details

🔒 Requestor's or reviewer's signature is needed

query Parameters
filter[requestor]
string

Filters requests by requestor - source of the operation.

filter[reviewer]
string

Filters requests by reviewer - account assigned to review requests.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.

filter[request_details.base_asset]
string

Filters sale requests by base asset.

filter[request_details.default_quote_asset]
string

Filters sale requests by a default quote asset.

include
string
Enum: "request_details" "request_details.base_asset" "request_details.default_quote_asset" "request_details.quote_assets"

Relationships that may be used for the included parameter.

page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

requests do not exist

get /v3/create_sale_requests

TokenD Developer Environment

https://api.achilles.tokend.io/v3/create_sale_requests

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

Sale by ID

Allows getting Sale with corresponding details.

path Parameters
id
required
integer <int64>

Unique identifier of a sale

query Parameters
include
string
Example: include=base_asset,default_quote_asset

Relationships that may be used for the included parameter.

Responses

200

sale exists

400

bad input parameter

404

such a sale does not exist

get /v3/sales/{id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/sales/{id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "included":
    [
    ]
}

Sale by ID For Account

Allows getting Sale with corresponding details. 🔒 Account owner's signature is needed

path Parameters
id
required
string

Unique identifier of an account

sale_id
required
integer <int64>

Unique identifier of a sale

query Parameters
include
string
Example: include=base_asset,default_quote_asset

Relationships that may be used for the included parameter.

Responses

200

sale exists

400

bad input parameter

404

sale does not exist or account is not allowed to participate in it

get /v3/accounts/{id}/sales/{sale_id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/accounts/{id}/sales/{sale_id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "included":
    [
    ]
}

Sale List

Allows getting a filtered list of Sale with corresponding details.

query Parameters
filter[owner]
string

Filters sales by a specified owner's account address.

filter[min_start_time]
string <date-time>
Example: filter[min_start_time]=2012-10-30T22:08:41+00:00

Filters sales by a specified minimum start time of the sale.

filter[min_end_time]
string <date-time>
Example: filter[min_end_time]=2012-10-30T22:08:41+00:00

Filters sales by a specified minimum end time of the sale.

filter[max_start_time]
string <date-time>
Example: filter[max_start_time]=2012-10-30T22:08:41+00:00

Filters sales by a specified maximal start time of the sale.

filter[max_end_time]
string <date-time>
Example: filter[max_end_time]=2012-10-30T22:08:41+00:00

Filters sales by a specified maximal end time of the sale.

filter[state]
integer
Example: filter[state]=1

Filters sales by a specified sale state. Available sale states:

  • 1 - open
  • 2 - closed
  • 3 - cancelled
filter[max_soft_cap]
number <float>
Example: filter[max_soft_cap]=1.000000

Filters sales by specified maximum soft cap of the sale.

filter[max_hard_cap]
number <float>
Example: filter[max_hard_cap]=3.000000

Filters sales by specified maximum hard cap of the sale.

filter[min_soft_cap]
number <float>
Example: filter[min_soft_cap]=1.000000

Filters sales by specified minimum soft cap of the sale.

filter[min_hard_cap]
number <float>
Example: filter[min_hard_cap]=3.000000

Filters sales by specified minimum hard cap of the sale.

filter[base_asset]
string
Example: filter[base_asset]=BTC36174

Filters sales by a specified base asset of the sale.

filter[sale_type]
integer
Example: filter[sale_type]=1

Filters sales by a specified sale type. Available sale types:

  • 1 - basic sale
  • 2 - crowdfunding sale
  • 3 - fixed price sale
include
string
Enum: "base_asset" "quote_assets" "default_quote_asset"

Relationships that may be used for the included parameter.

page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

sale exists

400

bad input parameter

get /v3/sales

TokenD Developer Environment

https://api.achilles.tokend.io/v3/sales

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

Sale List For Account

Allows getting a filtered list of Sale with corresponding details into which account can invest. 🔒 Account owner's signature is needed

path Parameters
id
required
string

Unique identifier of an account

query Parameters
filter[owner]
string

Filters sales by a specified owner's account address.

filter[min_start_time]
string <date-time>
Example: filter[min_start_time]=2012-10-30T22:08:41+00:00

Filters sales by a specified minimum start time of the sale.

filter[min_end_time]
string <date-time>
Example: filter[min_end_time]=2012-10-30T22:08:41+00:00

Filters sales by a specified minimum end time of the sale.

filter[max_start_time]
string <date-time>
Example: filter[max_start_time]=2012-10-30T22:08:41+00:00

Filters sales by a specified maximal start time of the sale.

filter[max_end_time]
string <date-time>
Example: filter[max_end_time]=2012-10-30T22:08:41+00:00

Filters sales by a specified maximal end time of the sale.

filter[state]
integer
Example: filter[state]=1

Filters sales by a specified sale state. Available sale states:

  • 1 - open
  • 2 - closed
  • 3 - cancelled
filter[max_soft_cap]
number <float>
Example: filter[max_soft_cap]=1.000000

Filters sales by specified maximum soft cap of the sale.

filter[max_hard_cap]
number <float>
Example: filter[max_hard_cap]=3.000000

Filters sales by specified maximum hard cap of the sale.

filter[min_soft_cap]
number <float>
Example: filter[min_soft_cap]=1.000000

Filters sales by specified minimum soft cap of the sale.

filter[min_hard_cap]
number <float>
Example: filter[min_hard_cap]=3.000000

Filters sales by specified minimum hard cap of the sale.

filter[base_asset]
string
Example: filter[base_asset]=BTC36174

Filters sales by a specified base asset of the sale.

filter[sale_type]
integer
Example: filter[sale_type]=1

Filters sales by a specified sale type. Available sale types:

  • 1 - basic sale
  • 2 - crowdfunding sale
  • 3 - fixed price sale
include
string
Enum: "base_asset" "quote_assets" "default_quote_asset"

Relationships that may be used for the included parameter.

page[cursor]
integer >= 0

Cursor point to the end of the previous page

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

sale exists

400

bad input parameter

get /v3/accounts/{id}/sales

TokenD Developer Environment

https://api.achilles.tokend.io/v3/accounts/{id}/sales

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

Participations for the sale

Allows getting participation for sale.

🔒 Admin or sale owner signature is required.

path Parameters
id
required
integer <int64>
Example: 10

Unique identifier of a sale

query Parameters
filter[participant]
string

Filters sale participation by a specified participants's account address.

filter[quote_asset]
string
Example: filter[quote_asset]=BTC36174

Filters sale participations by a specified quote asset.

include
string
Enum: "base_asset" "quote_asset"

Relationships that may be used for the included parameter.

page[cursor]
integer >= 0

Cursor point to the end of the previous page

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

participation exists

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

sale does not exist

get /v3/sales/{id}/relationships/participation

TokenD Developer Environment

https://api.achilles.tokend.io/v3/sales/{id}/relationships/participation

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

Whitelist for sale

Allows getting whitelist for sale.

🔒 Admin or sale owner signature is required.

path Parameters
id
required
integer <int64>
Example: 10

Unique identifier of a sale

query Parameters
filter[address]
string <valid accountID>
Example: filter[address]=GBSR6JG5AYSAW7HK6EGJFYVIVN54LVGSY3ZLJ6X3IBQZ766EJABCZQTH

Filters entries by account address where they applied

page[cursor]
integer >= 0

Cursor point to the end of the previous page

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

whitelist exists

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

whitelist does not exist

get /v3/sales/{id}/relationships/whitelist

TokenD Developer Environment

https://api.achilles.tokend.io/v3/sales/{id}/relationships/whitelist

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "links":
    {
    }
}

Update Sale Details by ID

Allows getting UpdateSaleDetails by ID

🔒 Requestor's or reviewer's signature is needed

query Parameters
filter[requestor]
string

Filters requests by requestor - source of the operation.

filter[reviewer]
string

Filters requests by reviewer - account assigned to review requests.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.

include
string
Enum: "request_details" "request_details.sale"

Relationships that may be used for the included parameter.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

request does not exist

get /v3/update_sale_details_requests/{id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/update_sale_details_requests/{id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "included":
    [
    ]
}

Update Sale Details List

Allows getting a filtered list of UpdateSaleDetailsRequest with details

🔒 Requestor's or reviewer's signature is needed

query Parameters
filter[requestor]
string

Filters requests by requestor - source of the operation.

filter[reviewer]
string

Filters requests by reviewer - account assigned to review requests.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.

include
string
Enum: "request_details" "request_details.sale"

Relationships that may be used for the included parameter.

page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

requests do not exist

get /v3/update_sale_details_requests

TokenD Developer Environment

https://api.achilles.tokend.io/v3/update_sale_details_requests

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

Matches

Match List

Allows getting a filtered list of Match with corresponding details.

query Parameters
filter[base_asset]
required
string <valid assetCode>
Example: filter[base_asset]=BTC

Filters matches by specified base asset code

filter[quote_asset]
required
string <valid assetCode>
Example: filter[quote_asset]=ETH

Filters matches by specified quote asset code

filter[order_book]
required
number <int64>
Example: filter[order_book]=2

Filters offers by specified order book ID Defines whether offers are for sale or for trade (0 - secondary market, saleId - for specific sale)

page[cursor]
integer >= 0

Cursor point to the end of the previous page

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

matches exist

400

bad input parameter

404

order book does not exist

get /v3/matches

TokenD Developer Environment

https://api.achilles.tokend.io/v3/matches

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included": [ ],
  • "links":
    {
    }
}

Liquidity Pools

Liquidity pool by ID

Allows getting LiquidityPool with corresponding details

path Parameters
id
required
integer <int64>

Unique identifier of a liquidity pool

query Parameters
include
string
Example: include=assets

Relationships that may be used for the included parameter.

Responses

200

Liquidity pool exists

400

Bad input parameter

404

Such a liquidity pool does not exist

get /v3/liquidity-pools/{id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/liquidity-pools/{id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Liquidity pool List

Allows getting a filtered list of LiquidityPool with corresponding details

query Parameters
filter[lp_token]
string

Filters liquidity pools by a specified liquidity pool's token asset code.

filter[asset]
string

Filters liquidity pools by a specified asset from assets pair.

filter[balances_owner]
string

Filters liquidity pools by a balances of the specified account's address.

filter[excluded_assets]
array

Excludes liquidity pools from the filter by asset codes.

include
string
Example: include=assets

Relationships that may be used for the included parameter.

page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

Liquidity pool exists

400

Bad input parameter

get /v3/liquidity-pools

TokenD Developer Environment

https://api.achilles.tokend.io/v3/liquidity-pools

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "links":
    {
    }
}

PreIssuance

PreIssuance Request by ID

Allows getting CreatePreIssuance by ID

🔒 Requestor's or reviewer's signature is needed

query Parameters
filter[requestor]
string

Filters requests by requestor - source of the operation.

filter[reviewer]
string

Filters requests by reviewer - account assigned to review requests.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.

filter[request_details.asset]
string

Filters preissuance create requests by asset code.

include
string
Enum: "request_details" "request_details.asset"

Relationships that may be used for the included parameter.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

request does not exist

get /v3/create_pre_issuance_requests/{id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/create_pre_issuance_requests/{id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "included":
    [
    ]
}

PreIssuance Request List

Allows getting a filtered list of AssetCreateRequest with details

🔒 Requestor's or reviewer's signature is needed

query Parameters
filter[requestor]
string

Filters requests by requestor - source of the operation.

filter[reviewer]
string

Filters requests by reviewer - account assigned to review requests.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.

filter[request_details.asset]
string

Filters preissuance create requests by asset code.

include
string
Enum: "request_details" "request_details.asset"

Relationships that may be used for the included parameter.

page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

requests do not exist

get /v3/create_pre_issuance_requests

TokenD Developer Environment

https://api.achilles.tokend.io/v3/create_pre_issuance_requests

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

KeyValue

KeyValueEntry by ID

Allows getting KeyValueEntry with corresponding details.

path Parameters
key
required
string
Example: max_contracts_count

Unique identifier of the key-value entry

Responses

200

key-value entry exists

400

bad input parameter

404

key-value entry does not exist

get /v3/key_values/{key}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/key_values/{key}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

KeyValueEntry List

Allows getting KeyValueEntry with corresponding details.

query Parameters
page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

KeyValue entries exist

400

bad input parameter

get /v3/key_values

TokenD Developer Environment

https://api.achilles.tokend.io/v3/key_values

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included": [ ],
  • "links":
    {
    }
}

License

Current license info

Allows getting current license information

Responses

200

succesfully retrieved license

503

server overloaded

get /v3/license

TokenD Developer Environment

https://api.achilles.tokend.io/v3/license

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "id": "12",
  • "type": "license-info",
  • "attributes":
    {
    }
}

Data

Data By ID

Allows getting Data resource by ID.

query Parameters
include
string
Value: "owner"

Relationships that may be used for the included parameter.

Responses

200
400

bad input parameter

get /v3/data/{id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/data/{id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "included":
    [
    ]
}

Data Creation Request List

Allows getting a filtered list of data creation requests with details

🔒 Requestor's or reviewer's signature is needed

query Parameters
filter[requestor]
string

Filters requests by requestor - source of the operation.

filter[reviewer]
string

Filters requests by reviewer - account assigned to review requests.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.

include
string
Value: "request_details"

Relationships that may be used for the included parameter.

page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

requests do not exist

get /v3/data_creation_requests

TokenD Developer Environment

https://api.achilles.tokend.io/v3/data_creation_requests

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

Data List

Allows getting list of Data resources.

query Parameters
filter[type]
string

Filter data by its security type

filter[owner]
string

Filter data by its owner

include
string
Value: "owner"

Relationships that may be used for the included parameter.

page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200
400

bad input parameter

get /v3/data

TokenD Developer Environment

https://api.achilles.tokend.io/v3/data

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included":
    [
    ]
}

Data Owner Update Request

Allows getting a data owner update requests with details

🔒 Requestor's or reviewer's signature is needed

query Parameters
filter[requestor]
string

Filters requests by requestor - source of the operation.

filter[reviewer]
string

Filters requests by reviewer - account assigned to review requests.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.

include
string
Value: "request_details"

Relationships that may be used for the included parameter.

page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

requests do not exist

get /v3/data_owner_update_requests/{id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/data_owner_update_requests/{id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "included":
    [
    ]
}

Data Owner Update Request List

Allows getting a filtered list of data owner update requests with details

🔒 Requestor's or reviewer's signature is needed

query Parameters
filter[requestor]
string

Filters requests by requestor - source of the operation.

filter[reviewer]
string

Filters requests by reviewer - account assigned to review requests.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.

include
string
Value: "request_details"

Relationships that may be used for the included parameter.

page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

requests do not exist

get /v3/data_owner_update_requests

TokenD Developer Environment

https://api.achilles.tokend.io/v3/data_owner_update_requests

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

Data Remove Request List

Allows getting a filtered list of data remove requests with details

🔒 Requestor's or reviewer's signature is needed

query Parameters
filter[requestor]
string

Filters requests by requestor - source of the operation.

filter[reviewer]
string

Filters requests by reviewer - account assigned to review requests.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.

include
string
Value: "request_details"

Relationships that may be used for the included parameter.

page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

requests do not exist

get /v3/data_remove_requests

TokenD Developer Environment

https://api.achilles.tokend.io/v3/data_remove_requests

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

Data Update Request List

Allows getting a filtered list of data update requests with details

🔒 Requestor's or reviewer's signature is needed

query Parameters
filter[requestor]
string

Filters requests by requestor - source of the operation.

filter[reviewer]
string

Filters requests by reviewer - account assigned to review requests.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.

include
string
Value: "request_details"

Relationships that may be used for the included parameter.

page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

requests do not exist

get /v3/data_update_requests

TokenD Developer Environment

https://api.achilles.tokend.io/v3/data_update_requests

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

Polls

Create Poll Request by ID

Allows getting CreatePoll by ID

🔒 Requestor's or reviewer's signature is needed

query Parameters
filter[requestor]
string

Filters requests by requestor - source of the operation.

filter[reviewer]
string

Filters requests by reviewer - account assigned to review requests.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.

filter[request_details.permission_type]
uint64

Filters create_poll requests by permission type.

filter[request_details.vote_confirmation_required]
boolean

Filters create_poll requests by vote_confirmation_required property.

include
string
Value: "request_details"

Relationships that may be used for the included parameter.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

request does not exist

get /v3/create_poll_requests/{id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/create_poll_requests/{id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "included":
    [
    ]
}

Create Poll Request List

Allows getting a filtered list of CreatePollRequest with details

🔒 Requestor's or reviewer's signature is needed

query Parameters
filter[requestor]
string

Filters requests by requestor - source of the operation.

filter[reviewer]
string

Filters requests by reviewer - account assigned to review requests.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.

filter[request_details.result_provider]
string

Filters poll requests by result provider.

filter[request_details.vote_confirmation_required]
string

Filters poll requests by a voteConfirmationRequired property.

filter[request_details.permission_type]
string

Filters poll requests by permission type.

include
string
Value: "request_details"

Relationships that may be used for the included parameter.

page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

requests do not exist

get /v3/create_poll_requests

TokenD Developer Environment

https://api.achilles.tokend.io/v3/create_poll_requests

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

Poll by ID

Allows getting Poll with corresponding details.

🔒 Admin, poll result provider or poll owner signature is required if outcome should be included.

path Parameters
id
required
integer <int64>
Example: 10

Unique identifier of a poll

query Parameters
include
string
Enum: "participation" "participation.votes"

Relationships that may be used for the included parameter.

Responses

200

poll exists

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

poll does not exist

get /v3/polls/{id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/polls/{id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "included": [ ]
}

Polls list

Allows getting a filtered list of Polls with corresponding details.

🔒 Depending on the case, different signatures are required:

  1. if no filters are applied, admin signature is required.

  2. if filter by owner is applied, signature of owner is required

query Parameters
filter[owner]
string <valid accountID>
Example: filter[owner]=GAULFBQKQTFHHHZEIRMYVCGTY47FKWEW7P2BY2YT45HAEODAIJUJH23T

Filters polls by specified owner id

filter[result_provider]
string <valid accountID>
Example: filter[result_provider]=GBULFBQKQTFHHHZEIRMYVCGTY47FKWEW7P2BY2YT45HAEODAIJUJH23E

Filters polls by specified result provider id

filter[permission_type]
any

Filters polls by specified permission type

filter[poll_type]
integer
Example: filter[poll_type]=0

Filters polls by a specified poll type. Available poll types:

  • 0 - single choice
filter[vote_confirmation]
boolean
Example: filter[vote_confirmation]=false

Filters polls by VoteConfirmationRequired property

filter[min_start_time]
string <date-time>
Example: filter[min_start_time]=2012-10-30T22:08:41+00:00

Filters polls by a specified minimum start time of the poll.

filter[min_end_time]
string <date-time>
Example: filter[min_end_time]=2012-10-30T22:08:41+00:00

Filters polls by a specified minimum end time of the poll.

filter[max_start_time]
string <date-time>
Example: filter[max_start_time]=2012-10-30T22:08:41+00:00

Filters polls by a specified maximal start time of the poll.

filter[max_end_time]
string <date-time>
Example: filter[max_end_time]=2012-10-30T22:08:41+00:00

Filters polls by a specified maximal end time of the poll.

filter[state]
integer
Example: filter[state]=1

Filters polls by a specified poll state. Available poll states:

  • 1 - open
  • 2 - passed
  • 3 - failed
  • 4 - cancelled
page[cursor]
integer >= 0

Cursor point to the end of the previous page

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

polls exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

get /v3/polls

TokenD Developer Environment

https://api.achilles.tokend.io/v3/polls

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included": [ ],
  • "links":
    {
    }
}

Vote by ID

Allows getting Vote with corresponding details.

🔒 Admin, voter, poll owner or poll result provider signature is required.

path Parameters
id
required
integer <int64>
Example: 10

Unique identifier of a poll

voter
required
string
Example: GAULFBQKQTFHHHZEIRMYVCGTY47FKWEW7P2BY2YT45HAEODAIJUJH23T

Unique identifier of a voter account

query Parameters
include
string
Value: "poll"

Relationships that may be used for the included parameter.

Responses

200

vote exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

vote does not exist

get /v3/polls/{id}/relationships/votes/{voter}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/polls/{id}/relationships/votes/{voter}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "included":
    [
    ]
}

Votes of specific voter

Allows getting a filtered list of Votes with corresponding details.

🔒 Admin or voter signature is required.

path Parameters
voter
required
string
Example: GA67BUDBYDGCVCL6EKPDAREG5IPLHSROF6QJX7MLS2BQJZJDO6FCZAKE

address of voter account

query Parameters
include
string
Enum: "polls" "account"

Relationships that may be used for the included parameter.

  • polls will include all the polls related to votes
  • account will include voter account
page[cursor]
integer >= 0

Cursor point to the end of the previous page

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

votes exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

get /v3/votes/{voter}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/votes/{voter}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

Votes list

Allows getting a filtered list of Votes with corresponding details.

🔒 Admin, poll result provider or poll owner signature is required.

path Parameters
id
required
integer <int64>
Example: 10

Unique identifier of a poll

query Parameters
include
string
Value: "poll"

Relationships that may be used for the included parameter.

page[cursor]
integer >= 0

Cursor point to the end of the previous page

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

votes exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

get /v3/polls/{id}/relationships/votes

TokenD Developer Environment

https://api.achilles.tokend.io/v3/polls/{id}/relationships/votes

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

Requests

Create Payment Request by ID

Allows getting CreatePayment request by ID

🔒 Requestor's or reviewer's signature is needed

query Parameters
filter[requestor]
string

Filters requests by requestor - source of the operation.

filter[reviewer]
string

Filters requests by reviewer - account assigned to review requests.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.

include
string
Value: "request_details"

Relationships that may be used for the included parameter.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

request does not exist

get /v3/create_payment_requests/{id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/create_payment_requests/{id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "included":
    [
    ]
}

Create Payment Request List

Allows getting a filtered list of CreatePayment with details

🔒 Requestor's or reviewer's signature is needed

query Parameters
filter[requestor]
string

Filters requests by requestor - source of the operation.

filter[reviewer]
string

Filters requests by reviewer - account assigned to review requests.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.

include
string
Value: "request_details"

Relationships that may be used for the included parameter.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

request does not exist

get /v3/create_payment_requests

TokenD Developer Environment

https://api.achilles.tokend.io/v3/create_payment_requests

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "included":
    [
    ]
}

Manage Offer Request by ID

Allows getting ManageOffer requests by ID

🔒 Requestor's or reviewer's signature is needed

query Parameters
filter[requestor]
string

Filters requests by requestor - source of the operation.

filter[reviewer]
string

Filters requests by reviewer - account assigned to review requests.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.

include
string
Value: "request_details"

Relationships that may be used for the included parameter.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

request does not exist

get /v3/manage_offer_requests/{id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/manage_offer_requests/{id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "included":
    [
    ]
}

Manage Offer Request List

Allows getting a filtered list of ManageOffer with details

🔒 Requestor's or reviewer's signature is needed

query Parameters
filter[requestor]
string

Filters requests by requestor - source of the operation.

filter[reviewer]
string

Filters requests by reviewer - account assigned to review requests.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.

include
string
Value: "request_details"

Relationships that may be used for the included parameter.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

request does not exist

get /v3/manage_offer_requests

TokenD Developer Environment

https://api.achilles.tokend.io/v3/manage_offer_requests

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "included":
    [
    ]
}

Reviewable Request by ID

Allows getting ReviewableRequest by ID

🔒 Requestor's or reviewer's signature is needed

query Parameters
include
string
Value: "request_details"

Relationships that may be used for the included parameter.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

request does not exist

get /v3/requests/{id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/requests/{id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included":
    {
    }
}

Reviewable Request List

Allows getting a filtered list of ReviewableRequest with details

🔒 Requestor's or reviewer's signature is needed

query Parameters
filter[requestor]
string

Filters requests by requestor - source of the operation.

filter[reviewer]
string

Filters requests by reviewer - account assigned to review requests.

filter[state]
integer [ 1 .. 5 ]

Filters requests by their state.

  • 1 - pending
  • 2 - canceled
  • 3 - approved
  • 4 - rejected
  • 5 - permanently_rejected
filter[type]
integer [ 2 .. 17 ]

Filters requests by their type.

  • 2 - "create_pre_issuance"
  • 3 - "create_issuance"
  • 4 - "create_withdraw"
  • 5 - "create_sale"
  • 6 - "update_limits"
  • 7 - "create_aml_alert"
  • 8 - "change_role"
  • 9 - "update_sale_details"
  • 10 - "create_asset"
  • 11 - "create_invoice"
  • 12 - "manage_contract"
  • 13 - "update_asset"
  • 16 - "create_atomic_swap_bid"
  • 17 - "create_atomic_swap"
  • 18 - "kyc_recovery"
  • 19 - "manage_offer"
  • 20 - "create_payment"
  • 21 - "perform_redemption"
filter[pending_tasks]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.

filter[pending_tasks_not_set]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.

filter[pending_tasks_any_of]
integer

Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.

filter[all_tasks]
integer

Filters requests by existing tasks in all_tasks bit mask. Returns requests if all bits are set.

filter[all_tasks_not_set]
integer

Filters requests by existing tasks in all_tasks bit mask. Returns requests if none of bits is set.

filter[all_tasks_any_of]
integer

Filters requests by existing tasks in all_tasks bit mask. Returns requests if at least one bit is set.

filter[created_before]
integer <UTC Unix Timestamp>

Filters requests by creation timestamp earlier than passed value in filter (exclusively).

filter[updated_before]
integer <UTC Unix Timestamp>

Filters requests by update timestamp earlier than passed value in filter (exclusively).

include
string
Value: "request_details"

Relationships that may be used for the included parameter.

page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

requests exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

requests do not exist

get /v3/requests

TokenD Developer Environment

https://api.achilles.tokend.io/v3/requests

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

History

Get history

Allows to get a filtered list of participants effects

query Parameters
filter[effect]
string

Filter by effect type

filter[account]
string

Filters history by participant account address

filter[balance]
string

Filters history by participant's balance

filter[asset]
string

Filters history by involved asset

include
string
Enum: "effect" "operation" "operation.details" "asset"

Relationships may be used for the included parameter.

page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

history exists

400

bad input parameter

404

effects do not exist

get /v3/history

TokenD Developer Environment

https://api.achilles.tokend.io/v3/history

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

Get movements

Allows to get a filtered list of participants effects related to balances only - movements

🔒 Permissions:

Filters Signature
- admin
filter[asset] admin or asset owner
filter[balance], filter[account] admin or account owner
query Parameters
filter[account]
string

Filters movements by participant account address

filter[balance]
string

Filters movements by participant's balance

filter[asset]
string

Filters movements by involved asset

include
string
Enum: "effect" "operation" "operation.details" "asset"

Relationships may be used for the included parameter.

page[number]
integer >= 0

Page number to return.

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

movements exist

400

bad input parameter

404

operations do not exist

get /v3/movements

TokenD Developer Environment

https://api.achilles.tokend.io/v3/movements

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

Get operation

Allows to get operation

🔒 Admin account's signature is required.

query Parameters
include
string
Value: "operation.details"

Relationships may be used for the included parameter.

Responses

200

operations exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

does not exist

get /v3/operations/{id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/operations/{id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "included":
    [
    ]
}

Get operations

Allows to get a filtered list of operations

🔒 Admin account's signature is required.

query Parameters
filter[types]
integer [ 2 .. 55 ]

Filters operations by types (comma-separated multiple values are supported). All operation types can be found here

filter[source]
string

Filters operations by source account id.

include
string
Value: "operation.details"

Relationships may be used for the included parameter.

page[cursor]
integer >= 0

Cursor point to the end of the previous page

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

operations exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

get /v3/operations

TokenD Developer Environment

https://api.achilles.tokend.io/v3/operations

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

Get transaction

Allows to get transaction by ID or Hash

🔒 Admin account's signature is required.

path Parameters
id
required
string

ID or Hash of the transaction

query Parameters
include
string
Value: "ledger_entry_changes"

Relationships may be used for the included parameter.

Responses

200

transaction exists

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

such transaction does not exist

get /v3/transactions/{id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/transactions/{id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "included":
    [
    ]
}

Get transactions

Allows to get a filtered list of transactionsa

🔒 Admin account's signature is required.

query Parameters
filter[ledger_entry_changes.entry_types]
integer [ 2 .. 35 ]

Filters transactions by ledger entry type they affected (comma-separated multiple values are supported):

  • 2 - account
  • 3 - signer
  • 4 - fee
  • 5 - balance
  • 6 - payment_request
  • 7 - asset
  • 8 - reference_entry
  • 9 - statistics
  • 10 - trust
  • 11 - account_limits
  • 12 - asset_pair
  • 13 - offer_entry
  • 15 - reviewable_request
  • 16 - external_system_account_id
  • 17 - sale
  • 18 - account_kyc
  • 19 - external_system_account_id_pool_entry
  • 20 - key_value
  • 22 - limits_v2
  • 23 - statistics_v2
  • 24 - pending_statistics
  • 25 - contract
  • 26 - account_role
  • 27 - account_rule
  • 28 - atomic_swap_bid
  • 29 - transaction
  • 30 - signer_rule
  • 31 - signer_role
  • 32 - stamp
  • 33 - license
  • 34 - poll
  • 35 - vote
filter[ledger_entry_changes.change_types]
integer [ 0 .. 3 ]

description: | Filters transactions by ledger entry change type they performed (comma-separated multiple values are supported):

  • 0 - created
  • 1 - updated
  • 2 - removed
  • 3 - state
include
string
Value: "ledger_entry_changes"

Relationships may be used for the included parameter.

page[cursor]
integer >= 0

Cursor point to the end of the previous page

page[limit]
integer [ 1 .. 100 ]
Default: 15

Numbers of items per page to return.

page[order]
string
Default: "asc"
Enum: "asc" "desc"

Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.

Responses

200

transactions exist

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

get /v3/transactions

TokenD Developer Environment

https://api.achilles.tokend.io/v3/transactions

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "included":
    [
    ],
  • "links":
    {
    }
}

Public Key Entries

Public Key Entry By ID

Returns the requested public key with accounts that have signer with such public key

🔒 Admins or public key owner signature is needed

path Parameters
id
required
string

ID of entry (the public key itself)

Responses

200

public key entry exists

400

bad input parameter

401

either an invalid signature has been provided or a signer has not been authorized to access specified resources

404

public key entry not found

get /v3/public_keys/{id}

TokenD Developer Environment

https://api.achilles.tokend.io/v3/public_keys/{id}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "included": [ ]
}

Info

Horizon info Deprecated

Allows getting basic info about horizon

Responses

200

succesfully retrieved page

503

server overloaded

get /

TokenD Developer Environment

https://api.achilles.tokend.io/

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "ledger_state":
    {
    },
  • "network_passphrase": "example network passphrase",
  • "admin_account_id": "GBA4EX43M25UPV4WIE6RRMQOFTWXZZRIPFAI5VPY6Z2ZVVXVWZ6NEOOB",
  • "master_exchange_name": "TokenD",
  • "tx_expiration_period": 0,
  • "current_time": 0,
  • "precision": 0,
  • "xdr_revision": "7e0659466026577a3ea90ff178773fecc4a85dec"
}

Horizon info

Allows getting basic info about horizon state and it's dependensies

Responses

200

succesfully retrieved state

503

server overloaded

get /v3/info

TokenD Developer Environment

https://api.achilles.tokend.io/v3/info

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "id": "2019-03-04T18:42:15Z",
  • "type": "horizon-state",
  • "attributes":
    {
    }
}

Submit

Submit transaction

Allows to submit transaction to the network

Request Body schema: application/json
tx
required
string

base-64 encoded XDR representation of transaction itself

wait_for_ingest
boolean
Default: false

defines whether to wait for ingest of transaction or not

wait_for_result
boolean
Default: true

EXPERIMENTAL: defines whether we need to wait for result of transaction or not. NOTE: it is not allowed to set wait_for_ingest = true and wait_for_result = false.

Responses

200

successfully submitted

400

bad input parameter

408

request has timed out

500

internal server error

post /v3/transactions

TokenD Developer Environment

https://api.achilles.tokend.io/v3/transactions

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tx": "AAAAAEHCX5tmu0fXlkE9GLIOLO185ih5QI7V+PZ1mtb1tnzSA59veKFdUjsAAAAAAAAAAAAAAABchp31A...",
  • "wait_for_ingest": false,
  • "wait_for_result": true
}

Response samples

Content type
application/vnd.api+json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}