Get timelock

get /v1/{tenantName}/modules/{address}/timelock

tenantName

string

required

The name of the tenant.

address

string

required

Response

Examples Schema

Successful operation

{
  "address": "string",
  "time": 123.0
}

causes:

  • schema not followed properly.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

causes:

  • authorization check failed.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

causes:

  • internal server error.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

address

string

time

number

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

List timelock accounts

get /v1/{tenantName}/modules/{address}/timelock/accounts

tenantName

string

required

The name of the tenant.

address

string

required

filter

string

limit

number

offset

number

orderBy

string

Response

Examples Schema

Successful operation

[
  {
    "account": "string",
    "address": "string",
    "time": 123.0
  }
]

causes:

  • schema not followed properly.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

causes:

  • authorization check failed.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

causes:

  • internal server error.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

array[object]

object

account

string

address

string

time

number

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

Get timelock account

get /v1/{tenantName}/modules/{address}/timelock/accounts/{account}

tenantName

string

required

The name of the tenant.

address

string

required

account

string

required

Response

Examples Schema

Successful operation

{
  "account": "string",
  "address": "string",
  "time": 123.0
}

causes:

  • schema not followed properly.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

causes:

  • authorization check failed.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

causes:

  • internal server error.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

account

string

address

string

time

number

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

List timelock amounts

get /v1/{tenantName}/modules/{address}/timelock/amounts

tenantName

string

required

The name of the tenant.

address

string

required

filter

string

limit

number

offset

number

orderBy

string

Response

Examples Schema

Successful operation

[
  {
    "account": "string",
    "address": "string",
    "amount": 123.0,
    "time": 123.0
  }
]

causes:

  • schema not followed properly.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

causes:

  • authorization check failed.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

causes:

  • internal server error.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

array[object]

object

account

string

address

string

amount

number

time

number

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

Get timelock amount

get /v1/{tenantName}/modules/{address}/timelock/amounts/{account}

tenantName

string

required

The name of the tenant.

address

string

required

account

string

required

Response

Examples Schema

Successful operation

{
  "account": "string",
  "address": "string",
  "amount": 123.0,
  "time": 123.0
}

causes:

  • schema not followed properly.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

causes:

  • authorization check failed.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

causes:

  • internal server error.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

account

string

address

string

amount

number

time

number

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

Get vesting

get /v1/{tenantName}/modules/{address}/vesting

tenantName

string

required

The name of the tenant.

address

string

required

Response

Examples Schema

Successful operation

{
  "address": "string",
  "vestedFractionAfterStart": 123.0,
  "vestingRatio": 123.0,
  "vestingStart": 123.0
}

causes:

  • schema not followed properly.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

causes:

  • authorization check failed.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

causes:

  • internal server error.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

address

string

vestedFractionAfterStart

number

vestingRatio

number

vestingStart

number

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

List whitelisted addresses

get /v1/{tenantName}/modules/{address}/whitelist

Retrieve the whitelist associated with a specific module's address. Whitelists control access to token-related activities. Access the list of addresses permitted for activities within a particular module.

tenantName

string

required

The name of the tenant.

address

string

required

filter

string

limit

number

offset

number

orderBy

string

Response

Examples Schema

Successful operation

[
  {
    "account": "string",
    "module": "string",
    "whitelisted": true
  }
]

causes:

  • schema not followed properly.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

causes:

  • authorization check failed.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

causes:

  • internal server error.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

array[object]

object

account

string

module

string

whitelisted

boolean

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

Get whitelisted account

get /v1/{tenantName}/modules/{address}/whitelist/{account}

Obtain the whitelist status for a specific account or address. Check whether an address is included in the whitelist of a module, determining its eligibility for token-related actions.

tenantName

string

required

The name of the tenant.

address

string

required

account

string

required

Response

Examples Schema

Successful operation

{
  "account": "string",
  "module": "string",
  "whitelisted": true
}

causes:

  • schema not followed properly.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

causes:

  • authorization check failed.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

causes:

  • internal server error.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

account

string

module

string

whitelisted

boolean

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

Was this page helpful?