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

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

response = requests.get(url)

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

fetch('https://api.prime.coinbase.com/v1/entities/{entity_id}/futures/equity', 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/equity",
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/equity"

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/equity")
.asString();
require 'uri'
require 'net/http'

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

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
{
  "eod_account_equity": "10000.00",
  "eod_unrealized_pnl": "100.00",
  "current_excess_deficit": "1000.00",
  "available_to_sweep": "500.00"
}

Path Parameters

entity_id
string
required

Entity ID

Response

200 - application/json

A successful response.

eod_account_equity
string

Prior EOD account equity (ending balance + realized P&L + commissions/fees)

Example:

"10000.00"

eod_unrealized_pnl
string

Prior EOD unrealized P&L on open futures positions

Example:

"100.00"

current_excess_deficit
string

Current Derivatives Account Balance minus prior EOD margin requirement. (Positive = excess; negative = deficit)

Example:

"1000.00"

available_to_sweep
string

Excess funds in the Derivatives account available to transfer ("sweep") to the designated funding portfolio

Example:

"500.00"