Transactions

Search Transaction

get

Use the following parameters to search transactions.

Beware that default order is "desc", which can cause surprising result with pagination if transactions are being inserted. see Pagination for more details

Authorizations

Ledger_API_KeyLedger_API_UserLedger_Store_Auth_Token

Query parameters

accountinteger[] | nullableOptional

Returns transactions created in the provided account.

Default: null

created_afterstring · date-time | nullableOptional

Returns objects created after the entered date.

Default: nullExample: 2020-09-12T14:15:22Z

created_beforestring · date-time | nullableOptional

Returns objects created before the entered date.

Default: nullExample: 2020-12-13T16:17:28Z

currencystring[] | nullableOptional

Returns transactions created in the provided currency.

Default: nullExample: bitcoin or ethereum:0xdAC17F958D2ee523a2206206994597C13D831ec7

destination_taginteger | nullableOptional

Returns transactions that match the provided destination tag (XRP only).

Default: null

idinteger | nullableOptional

Returns the object corresponding to the entered ID

Default: null

interaction_typestring · enum | nullableOptional

Filters the list of results by interaction type.

Default: nullPossible values:

labelstring | nullableOptionalDeprecated

Returns transactions whose note's title or content contain the provided label.This field is deprecated, please use the field title instead

Default: null

max_amountstring | nullableOptional

Returns objects that have the provided max amount.

Default: nullPattern: ^[0-9]*(\.[0-9]+)?$

memostring | nullableOptional

representation of the memo - an ascii, hex string or base 10 integer

Default: null

min_amountstring | nullableOptional

Returns objects that have the provided min amount.

Default: nullPattern: ^[0-9]*(\.[0-9]+)?$

orderstring · enum | nullableOptional

Orders the list of results

Default: nullExample: descPossible values:

order_bystring | nullableOptional

criteria to order by

Default: nullExample: name

pageinteger | nullableOptional

Defines the page number to be fetched.

Default: 1Example: 3

page_sizeinteger | nullableOptional

Defines the number of elements displayed on a page. Must be a positive number with 0 and -1 return a maximum defined in the gate

Default: 20Example: 40

recipientstring | nullableOptional

Filters the results on the provided recipient address.

Default: null

titlestring | nullableOptional

Returns transactions whose note's title or content contain the provided label.

Default: null

tx_hashstring | nullableOptional

Returns transactions that match the provided transaction hash.

Default: null

tx_labelstring[] | nullableOptional

Filters the list of results by transaction label id

Default: null

typestring · enum | nullableOptional

Filters the list of results by transaction type.

Default: nullPossible values:

Responses

200

Transaction search results

application/json

400

Invalid search parameters

application/json

get

HTTPcURLJavaScriptPython

