Skip to main content
GET
/
market
/
data
/
{instrumentId}
Returns market data for an instrument
curl --request GET \
  --url https://api.pipevest.com/v1/market/data/{instrumentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Signature: <signature>' \
  --header 'Signature-Input: <signature-input>' \
  --header 'X-Client-Id: <x-client-id>'
{
  "data": {
    "marketDataId": 123456,
    "instrumentId": 123456,
    "name": "Apple Inc.",
    "currency": "ZK",
    "symbol": "APPL",
    "open": 500,
    "high": 1000,
    "low": 200,
    "close": 200,
    "volume": 200,
    "start": 1234567890,
    "end": 1234567890,
    "timeFrame": "1D",
    "createdAt": 1234567890,
    "updatedAt": 1234567890
  },
  "code": 200,
  "message": "Success"
}

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

​
instrumentId
integer
required

Unique instrument identifier

Example:

123456

Query Parameters

​
start
integer
required

Market data start date as UNIX timestamp

Example:

1234567890

​
end
integer
required

Market data end date as UNIX timestamp

Example:

1234567890

​
timeFrame
enum<string>
required

The time frames used to determine instrument market data

Available options:
1D,
5D,
3M,
6M,
YTD,
1Y,
5Y,
ALL
Example:

"1D"

Response

Market data for an instrument

​
data
object
required
​
code
string
required

Request response code

Example:

200

​
message
string
required

Request response message

Example:

"Success"