Assets contain ownership and performance data for a given instrument that a customer owns. Additionally,

An Asset can belong to both an Account and a Portfolio.

This document will guide you on how to get account details. Additionally, on how to add an asset to a portfolio

​
Retrieving Assets

When requesting account details you can do so either by getting:

  • A list of assets
  • An account by a given Id

​
List of Assets

Make a GET request to /assets.

  curl --request GET \
    --url https://api.pipevest.com/v1/assets?customerId=123456\
    --header 'Authorization: Bearer 123456' \
    --header 'Signature: sig1=:OTEyMjY4...A5NTNDMEQ=:' \
    --header 'Signature-Input: sig1=("Authorization" "Content-Digest" "Content-Length" "Content-Type" "X-Client-Id" "X-Idempotency-Key" "@method" "@target-uri" "@path" "@query");keyid="staging-pipevest-ed25519";created=1732893484;expires=1732893584' \
    --header 'X-Client-Id: 123456' \
This endpoint can be paginated and sorted.

​
Flitering Assets List

  • accountId
  curl --request GET \
    --url https://api.pipevest.com/v1/assets?customerId=123456&accountId=123456\
    ...
  • portfolioId
  curl --request GET \
    --url https://api.pipevest.com/v1/assets?customerId=123456&portfolioId=123456\
    ...

​
Asset by Id

Make a GET request to /assets/{assetId} 

  curl --request GET \
    --url https://api.pipevest.com/v1/assets/123456\
    ...

​
Adding an Asset to a Portfolio:

When an asset is created is it automatically associated with an Account. However, you can also explicitly associate the asset to a Portfolio

Make a POST request to /portfolio/assets

  curl --request POST \
    --url https://api.pipevest.com/v1/portfolio/assets\
    --header 'Authorization: Bearer 123456' \
    --header 'Content-Digest: sha-512=:RK/0qy18MlBSVnWgjwz6lZEWjP/lF5HF9bvEF8FabDg=:' \
    --header 'Content-Length: 18' \
    --header 'Content-Type: application/json' \
    --header 'Signature: sig1=:OTEyMjY4...A5NTNDMEQ=:' \
    --header 'Signature-Input: sig1=("Authorization" "Content-Digest" "Content-Length" "Content-Type" "X-Client-Id" "X-Idempotency-Key" "@method" "@target-uri" "@path" "@query");keyid="staging-pipevest-ed25519";created=1732893484;expires=1732893584' \
    --header 'X-Client-Id: 123456' \
    --header 'X-Idempotency-Key: 123456' \
    ...
    --data '{"customerId": 123456, "portfolioId": 123456, "assetId": 123456}'

​
Entity Reference

PropertyDefinition
assetIdUnique asset identifier
instrumentIdUnique instrument identifier
customerIdUnique customer identifier
nameThe display name of the asset
symbolThe symbol associated by the asset
investmentAmountThe total amount invested into an asset or group of assets
currencyAssociated currency
positionThe total quantity of the asset currently owned by the customer
lockedThe quantity of the asset currently locked in for trading
availableThe quantity of the asset currently available for trading
purchasePriceThe value of 1 unit of the asset during initial purchase
marketPriceThe current market price of 1 unit of the asset
createdAtCreated at unix timestamp
updatedAtUpdated at unix timestamp

​
Webhook Subscriptions

SubscriptionDefinitionDomain
ASSETOnly events that deal with assetsAssets
ASSET.CREATEDTriggered when an asset is createdAssets
ASSET.UPDATEDTriggered when an asset is updatedAssets