Skip to main content
GET
/
instruments
/
{symbol}
Returns details of a given instrument
curl --request GET \
  --url https://api.pipevest.com/v1/instruments/{symbol} \
  --header 'Authorization: Bearer <token>' \
  --header 'Signature: <signature>' \
  --header 'Signature-Input: <signature-input>' \
  --header 'X-Client-Id: <x-client-id>'
{
  "data": {
    "instrumentId": 123456,
    "name": "Apple Inc.",
    "symbol": "APPL",
    "investmentId": 123456,
    "isAvailable": true,
    "createdAt": 1234567890,
    "updatedAt": 1234567890,
    "valueChangeOverTime": [
      {
        "timeFrame": "1D",
        "percentChange": 1.5,
        "summary": "Asset has changed by 1.5% over the past 1 day"
      }
    ],
    "fractionalEnabled": true
  },
  "code": 200,
  "message": "Success"
}

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.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Signature
string
required

Base64 encoded signed hash of the http message request components.

Learn how signatures work

Example:

"sig1=:OTEyMjY4...A5NTNDMEQ=:"

​
Signature-Input
string
required

An ordered list of components that make up the signature base. It is used to recompute and verify the Signature

Learn how signatures work

Example:

"sig1=(\"Content-Type\" \"Content-Digest\"...expires=<expires>"

​
X-Client-Id
string
required

Unique identifier assigned to the client

Example:

"client-id"

Path Parameters

​
symbol
string
required

A given instrument symbol

Response

Details of an investment instrument

​
data
object
required
​
code
string
required

Request response code

Example:

200

​
message
string
required

Request response message

Example:

"Success"