Ledger Enterprise
API Documentation V1
API Documentation V1
  • GETTING STARTED
    • Welcome
    • Getting Started
    • Authentication
    • Rate Limits
    • Pagination
  • tutorials
    • Register a new API User
    • First Steps as an API User
    • Generate Reporting API Keys
    • Manage Reporting API Keys
  • REFERENCE
    • API reference
      • Accounts
        • Search Accounts
        • Get an Account by ID
        • Addresses
          • [Decprecated] Get Receiving Addresses of an Account
          • Get Receiving Addresses of an Account
          • [Decprecated] Get an address by index for an account
        • Balances
        • Currency
        • History
        • Labels
        • NFT Collections
        • NFT Portfolio
        • NFTs
        • Sync
        • Tokens
        • ERC20 Child Accounts
      • API users
        • Get List of API Users
        • Create an API User
        • Get an API User
        • Register
      • Currencies and Tokens
        • List Currencies
        • List Tokens
        • Get Currency by Name
        • Get a Token by Network and Address
        • Currency Name and Address Pair
      • Digests
        • Search Digests
        • Get Digests by ID
        • Digest History
      • Entities
        • Search Entity
        • Get an Entity by ID
        • Entity History
        • Get the Users of an Entity
      • Groups
        • Search Group
        • Get Group by ID
        • Group History
      • Labels
      • Messages
        • Search Message
        • Get a Message by ID
        • Message History
      • Organization
      • Pledges
        • Search Pledge
        • Get a Pledge by ID
      • Requests
        • Search Request
        • Create Request
        • Get Request by ID
        • Get Request Challenge (Approve)
        • Get Request Challenge (Reject)
        • Approve Request
        • Reject Request
        • Get the Request's Governance Status
      • Settlements
        • Search Settlements
        • Create Settlement
        • Get a Settlement by ID
      • Transactions
        • Search Transaction
        • Create a Transaction
        • Get a Transaction by ID
        • Estimate Transaction Fees
        • Estimate Transaction Fees
        • Approve Transaction
        • Reject Transaction
        • Transaction History
        • Transaction Labels
      • Users
        • Search Users
        • Search User by ID
        • User History
      • Whitelists
        • Search Whitelist
        • Get Whitelist by ID
        • Whitelist History
      • Auth
        • Get JWT Token
        • Refresh JWT Token
      • Compliance
        • Get an Address' Risk Assessment
        • Get an Address' Sanctions
      • Notifications
        • Get Notification Configuration
        • Set Notification Configuration
    • Specification
Powered by GitBook
On this page
  1. REFERENCE
  2. API reference
  3. Transactions

Search Transaction

PreviousTransactionsNextCreate a Transaction

Last updated 1 day ago

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
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
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-06-06T19:44:22.197Z",
        "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
  }
}