Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.pipevest.com/llms.txt

Use this file to discover all available pages before exploring further.

Investment Types represent the bucket of different financial products that are available for trade on the Pipevest platform. This document will guide you on how to get investment type details.

​
Retrieving Investment Types

When requesting investment types details you can do so either by getting:
  • A list of investment types
  • An investment type by a given Id

​
List of Investment Types

Make a GET request to /investments.
  curl --request GET \
    --url https://api.pipevest.com/v1/investments\
    --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.

​
Investment Type by Id

Make a GET request to /investments/{investmentId} 
  curl --request GET \
    --url https://api.pipevest.com/v1/investments/123456\
    ...

​
Entity Reference

PropertyDefinition
investmentIdUnique investment identifier
investmentTypeInvestment type associated with the account
isAvailableDetermines whether the instrument is available for trading
createdAtCreated at unix timestamp
updatedAtUpdated at unix timestamp

​
Investment Types

Only INTERNATIONAL_STOCKS is currently available for trade.
NameAvailableDefinition
INTERNATIONAL_STOCKSYesAllows trading of international equities and stocks
COMMODITYNoAllows trading of raw materials and basic resources (i.e. - Gold, Mining, Agricultural Products)
BONDSNoAllows trading of bonds
LOCAL_STOCKSNoAllows trading of local equities and stocks
FOREIGN_EXCHANGENoAllows trading of fiat currencies
CRYPTONoAllows trading of crypto currencies

​
Webhook Subscriptions

SubscriptionDefinitionDomain
INVESTMENT_TYPEOnly events that deal with investment typesInvestments
INVESTMENT_TYPE.CREATEDTriggered when an investment type is createdInvestments
INVESTMENT_TYPE.UPDATEDTriggered when an investment type is updated or there is newsInvestments