List shares holding

get /v1/{tenantName}/shares/{tokenAddress}/holdings

List of the shareholders for a token or partition.

tenantName

string

required

The name of the tenant.

tokenAddress

string

required

partitionHash

string

Response

Examples Schema

Successful operation

[
  {
    "holder": {
      "property1": "value1",
      "property2": "value2",
      "property3": 100,
      "property4": true
    },
    "holderAddress": "string",
    "percent": 123.0,
    "shares": [
      {}
    ],
    "totalShares": 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

holder

object (holder)

Represents a dynamic key value object.

Example
{ "property1": "value1", "property2": "value2", "property3": 100, "property4": true }

holderAddress

string

percent

number

shares

array[object]

object

totalShares

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 shares tranche history

get /v1/{tenantName}/shares/{tokenAddress}/tranches

History of the tranches of a token or partition.

tenantName

string

required

The name of the tenant.

tokenAddress

string

required

partitionHash

string

Response

Examples Schema

Successful operation

[
  {
    "createdAt": 123.0,
    "id": 123.0,
    "outdatedAt": 123.0,
    "owner": {
      "property1": "value1",
      "property2": "value2",
      "property3": 100,
      "property4": true
    },
    "ownerAddress": "string",
    "partitionHash": "string",
    "prevOwner": {
      "property1": "value1",
      "property2": "value2",
      "property3": 100,
      "property4": true
    },
    "prevOwnerAddress": "string",
    "prevTrancheId": 123.0,
    "tokenAddress": "string",
    "trancheEnd": 123.0,
    "trancheOrigin": "Bought",
    "trancheStart": 123.0,
    "trancheState": "Burned"
  }
]

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

createdAt

number

id

number

outdatedAt

number

owner

object (owner)

Represents a dynamic key value object.

Example
{ "property1": "value1", "property2": "value2", "property3": 100, "property4": true }

ownerAddress

string

partitionHash

string

prevOwner

object (prevOwner)

Represents a dynamic key value object.

Example
{ "property1": "value1", "property2": "value2", "property3": 100, "property4": true }

prevOwnerAddress

string

prevTrancheId

number

tokenAddress

string

trancheEnd

number

trancheOrigin

string

The origin of the tranche

  • "Bought": Related to purchase.
  • "Issued": Related to issuance.
  • "Withdrawn": Related to withdrawal.
Enum
  • Bought
  • Issued
  • Withdrawn

trancheStart

number

trancheState

string

The state of the tranche

  • "Burned": Tranche has been removed.
  • "Current": Tranche is active.
  • "Outdated": Tranche has been outdated.
  • "Remained": Tranche is the result of a previous split.
  • "Updated": Tranche has been updated.
Enum
  • Burned
  • Current
  • Outdated
  • Remained
  • Updated

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?