> ## 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/list-earn-lending-actions",
"feedback": "Description of the issue"
}
```
Only submit feedback when you have something specific and actionable to report.
# List earn lending actions
> Returns a paginated list of lending actions (deposits and withdrawals) for the authenticated tenant.
**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/actions
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/actions:
get:
tags:
- Earn (Beta)
summary: List earn lending actions
description: >
Returns a paginated list of lending actions (deposits and withdrawals)
for the authenticated tenant.
**Note:** This endpoint is currently in beta and might be subject to
changes.
operationId: getEarnActions
parameters:
- 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 (default 100, max 100).
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
enum:
- createdAt
- updatedAt
- 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/GetActionsResponse'
'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.getEarnActions(earnBetaApiGetEarnActionsRequest);
- lang: Java
source: >-
CompletableFuture> response =
fireblocks.earnBeta().getEarnActions(pageCursor, pageSize, sortBy,
order);
- lang: Python
source: >-
response = fireblocks.earn_beta.get_earn_actions(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:
GetActionsResponse:
type: object
properties:
data:
type: array
description: Page of lending actions for this query.
items:
$ref: '#/components/schemas/GetActionResponse'
example:
- id: 660e8400-e29b-41d4-a716-446655440001
status: IN_PROGRESS
providerId: MORPHO
actionType: DEPOSIT
opportunityId: morpho-usdc-vault-1
amount: '1500.5'
createdAt: '2025-01-15T10:00:00Z'
updatedAt: '2025-03-20T08:30:00Z'
records:
- actionType: APPROVE
status: COMPLETED
txId: tx_abc123
txHash: 0xabc...
updatedAt: '2025-03-20T08:29:00Z'
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
GetActionResponse:
type: object
description: Single lending action (intent plus per-step execution rows).
properties:
id:
type: string
description: Action sequence id (UUID).
example: 660e8400-e29b-41d4-a716-446655440001
status:
type: string
description: Intent status (e.g. CREATED, IN_PROGRESS, COMPLETED).
example: IN_PROGRESS
providerId:
type: string
description: Lending protocol identifier.
example: MORPHO
enum:
- MORPHO
- AAVE
actionType:
type: string
description: Whether this action is a deposit or withdraw flow.
example: DEPOSIT
enum:
- DEPOSIT
- WITHDRAW
opportunityId:
type: string
description: Target lending opportunity identifier.
example: morpho-usdc-vault-1
positionId:
type: string
description: Position id in the system when applicable.
example: 770e8400-e29b-41d4-a716-446655440002
amount:
type: string
description: Human-readable amount for the action.
example: '1500.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'
records:
type: array
description: Ordered execution steps for this action.
items:
$ref: '#/components/schemas/ActionRecord'
minItems: 1
maxItems: 4
required:
- id
- status
- providerId
- actionType
- opportunityId
- amount
- createdAt
- updatedAt
- records
ActionRecord:
type: object
description: One row in the lending action execution sequence.
properties:
actionType:
type: string
description: Kind of step in the lending sequence.
example: APPROVE
enum:
- APPROVE
- DEPOSIT
- WITHDRAW
status:
type: string
description: Step lifecycle status.
example: COMPLETED
enum:
- NOT_STARTED
- PROCESSING
- PENDING_SIGNATURE
- BROADCASTING
- CONFIRMING
- COMPLETED
- FAILED
- CANCELED
txId:
type: string
description: Fireblocks transaction id when applicable (unset when NOT_STARTED).
example: tx_abc123def456
txHash:
type: string
description: On-chain transaction hash when applicable (unset when NOT_STARTED).
example: '0x1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b'
errorMessage:
type: string
description: Error detail when the step failed.
updatedAt:
type: string
description: >-
Last update time (ISO-8601); may be empty when status is
NOT_STARTED.
example: '2025-03-20T08:30:00Z'
required:
- actionType
- status
- updatedAt
responses:
Error:
description: Error Response
headers:
X-Request-ID:
$ref: '#/components/headers/X-Request-ID'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchema'
````