GET /transactions HTTP/1.1
Host: 
X-Ledger-API-Key: YOUR_API_KEY
Accept: */*

{
  "edges": [
    {
      "cursor": 0,
      "node": {
        "account_id": 1,
        "account_index": 0,
        "amount": "1432199",
        "block": {
          "details": {
            "ANY_ADDITIONAL_PROPERTY": null
          },
          "hash": "0x3bb33b6cc7c4aeea0e7383ddd8ef238c44abe8e3d73ffa27b78dd130a2a56687",
          "height": 7463221,
          "time": "2020-12-11T12:56:35.370946+00:00"
        },
        "broadcast_on": "2020-12-11T12:56:35.370946+00:00",
        "coin_fields": {
          "fees_per_byte": 10
        },
        "compliance": {
          "registration_ids": {
            "chainalysis": "906ff226-8b64-11eb-8e52-7b35a3dc1742"
          },
          "risk": {
            "provider_details": {
              "chainalysis": [
                {
                  "category_id": 3,
                  "exposure_type": "DIRECT",
                  "provider_id": "906ff226-8b64-11eb-8e52-7b35a3dc1742",
                  "risk": "Severe",
                  "service": "OFAC SDN Blender.io 2022-05-06",
                  "value": 8868.24
                }
              ]
            },
            "risk": "HIGH"
          }
        },
        "confirmations": 28,
        "created_by": 5,
        "created_on": "2025-05-30T20:17:33.616Z",
        "currency": "bitcoin",
        "currency_family": "ethereum",
        "failure_reasons": {
          "client_reason": "human readable message",
          "reason": "detail"
        },
        "fees": 17500,
        "id": 1,
        "interaction_type": "text",
        "labels": [
          {
            "id": 1,
            "info": {
              "color": "#fe3423",
              "description": "Flag resources as potentially harmfull"
            },
            "name": "SPAM"
          }
        ],
        "last_request": 1,
        "max_fees": 2100,
        "metadata": {
          "stake_pubkey": "text"
        },
        "min_confirmations": 6,
        "notes": [
          {
            "content": "some information about this transaction",
            "title": "a note title"
          }
        ],
        "recipient": "tb1q2tvjts80vthcywq9au2yynpezca57mvv0j7lzm",
        "senders": [
          "0x0D9377F84af90e6936973aEF3063fe6e16ca693e"
        ],
        "speed": "NORMAL",
        "status": "PENDING_APPROVAL",
        "tx_hash": "cd199dd0c61ff75c7a442e425771fedfe07e191a76aed64b6a311ec4a369b20e",
        "type": "SEND",
        "uid": "text"
      }
    }
  ],
  "page_info": {
    "count": 1,
    "has_next_page": false
  }
}

Create a transaction

post

Create a transaction.

Authorizations

Ledger_API_KeyLedger_API_UserLedger_Store_Auth_Token

Body

account_idinteger | nullableOptional

The account's id

Default: null

account_namestringRequired

The account's name.

amountstring | nullableOptional

The amount to be sent, in the currency's lowest unit. For Smart Contract interaction, use "0" instead of null

Default: nullPattern: ^[0-9]*(\.[0-9]+)?$

coin_fieldsone of | nullableOptional

coin specific data

Default: null

or

or

or

or

or

or

or

or

or

max_feesstringRequired

Max fees represent the highest possible fee amount you will pay to broadcast this transaction. The final fees, calculated once the transaction is approved by the last Operator, might be lower, but will never exceed that amount. We recommend estimating max fees through our fee estimation endpoint prior to creating the transaction request. See https://help.vault.ledger.com/developer-portal/content/transactions/tx/ for details.For Solana and Polkadot, max_fees field must be ignored.

Pattern: ^[0-9]*(\.[0-9]+)?$

noteall of | nullableOptional

A title and comments for the transaction.

Default: null

recipientstringRequired

The recipient's address.

speedstring · enumRequired

The transaction's processing speed.

Possible values:

Responses

200

Transaction to approve

application/json

400

Invalid transaction parameters

application/json

post

HTTPcURLJavaScriptPython

POST /transactions HTTP/1.1
Host: 
X-Ledger-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 210

{
  "account_id": 1,
  "account_name": "text",
  "amount": "text",
  "coin_fields": {
    "utxo_picking_strategy": "DEEP_OUTPUTS_FIRST"
  },
  "max_fees": "text",
  "note": {
    "content": "text",
    "title": "text"
  },
  "recipient": "text",
  "speed": "CUSTOM"
}

{
  "account_id": 1,
  "account_index": 0,
  "amount": "1432199",
  "block": {
    "details": {
      "ANY_ADDITIONAL_PROPERTY": null
    },
    "hash": "0x3bb33b6cc7c4aeea0e7383ddd8ef238c44abe8e3d73ffa27b78dd130a2a56687",
    "height": 7463221,
    "time": "2020-12-11T12:56:35.370946+00:00"
  },
  "broadcast_on": "2020-12-11T12:56:35.370946+00:00",
  "coin_fields": {
    "fees_per_byte": 10
  },
  "compliance": {
    "registration_ids": {
      "chainalysis": "906ff226-8b64-11eb-8e52-7b35a3dc1742"
    },
    "risk": {
      "provider_details": {
        "chainalysis": [
          {
            "category_id": 3,
            "exposure_type": "DIRECT",
            "provider_id": "906ff226-8b64-11eb-8e52-7b35a3dc1742",
            "risk": "Severe",
            "service": "OFAC SDN Blender.io 2022-05-06",
            "value": 8868.24
          }
        ]
      },
      "risk": "HIGH"
    }
  },
  "confirmations": 28,
  "created_by": 5,
  "created_on": "2025-05-30T20:17:33.616Z",
  "currency": "bitcoin",
  "currency_family": "ethereum",
  "failure_reasons": {
    "client_reason": "human readable message",
    "reason": "detail"
  },
  "fees": 17500,
  "id": 1,
  "interaction_type": "text",
  "labels": [
    {
      "id": 1,
      "info": {
        "color": "#fe3423",
        "description": "Flag resources as potentially harmfull"
      },
      "name": "SPAM"
    }
  ],
  "last_request": 1,
  "max_fees": 2100,
  "metadata": {
    "stake_pubkey": "text"
  },
  "min_confirmations": 6,
  "notes": [
    {
      "content": "some information about this transaction",
      "title": "a note title"
    }
  ],
  "recipient": "tb1q2tvjts80vthcywq9au2yynpezca57mvv0j7lzm",
  "senders": [
    "0x0D9377F84af90e6936973aEF3063fe6e16ca693e"
  ],
  "speed": "NORMAL",
  "status": "PENDING_APPROVAL",
  "tx_hash": "cd199dd0c61ff75c7a442e425771fedfe07e191a76aed64b6a311ec4a369b20e",
  "type": "SEND",
  "uid": "text"
}

Get a transaction by id

get

This method returns the transaction that matches the entered ID.

Authorizations

Ledger_API_KeyLedger_API_UserLedger_Store_Auth_Token

Path parameters

transaction_idintegerRequired

The transaction's ID.

Responses

200

Transaction object

application/json

404

Transaction not found

application/json

get

HTTPcURLJavaScriptPython

GET /transactions/{transaction_id} HTTP/1.1
Host: 
X-Ledger-API-Key: YOUR_API_KEY
Accept: */*

