PIpismo
Quotas

List asset quotas

Retrieves asset quotas by asset ID. A quota is the number of asset shares. One asset can consist of a single share or multiple shares.

get/v1/issuer/{issuer_id}/assets/{asset_id}/quotas

Request

  • Base URL
    https://sandbox.pismolabs.io/assets-accrual
  • URL
    https://sandbox.pismolabs.io/assets-accrual/v1/issuer/{issuer_id}/assets/{asset_id}/quotas
  • Auth
    HTTP bearer

Path parameters

issuer_idstring required

Issuer ID. For more information, refer to issuer identification number

asset_idstring required

Client assigned asset ID. Must consist of the characters [a-z,A-Z,0-9,-,:] with a range from 1 to 128.

Query parameters

pageinteger required

Page number, default is 1.

perPageinteger required

Number of items per page, default is 10.

Headers

x-cidstring

The Correlation IDentifier field is used to link related API requests and events. The x-cid can help the Pismo engineering team track everything related to a call. You can find the x-cid field in the response header from an API endpoint call.

If this field isn't passed, one is automatically generated.

Response

OK

current_pagenumber

Current page

per_pageinteger

Number of items per page, default is 10.

pagesinteger

Total number of pages, default is 1.

total_itemsnumber

Total number of items

Example response

{
  "current_page": 1,
  "per_page": 1,
  "pages": 1,
  "total_items": 1,
  "items": [
    {
      "asset_id": "6ea8094b-73ba-4737-93ad-370c27c54813",
      "quota_id": "c2d581cb-5c9c-40ab-8783-724feb372132",
      "issuer_id": "98400-0-0d",
      "units": 20,
      "redeemed_units": 10,
      "created_at": "2023-03-30T12:26:41",
      "customer_type": "natural",
      "document_number": "123412341234",
      "deposit_number": 567339022
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.