Skip to main content
GET
/
portfolio
Returns list of portfolios for a customer
curl --request GET \
  --url https://api.pipevest.com/v1/portfolio \
  --header 'Authorization: Bearer <token>' \
  --header 'Signature: <signature>' \
  --header 'Signature-Input: <signature-input>' \
  --header 'X-Client-Id: <x-client-id>'
{
  "data": [
    {
      "portfolioId": 123456,
      "accountId": 123456,
      "customerId": 123456,
      "currency": "ZK",
      "investmentAmount": 1550,
      "marketValue": 11550,
      "performance": 151,
      "status": "ACTIVE",
      "createdAt": 1234567890,
      "updatedAt": 1234567890
    }
  ],
  "code": 200,
  "message": "Success",
  "meta": {
    "previousPage": 0,
    "currentPage": 0,
    "nextPage": 0,
    "limit": 100,
    "currentCount": 100,
    "totalCount": 1000,
    "sort": "ASC"
  }
}

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"

Query Parameters

​
customerId
integer
required

the customer unique id

​
page
integer

The page offset for the items returned

Required range: x >= 0
Example:

0

​
limit
integer
default:100

The maximum numbers of items to return.

Required range: 1 <= x <= 1000
Example:

100

​
sort
enum<string>

The date order in which to sort the items

This currently only works to sort createdAt.

Available options:
ASC,
DESC
Example:

"ASC"

Response

A JSON array of investment portfolios

​
data
object[]
required

Portfolios with an accountId was automatically created by Pipevest with an associated account.

Wherein there is no accountId, the Portfolio was manually created via the API and does not have an associated account.

​
code
string
required

Request response code

Example:

200

​
message
string
required

Request response message

Example:

"Success"

​
meta
object
required