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>'import requests
url = "https://api.pipevest.com/v1/instruments/{symbol}"
headers = {
"Signature": "<signature>",
"Signature-Input": "<signature-input>",
"X-Client-Id": "<x-client-id>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
Signature: '<signature>',
'Signature-Input': '<signature-input>',
'X-Client-Id': '<x-client-id>',
Authorization: 'Bearer <token>'
}
};
fetch('https://api.pipevest.com/v1/instruments/{symbol}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.pipevest.com/v1/instruments/{symbol}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Signature: <signature>",
"Signature-Input: <signature-input>",
"X-Client-Id: <x-client-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.pipevest.com/v1/instruments/{symbol}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Signature", "<signature>")
req.Header.Add("Signature-Input", "<signature-input>")
req.Header.Add("X-Client-Id", "<x-client-id>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.pipevest.com/v1/instruments/{symbol}")
.header("Signature", "<signature>")
.header("Signature-Input", "<signature-input>")
.header("X-Client-Id", "<x-client-id>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pipevest.com/v1/instruments/{symbol}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Signature"] = '<signature>'
request["Signature-Input"] = '<signature-input>'
request["X-Client-Id"] = '<x-client-id>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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"
}{
"code": 401,
"message": "Unauthorized"
}{
"code": 404,
"message": "Not Found"
}Instruments
Get Instrument by Symbol
Returns details of a given instrument
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>'import requests
url = "https://api.pipevest.com/v1/instruments/{symbol}"
headers = {
"Signature": "<signature>",
"Signature-Input": "<signature-input>",
"X-Client-Id": "<x-client-id>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
Signature: '<signature>',
'Signature-Input': '<signature-input>',
'X-Client-Id': '<x-client-id>',
Authorization: 'Bearer <token>'
}
};
fetch('https://api.pipevest.com/v1/instruments/{symbol}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.pipevest.com/v1/instruments/{symbol}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Signature: <signature>",
"Signature-Input: <signature-input>",
"X-Client-Id: <x-client-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.pipevest.com/v1/instruments/{symbol}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Signature", "<signature>")
req.Header.Add("Signature-Input", "<signature-input>")
req.Header.Add("X-Client-Id", "<x-client-id>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.pipevest.com/v1/instruments/{symbol}")
.header("Signature", "<signature>")
.header("Signature-Input", "<signature-input>")
.header("X-Client-Id", "<x-client-id>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pipevest.com/v1/instruments/{symbol}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Signature"] = '<signature>'
request["Signature-Input"] = '<signature-input>'
request["X-Client-Id"] = '<x-client-id>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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"
}{
"code": 401,
"message": "Unauthorized"
}{
"code": 404,
"message": "Not Found"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Base64 encoded signed hash of the http message request components.
Example:
"sig1=:OTEyMjY4...A5NTNDMEQ=:"
An ordered list of components that make up the signature base. It is used to recompute and verify the Signature
Example:
"sig1=(\"Content-Type\" \"Content-Digest\"...expires=<expires>"
Unique identifier assigned to the client
Example:
"client-id"
Path Parameters
A given instrument symbol
⌘I