Skip to main content
GET
/
v1
/
entities
/
{entity_id}
/
futures
/
balance_summary
Get Entity FCM Balance
curl --request GET \
  --url https://api.prime.coinbase.com/v1/entities/{entity_id}/futures/balance_summary
import requests

url = "https://api.prime.coinbase.com/v1/entities/{entity_id}/futures/balance_summary"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.prime.coinbase.com/v1/entities/{entity_id}/futures/balance_summary', 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.prime.coinbase.com/v1/entities/{entity_id}/futures/balance_summary",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);

$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.prime.coinbase.com/v1/entities/{entity_id}/futures/balance_summary"

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

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.prime.coinbase.com/v1/entities/{entity_id}/futures/balance_summary")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.prime.coinbase.com/v1/entities/{entity_id}/futures/balance_summary")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
{
  "portfolio_id": "00000000-0000-0000-0000-000000000000",
  "cfm_usd_balance": "1000.00",
  "unrealized_pnl": "10.12",
  "daily_realized_pnl": "10.12",
  "excess_liquidity": "10.12",
  "futures_buying_power": "10.12",
  "initial_margin": "10.12",
  "maintenance_margin": "10.12",
  "clearing_account_id": "CFS1234567",
  "cfm_unsettled_accrued_funding_pnl": "10.12"
}

Path Parameters

entity_id
string
required

Entity ID

Response

200 - application/json

A successful response.

portfolio_id
string

Portfolio ID

Example:

"00000000-0000-0000-0000-000000000000"

cfm_usd_balance
string

CFM USD balance

Example:

"1000.00"

unrealized_pnl
string

Unrealized PNL

Example:

"10.12"

daily_realized_pnl
string

Daily realized PNL

Example:

"10.12"

excess_liquidity
string

Excess liquidity

Example:

"10.12"

futures_buying_power
string

Futures buying power

Example:

"10.12"

initial_margin
string

Initial margin

Example:

"10.12"

maintenance_margin
string

Maintenance margin

Example:

"10.12"

clearing_account_id
string

Clearing account ID

Example:

"CFS1234567"

cfm_unsettled_accrued_funding_pnl
string

Unsettled accrued funding PNL from the last settlement

Example:

"10.12"