{
  "account_id": 1,
  "account_index": 0,
  "amount": "1432199",
  "block": {
    "details": {
      "ANY_ADDITIONAL_PROPERTY": null
    },
    "hash": "0x3bb33b6cc7c4aeea0e7383ddd8ef238c44abe8e3d73ffa27b78dd130a2a56687",
    "height": 7463221,
    "time": "2020-12-11T12:56:35.370946+00:00"
  },
  "broadcast_on": "2020-12-11T12:56:35.370946+00:00",
  "coin_fields": {
    "fees_per_byte": 10
  },
  "compliance": {
    "registration_ids": {
      "chainalysis": "906ff226-8b64-11eb-8e52-7b35a3dc1742"
    },
    "risk": {
      "provider_details": {
        "chainalysis": [
          {
            "category_id": 3,
            "exposure_type": "DIRECT",
            "provider_id": "906ff226-8b64-11eb-8e52-7b35a3dc1742",
            "risk": "Severe",
            "service": "OFAC SDN Blender.io 2022-05-06",
            "value": 8868.24
          }
        ]
      },
      "risk": "HIGH"
    }
  },
  "confirmations": 28,
  "created_by": 5,
  "created_on": "2025-05-30T20:17:33.616Z",
  "currency": "bitcoin",
  "currency_family": "ethereum",
  "failure_reasons": {
    "client_reason": "human readable message",
    "reason": "detail"
  },
  "fees": 17500,
  "id": 1,
  "interaction_type": "text",
  "labels": [
    {
      "id": 1,
      "info": {
        "color": "#fe3423",
        "description": "Flag resources as potentially harmfull"
      },
      "name": "SPAM"
    }
  ],
  "last_request": 1,
  "max_fees": 2100,
  "metadata": {
    "stake_pubkey": "text"
  },
  "min_confirmations": 6,
  "notes": [
    {
      "content": "some information about this transaction",
      "title": "a note title"
    }
  ],
  "recipient": "tb1q2tvjts80vthcywq9au2yynpezca57mvv0j7lzm",
  "senders": [
    "0x0D9377F84af90e6936973aEF3063fe6e16ca693e"
  ],
  "speed": "NORMAL",
  "status": "PENDING_APPROVAL",
  "tx_hash": "cd199dd0c61ff75c7a442e425771fedfe07e191a76aed64b6a311ec4a369b20e",
  "type": "SEND",
  "uid": "text"
}