Get portfolios
Returns a list of portfolios to which the caller has access. If a valid portfolio ID is specified in the query, the list will include that portfolio alone. If an invalid portfolio ID is specified in the query, or if the caller is denied access to that portfolio, the list will be empty.
Headers
-
ONX-API-KEY
string Required An API key assigned by Omniex
-
ONX-API-TIMESTAMP
integer(int64) Required Unix timestamp value, in milliseconds
-
ONX-API-SIGNATURE
string Required The signature generated for this API call
GET
/portfolios
curl \
-X GET https://api.omniex.io/edge/v1beta/portfolios \
-H "ONX-API-KEY: fI7xlbw7e2" \
-H "ONX-API-TIMESTAMP: 1606940938725" \
-H "ONX-API-SIGNATURE: 3181a3c21da8a5bb952076cc3655cc17de3d63efa790282c3625d21fee52db4a"
Response examples (200)
{
"data": [
{
"id": "6b372483-a80f-4c32-8d23-e6b9397ee6d6",
"resource": "portfolio",
"name": "Master Fund 1",
"integrations": [
{
"id": "52b229b4-b5b4-407b-a8e0-502d8ee42e1b",
"venueId": "binance",
"integrationStatus": "verified"
},
{
"id": "c465afdc-d4f8-40a5-aa06-d2129a7f737b",
"venueId": "gdax",
"integrationStatus": "verified"
},
{
"id": "cfa7209e-198b-4f44-a37a-12d02b80a3e8",
"venueId": "gemini",
"integrationStatus": "verified"
},
{
"id": "d1e26f86-74e1-4acd-a6d8-76bab9ea2315",
"venueId": "itbit",
"integrationStatus": "requested"
}
],
"positions": [
{
"assetId": "BTC",
"isCustomAsset": false,
"accounts": [
{
"venueId": "binance",
"name": "Binance BTC Account",
"balance": {
"trading": {
"free": "1.009",
"locked": "0.0"
}
}
},
{
"venueId": "gdax",
"name": "Coinbase Pro BTC Account",
"balance": {
"trading": {
"free": "0.2",
"locked": "0.03"
}
}
}
]
},
{
"assetId": "ETH",
"isCustomAsset": false,
"accounts": [
{
"venueId": "gdax",
"name": "Coinbase Pro ETH Account",
"balance": {
"trading": {
"free": "0.4",
"locked": "0.1"
}
}
},
{
"venueId": "gemini",
"name": "Gemini ETH Account",
"balance": {
"trading": {
"free": "0.5",
"locked": "0.0"
}
}
}
]
}
],
"createdAt": "2021-05-05T12:28:53.000Z",
"updatedAt": "2021-05-05T12:28:53.000Z"
}
],
"meta": {}
}
Response examples (200)
{
"data": [
{
"id": "string",
"resource": "portfolio",
"name": "string",
"integrations": [
{
"id": "string",
"venueId": "string",
"integrationStatus": "requested"
}
],
"positions": [
{
"assetId": "string",
"isCustomAsset": true,
"accounts": [
{
"venueId": "string",
"name": "string",
"balance": {
"trading": {
"free": "string",
"locked": "string"
},
"margin": {
"locked": "string"
},
"staking": {
"locked": "string"
},
"custody": {
"free": "string",
"locked": "string"
}
}
}
]
}
],
"createdAt": "2025-05-04T09:42:00Z",
"updatedAt": "2025-05-04T09:42:00Z"
}
],
"meta": {}
}
Response examples (400)
Parameter value invalid
{
"errors": [
{
"error": "PARAMETER_VALUE_INVALID",
"message": "a specified query/path parameter value was invalid"
}
],
"meta": {}
}{
"errors": [
{
"error": "PARAMETER_UNSUPPORTED",
"message": "a specified query parameter is unsupported"
}
],
"meta": {}
}{
"errors": [
{
"error": "TIMESTAMP_INVALID",
"message": "the request timestamp is invalid or outside the required window"
}
],
"meta": {}
}
Response examples (400)
{
"errors": [
{
"error": "ACCESS_DENIED",
"message": "string"
}
],
"meta": {}
}
Response examples (401)
{
"errors": [
{
"error": "AUTHENTICATION_FAILED",
"message": "the api server failed to authenticate the request"
}
],
"meta": {}
}
Response examples (401)
{
"errors": [
{
"error": "ACCESS_DENIED",
"message": "string"
}
],
"meta": {}
}