Instruments are the individual products that can be traded for a given Investment Type. This document will guide you on how to get instrument details.

​
Retrieving Instruments

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

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

​
List of instruments

Make a GET request to /instruments.

  curl --request GET \
    --url https://api.pipevest.com/v1/instruments?investmentType=INTERNATIONAL_STOCKS\
    --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.

​
Account by Id

Make a GET request to /instruments/{symbol} 

  curl --request GET \
    --url https://api.pipevest.com/v1/instruments/APPL\
    ...

​
Entity Reference

PropertyDefinition
instrumentIdUnique instrument identifier
nameUnique customer identifier
symbolThe symbol associated by the instrument
investmentIdUnique investment identifier
isAvailableDetermines whether the instrument is available for trading
valueChangeOverTimeInstruments performance over a given time period.
fractionalEnabledDetermines whether the instrument can be fractionally traded
createdAtCreated at unix timestamp
updatedAtUpdated at unix timestamp

​
Webhook Subscriptions

SubscriptionDefinitionDomain
INSTRUMENTOnly events that deal with instrumentsInstruments
INSTRUMENT.CREATEDTriggered when an instrument is createdInstruments
INSTRUMENT.UPDATEDTriggered when an instrument is updatedInstruments