Instruments

Planned — on our roadmap. This capability is documented so you can design your integration ahead of time. It is not yet enabled to call; for initial go-live, investment flows transact via USSD. If it is part of your integration plan, contact us. See what’s available today.

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

Tip

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' \

Note

This endpoint can be paginated and sorted.

Account by Id

Tip

Make a GET request to /instruments/{symbol}

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

Entity Reference

Property	Definition
instrumentId	Unique instrument identifier
name	Unique customer identifier
symbol	The symbol associated by the instrument
investmentId	Unique investment identifier
isAvailable	Determines whether the instrument is available for trading
valueChangeOverTime	Instruments performance over a given time period.
fractionalEnabled	Determines whether the instrument can be fractionally traded
createdAt	Created at unix timestamp
updatedAt	Updated at unix timestamp

Webhook Subscriptions

Subscription	Definition	Domain
INSTRUMENT	Only events that deal with instruments	Instruments
INSTRUMENT.CREATED	Triggered when an instrument is created	Instruments
INSTRUMENT.UPDATED	Triggered when an instrument is updated	Instruments