For AI agents: an LLM-friendly Markdown version of every page is available by appending .md to its URL or by sending an Accept: text/markdown request header. The full documentation index is at https://www.ankr.com/docs/llms.txt
Skip to main content

Stellar — Accounts (3/3)

API reference for Stellar. All methods ->

Part 3 of 3: 1 · 2 · 3

Accounts​

GET /accounts/{account_id}/offers​

Retrieves an account's offers.

Parameters​

  • account_id (string; path; required): the account’s public key encoded in a base32 string representation.
  • cursor (integer; query): a number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.
  • order (string; query): a designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.
  • limit (integer; query): the maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.

Returns​

{
  "_links": {
    "self": {
      "href": "string",
      "templated": true
    },
    "next": {
      "href": "string",
      "templated": true
    },
    "prev": {
      "href": "string",
      "templated": true
    }
  },
  "_embedded": {
    "records": [
      {
        "_links": {
          "self": {
            "href": "string",
            "templated": true
          },
          "offer_maker": {
            "href": "string",
            "templated": true
          }
        },
        "id": "string",
        "paging_token": "string",
        "seller": "string",
        "selling": {
          "asset_type": "string",
          "asset_code": "string",
          "asset_issuer": "string"
        },
        "buying": {
          "asset_type": "string",
          "asset_code": "string",
          "asset_issuer": "string"
        },
        "amount": "string",
        "price_r": {
          "n": 0,
          "d": 0
        },
        "price": "string",
        "last_modified_ledger": 0,
        "last_modified_time": "string",
        "sponser": "string"
      }
    ]
  }
}

Request example​

curl https://rpc.ankr.com/http/stellar_horizon/accounts/{account_id}/offers{?cursor,limit,order}

Response example​

{
    "_links": {
        "self": {
            "href": "https://rpc.ankr.com/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K/offers?cursor=164943216\u0026limit=10\u0026order=asc"
        },
        "next": {
            "href": "https://rpc.ankr.com/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K/offers?cursor=164943216\u0026limit=10\u0026order=asc"
        },
        "prev": {
            "href": "https://rpc.ankr.com/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K/offers?cursor=164943216\u0026limit=10\u0026order=desc"
        }
    },
    "_embedded": {
        "records": []
    }
}

GET /accounts/{account_id}/trades​

Retrieves an account's trades.

This endpoint represents all trades for a given account and can be used in streaming mode. Streaming mode allows you to listen for trades for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known trade unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream trades created since your request time.

Parameters​

  • account_id (string; path; required): the account’s public key encoded in a base32 string representation.
  • cursor (integer; query): a number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.
  • order (string; query): a designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.
  • limit (integer; query): the maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.

Returns​

{
  "_links": {
    "self": {
      "href": "string",
      "templated": true
    },
    "next": {
      "href": "string",
      "templated": true
    },
    "prev": {
      "href": "string",
      "templated": true
    }
  },
  "_embedded": {
    "records": [
      {
        "_links": {
          "self": {
            "href": "string",
            "templated": true
          },
          "base": {
            "href": "string",
            "templated": true
          },
          "counter": {
            "href": "string",
            "templated": true
          },
          "operation": {
            "href": "string",
            "templated": true
          }
        },
        "id": "string",
        "paging_token": "string",
        "ledger_close_time": "string",
        "offer_id": "string",
        "trade_type": "string",
        "liquidity_pool_fee_bp": 0,
        "base_liquidity_pool_id": "string",
        "base_offer_id": "string",
        "base_account": "string",
        "base_amount": "string",
        "base_asset_type": "string",
        "base_asset_code": "string",
        "base_asset_issuer": "string",
        "counter_liquidity_pool_id": "string",
        "counter_offer_id": "string",
        "counter_account": "string",
        "counter_amount": "string",
        "counter_asset_type": "string",
        "counter_asset_code": "string",
        "counter_asset_issuer": "string",
        "base_is_seller": true,
        "price": {
          "n": "string",
          "d": "string"
        }
      }
    ]
  }
}

Request example​

curl https://rpc.ankr.com/http/stellar_horizon/accounts/{account_id}/trades{?cursor,limit,order}

Response example​

{
    "_links": {
        "self": {
            "href": "https://rpc.ankr.com/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K/trades?cursor=\u0026limit=1\u0026order=asc"
        },
        "next": {
            "href": "https://rpc.ankr.com/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K/trades?cursor=107449468881756161-0\u0026limit=1\u0026order=asc"
        },
        "prev": {
            "href": "https://rpc.ankr.com/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K/trades?cursor=107449468881756161-0\u0026limit=1\u0026order=desc"
        }
    },
    "_embedded": {
        "records": [
            {
                "_links": {
                    "self": {
                        "href": ""
                    },
                    "base": {
                        "href": "https://rpc.ankr.com/accounts/GCO7OW5P2PP7WDN6YUDXUUOPAR4ZHJSDDCZTIAQRTRZHKQWV45WUPBWX"
                    },
                    "counter": {
                        "href": "https://rpc.ankr.com/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K"
                    },
                    "operation": {
                        "href": "https://rpc.ankr.com/operations/107449468881756161"
                    }
                },
                "id": "107449468881756161-0",
                "paging_token": "107449468881756161-0",
                "ledger_close_time": "2019-07-26T09:17:02Z",
                "trade_type": "orderbook",
                "base_offer_id": "104078276",
                "base_account": "GCO7OW5P2PP7WDN6YUDXUUOPAR4ZHJSDDCZTIAQRTRZHKQWV45WUPBWX",
                "base_amount": "4433.2000000",
                "base_asset_type": "native",
                "counter_offer_id": "4719135487309144065",
                "counter_account": "GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K",
                "counter_amount": "443.3200000",
                "counter_asset_type": "credit_alphanum4",
                "counter_asset_code": "BB1",
                "counter_asset_issuer": "GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN",
                "base_is_seller": true,
                "price": {
                    "n": "1",
                    "d": "10"
                }
            }
        ]
    }
}

GET /accounts/{account_id}/data/{key}​

Retrieve an account's data.

This endpoint represents a single data for a given account.

Parameters​

  • account_id (string; path; required): the account’s public key encoded in a base32 string representation.
  • key (string; path; required): the key name for this data.

Returns​

{
  "value": "string"
}

Request example​

curl https://rpc.ankr.com/http/stellar_horizon/accounts/{account_id}/data/{key}

Response example​

{
  "value": "MQ=="
}