> ## Documentation Index
> Fetch the complete documentation index at: https://developers.fireblocks.com/llms.txt
> Use this file to discover all available pages before exploring further.
## Submitting Feedback
If you encounter incorrect, outdated, or confusing documentation on this page, submit feedback:
POST https://developers.fireblocks.com/feedback
```json
{
"path": "/api-reference/earn-beta/get-list-of-earn-positions",
"feedback": "Description of the issue"
}
```
Only submit feedback when you have something specific and actionable to report.
# Get list of earn positions
> Get list of earn positions for accounts tracked for this workspace.
Optional query parameters filter by chain, provider, and pagination.
**Note:** This endpoint is currently in beta and might be subject to changes.
## OpenAPI
````yaml https://docs.fireblocks.com/api/v1/swagger.yaml get /earn/positions
openapi: 3.0.0
info:
title: Fireblocks API
description: >
Fireblocks provides a suite of applications to manage digital asset
operations and a complete development platform to build your business on the
blockchain.
- Visit our website for more information: [Fireblocks
Website](https://fireblocks.com)
- Visit our developer docs: [Fireblocks
DevPortal](https://developers.fireblocks.com)
version: 1.6.2
contact:
email: developers@fireblocks.com
servers:
- url: https://api.fireblocks.io/v1
description: Fireblocks Production Environment Base URL
- url: https://sandbox-api.fireblocks.io/v1
description: Fireblocks Sandbox Environment Base URL
security: []
paths:
/earn/positions:
get:
tags:
- Earn (Beta)
summary: Get list of earn positions
description: >
Get list of earn positions for accounts tracked for this workspace.
Optional query parameters filter by chain, provider, and pagination.
**Note:** This endpoint is currently in beta and might be subject to
changes.
operationId: getEarnPositions
parameters:
- name: chainId
in: query
required: false
schema:
type: integer
format: int32
- name: providerId
in: query
required: false
schema:
type: string
enum:
- MORPHO
- AAVE
- name: pageCursor
in: query
required: false
description: Cursor for the next or previous page of results.
schema:
type: string
- name: pageSize
in: query
required: false
description: Number of items per page.
schema:
type: integer
format: int32
default: 100
minimum: 1
maximum: 100
- name: sortBy
in: query
required: false
description: Field to sort results by.
schema:
type: string
- name: order
in: query
required: false
description: Sort order (ASC or DESC).
schema:
default: DESC
example: ASC
enum:
- ASC
- DESC
type: string
responses:
'200':
description: OK
headers:
X-Request-ID:
$ref: '#/components/headers/X-Request-ID'
content:
application/json:
schema:
$ref: '#/components/schemas/GetPositionsResponse'
'403':
description: >-
Forbidden: insufficient permissions, disabled feature, or restricted
access.
headers:
X-Request-ID:
$ref: '#/components/headers/X-Request-ID'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchema'
'404':
description: 'Not found: requested resource does not exist.'
headers:
X-Request-ID:
$ref: '#/components/headers/X-Request-ID'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchema'
'429':
description: 'Rate limit exceeded: slow down and retry later.'
headers:
X-Request-ID:
$ref: '#/components/headers/X-Request-ID'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchema'
'500':
description: Internal error while processing the request.
headers:
X-Request-ID:
$ref: '#/components/headers/X-Request-ID'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchema'
default:
$ref: '#/components/responses/Error'
x-codeSamples:
- lang: TypeScript
source: >-
const response: Promise> =
fireblocks.earnBeta.getEarnPositions(earnBetaApiGetEarnPositionsRequest);
- lang: Java
source: >-
CompletableFuture> response =
fireblocks.earnBeta().getEarnPositions(chainId, providerId,
pageCursor, pageSize, sortBy, order);
- lang: Python
source: >-
response = fireblocks.earn_beta.get_earn_positions(chain_id,
provider_id, page_cursor, page_size, sort_by, order);
components:
headers:
X-Request-ID:
schema:
type: string
description: >-
Unique ID correlated to the API request. Please provide it in any
support ticket you create or on Github issues related to Fireblocks SDKs
schemas:
GetPositionsResponse:
type: object
properties:
data:
type: array
description: Page of user lending positions for this query.
items:
$ref: '#/components/schemas/Position-2'
example:
- id: 660e8400-e29b-41d4-a716-446655440001
status: ACTIVE
inFlight: false
positionType: LEND
vaultAccountId: '12345'
opportunityId: morpho-usdc-vault-1
chainId: '1'
providerId: MORPHO
origin: NATIVE
principalAssetId: USDC_ETH
positionAssetId: MORPHO_USDC_VAULT_ETH
principalBalance: '10000.00'
positionBalance: '9950.5'
createdAt: '2025-01-15T10:00:00Z'
updatedAt: '2025-03-20T08:30:00Z'
lastSyncedAt: '2025-03-20T08:29:55Z'
availableActions:
- DEPOSIT
- WITHDRAW
next:
type: string
description: Opaque cursor for the next page; empty when there is no next page.
example: ''
prev:
type: string
description: >-
Opaque cursor for the previous page; empty when there is no previous
page.
example: ''
total:
type: integer
format: int32
description: Total number of items matching the query.
example: 1
required:
- data
- total
ErrorSchema:
type: object
properties:
message:
type: string
code:
type: number
Position-2:
type: object
properties:
id:
type: string
description: Position UUID.
example: 660e8400-e29b-41d4-a716-446655440001
status:
type: string
description: Lifecycle status of the position.
example: ACTIVE
enum:
- ACTIVE
- INACTIVE
inFlight:
type: boolean
description: True while an action is in progress for this position.
example: false
positionType:
type: string
description: Whether the position is lend- or borrow-side.
example: LEND
enum:
- LEND
- BORROW
vaultAccountId:
type: string
description: Fireblocks vault account holding the position.
example: '12345'
opportunityId:
type: string
description: Opportunity / vault or market identifier.
example: morpho-usdc-vault-1
chainId:
type: string
description: Chain identifier as a string (e.g. "1").
example: '1'
providerId:
type: string
description: Lending protocol.
example: MORPHO
enum:
- MORPHO
- AAVE
origin:
type: string
description: >-
Whether the position was opened natively in Fireblocks or imported
externally.
example: NATIVE
enum:
- NATIVE
- EXTERNAL
principalAssetId:
type: string
description: Fireblocks asset id for the principal (underlying) asset.
example: USDC_ETH
positionAssetId:
type: string
description: Fireblocks asset id for the position / share token.
example: MORPHO_USDC_VAULT_ETH
principalBalance:
type: string
description: Human-readable principal balance.
example: '10000.00'
positionBalance:
type: string
description: Human-readable position token balance.
example: '9950.5'
createdAt:
type: string
description: Creation time (ISO-8601).
example: '2025-01-15T10:00:00Z'
updatedAt:
type: string
description: Last update time (ISO-8601).
example: '2025-03-20T08:30:00Z'
lastSyncedAt:
type: string
description: Last successful on-chain sync time (ISO-8601).
example: '2025-03-20T08:29:55Z'
availableActions:
type: array
description: Actions the API allows next for this position.
items:
type: string
enum:
- DEPOSIT
- WITHDRAW
example:
- DEPOSIT
- WITHDRAW
responses:
Error:
description: Error Response
headers:
X-Request-ID:
$ref: '#/components/headers/X-Request-ID'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchema'
````