List Aggregate Entity Positions

curl --request GET \
  --url https://api.prime.coinbase.com/v1/entities/{entity_id}/aggregate_positions

{
  "positions": [
    {
      "symbol": "BTC",
      "long": "10",
      "short": "10",
      "position_reference": {
        "id": "e8bbed13-fa33-41de-86d5-4335d8f08166"
      }
    }
  ]
}

GET

entities

{entity_id}

aggregate_positions

List Aggregate Entity Positions

curl --request GET \
  --url https://api.prime.coinbase.com/v1/entities/{entity_id}/aggregate_positions

{
  "positions": [
    {
      "symbol": "BTC",
      "long": "10",
      "short": "10",
      "position_reference": {
        "id": "e8bbed13-fa33-41de-86d5-4335d8f08166"
      }
    }
  ]
}

Path Parameters

entity_id

string

required

The unique ID of the entity

Query Parameters

cursor

string

Id to retrieve additional results strictly after

limit

integer<int32>

Number of items to retrieve

Response

200 - application/json

A successful response.

positions

object[]

required

Show child attributes

symbol

string

Asset symbol

Example:

"BTC"

long

string

The long position based on 'reference' value

Example:

"10"

short

string

The short position based on 'reference' value

Example:

"10"

position_reference

object

Show child attributes

position_reference.id

string

Reference ID

Example:

"e8bbed13-fa33-41de-86d5-4335d8f08166"

position_reference.type

enum<string>

default:POSITION_REFERENCE_TYPE_UNSPECIFIED

Available options:

POSITION_REFERENCE_TYPE_UNSPECIFIED,

ENTITY,

PORTFOLIO

pagination

object

required

Show child attributes

pagination.next_cursor

string

required

Cursor to navigate to next page

pagination.sort_direction

enum<string>

default:DESC

required

Available options:

DESC,

ASC

pagination.has_next

boolean

required

A boolean value indicating whether there are more items to paginate through

List Portfolios

List Entity Positions

⌘I

REST API

FIX API

Websocket Feed

List Aggregate Entity Positions

Path Parameters

Query Parameters

Response