Skip to main content
GET
/
v1
/
exchange
/
pl
cURL
curl --request GET \
  --url 'https://api.coinstats.app/v1/exchange/pl?portfolioId=618f0bb0f2cf07dce25bc5007750bf1646825509bb63519bd491ab6a56daa419' \
  --header 'X-API-KEY: <api-key>'
import requests

url = "https://api.coinstats.app/v1/exchange/pl?portfolioId=618f0bb0f2cf07dce25bc5007750bf1646825509bb63519bd491ab6a56daa419"

headers = {"X-API-KEY": "<api-key>"}

response = requests.request("GET", url, headers=headers)

print(response.json())
const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.coinstats.app/v1/exchange/pl?portfolioId=618f0bb0f2cf07dce25bc5007750bf1646825509bb63519bd491ab6a56daa419', options)
  .then((response) => response.json())
  .then((response) => console.log(response))
  .catch((err) => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.coinstats.app/v1/exchange/pl?portfolioId=618f0bb0f2cf07dce25bc5007750bf1646825509bb63519bd491ab6a56daa419",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {

	url := "https://api.coinstats.app/v1/exchange/pl?portfolioId=618f0bb0f2cf07dce25bc5007750bf1646825509bb63519bd491ab6a56daa419"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

	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.coinstats.app/v1/exchange/pl?portfolioId=618f0bb0f2cf07dce25bc5007750bf1646825509bb63519bd491ab6a56daa419")
  .header("X-API-KEY", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.coinstats.app/v1/exchange/pl")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "result": [
    {
      "count": 44.4987,
      "coin": {
        "rank": 2,
        "identifier": "ethereum",
        "symbol": "ETH",
        "name": "Ethereum",
        "icon": "https://static.coinstats.app/coins/1650455629727.png",
        "priceChange24h": -5.74,
        "priceChange1h": 0.1,
        "priceChange7d": 1.12,
        "priceChange1m": 8.42,
        "volume": 61315198931.43572,
        "isFake": false,
        "isFiat": false
      },
      "price": {
        "USD": 4343.564311034,
        "BTC": 0.039479708,
        "ETH": 1
      },
      "profitPercent": {
        "allTime": {
          "USD": 83720.75297372,
          "BTC": 0.054246576,
          "ETH": -0.0008427712028833412
        },
        "hour24": {
          "USD": -11770.04265107636,
          "BTC": -0.055726915608058335,
          "ETH": 0
        },
        "lastTrade": {
          "USD": -0.0011652685976688212,
          "BTC": -8.325768295004658e-9,
          "ETH": 8.470329472543003e-22
        },
        "unrealized": {
          "USD": 64875.375139922,
          "BTC": 0.516615331,
          "ETH": -0.000013421973257266018
        },
        "realized": {
          "USD": 18844.785945298,
          "BTC": -0.46237401135664413,
          "ETH": -0.0008426785167330308
        }
      },
      "profit": {
        "allTime": {
          "USD": 83720.75297372,
          "BTC": 0.054246576,
          "ETH": -0.0008427712028833412
        },
        "hour24": {
          "USD": -11770.04265107636,
          "BTC": -0.055726915608058335,
          "ETH": 0
        },
        "lastTrade": {
          "USD": -0.0011652685976688212,
          "BTC": -8.325768295004658e-9,
          "ETH": 8.470329472543003e-22
        },
        "unrealized": {
          "USD": 64875.375139922,
          "BTC": 0.516615331,
          "ETH": -0.000013421973257266018
        },
        "realized": {
          "USD": 18844.785945298,
          "BTC": -0.46237401135664413,
          "ETH": -0.0008426785167330308
        }
      },
      "averageBuy": {
        "allTime": {
          "USD": 83720.75297372,
          "BTC": 0.054246576,
          "ETH": -0.0008427712028833412
        },
        "hour24": {
          "USD": -11770.04265107636,
          "BTC": -0.055726915608058335,
          "ETH": 0
        },
        "lastTrade": {
          "USD": -0.0011652685976688212,
          "BTC": -8.325768295004658e-9,
          "ETH": 8.470329472543003e-22
        },
        "unrealized": {
          "USD": 64875.375139922,
          "BTC": 0.516615331,
          "ETH": -0.000013421973257266018
        },
        "realized": {
          "USD": 18844.785945298,
          "BTC": -0.46237401135664413,
          "ETH": -0.0008426785167330308
        }
      },
      "averageSell": {
        "allTime": {
          "USD": 83720.75297372,
          "BTC": 0.054246576,
          "ETH": -0.0008427712028833412
        },
        "hour24": {
          "USD": -11770.04265107636,
          "BTC": -0.055726915608058335,
          "ETH": 0
        },
        "lastTrade": {
          "USD": -0.0011652685976688212,
          "BTC": -8.325768295004658e-9,
          "ETH": 8.470329472543003e-22
        },
        "unrealized": {
          "USD": 64875.375139922,
          "BTC": 0.516615331,
          "ETH": -0.000013421973257266018
        },
        "realized": {
          "USD": 18844.785945298,
          "BTC": -0.46237401135664413,
          "ETH": -0.0008426785167330308
        }
      },
      "liquidityScore": 94.44676177373067,
      "volatilityScore": 6.823477152064536,
      "marketCapScore": 90.15554879029162,
      "riskScore": 7.407055529347417,
      "avgChange": 2.631321607022045,
      "totalCost": {
        "USD": 160,
        "BTC": 0.0016,
        "ETH": 0.032
      }
    }
  ],
  "summary": {
    "totalValue": {
      "USD": 160,
      "BTC": 0.0016,
      "ETH": 0.032
    },
    "totalCost": {
      "USD": 160,
      "BTC": 0.0016,
      "ETH": 0.032
    },
    "profit": {
      "allTime": {
        "USD": 160,
        "BTC": 0.0016,
        "ETH": 0.032
      },
      "hour24": {
        "USD": 160,
        "BTC": 0.0016,
        "ETH": 0.032
      },
      "lastTrade": {
        "USD": 160,
        "BTC": 0.0016,
        "ETH": 0.032
      },
      "unrealized": {
        "USD": 160,
        "BTC": 0.0016,
        "ETH": 0.032
      },
      "realized": {
        "USD": 160,
        "BTC": 0.0016,
        "ETH": 0.032
      }
    },
    "profitPercent": {
      "allTime": {
        "USD": 160,
        "BTC": 0.0016,
        "ETH": 0.032
      },
      "hour24": {
        "USD": 160,
        "BTC": 0.0016,
        "ETH": 0.032
      },
      "lastTrade": {
        "USD": 160,
        "BTC": 0.0016,
        "ETH": 0.032
      },
      "unrealized": {
        "USD": 160,
        "BTC": 0.0016,
        "ETH": 0.032
      },
      "realized": {
        "USD": 160,
        "BTC": 0.0016,
        "ETH": 0.032
      }
    }
  }
}
{
  "statusCode": 400,
  "message": "Bad Request",
  "requestId": "11111111-2222-3333-4444-555555555555",
  "path": "<requested-endpoint>"
}
{
  "statusCode": 401,
  "message": "Unauthorized",
  "requestId": "11111111-2222-3333-4444-555555555555",
  "path": "<requested-endpoint>"
}
{
  "statusCode": 403,
  "message": "Forbidden",
  "requestId": "11111111-2222-3333-4444-555555555555",
  "path": "<requested-endpoint>"
}
{
  "statusCode": 404,
  "message": "Not Found",
  "requestId": "11111111-2222-3333-4444-555555555555",
  "path": "<requested-endpoint>"
}
{
  "statusCode": 409,
  "message": "Transactions not synced",
  "requestId": "11111111-2222-3333-4444-555555555555",
  "path": "<requested-endpoint>"
}
{
  "statusCode": 429,
  "message": "Rate limit exceeded",
  "requestId": "11111111-2222-3333-4444-555555555555",
  "path": "<requested-endpoint>"
}
{
  "statusCode": 503,
  "message": "Service Unavailable. Please Contact Support"
}
25 credits per request
  • Holdings with the same PnL fields as portfolio coins
  • totalCost per coin
  • Summary totals for the filtered result set
  • portfolioId: API-connected exchange portfolio ID
  • coinId: Filter the result and summary by coin ID
  • page & limit: Control pagination

Authorizations

​
X-API-KEY
string
header
required

API key required to access the endpoints. Generate one from your dashboard at https://openapi.coinstats.app and pass it in the X-API-KEY request header. Never expose your key in client-side code.

Query Parameters

​
page
number

Page number to retrieve (1-based indexing)

Example:

1

​
limit
number

Number of items to return per page

Example:

20

​
portfolioId
string
required

Portfolio ID received from POST /portfolio/exchange or POST /exchange/balance.

Example:

"618f0bb0f2cf07dce25bc5007750bf1646825509bb63519bd491ab6a56daa419"

​
coinId
string

Filter P/L data by coin ID.

Example:

"bitcoin"

Response

Get exchange PnL data

​
result
object[]
required

Portfolio holdings with prices, PnL fields, averages, and totalCost

​
summary
object
required

Totals calculated from the filtered result set