Retrieve an Account's Offers

GET 
/accounts/:account_id/offers

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

Request

Path Parameters

account_id stringrequired

This account’s public key encoded in a base32 string representation.

Query Parameters

cursor integer

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

Possible values: [asc, desc]

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

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.

Responses

200

Success

application/json

Schema

Schema

_links

object

self

object

href linkrequired

templated boolean

next

object

href linkrequired

templated boolean

prev

object

href linkrequired

templated boolean

_embedded

object

records

object[]

Array [

_links

object

self

object

required

href linkrequired

templated boolean

offer_maker

object

required

href linkrequired

templated boolean

id id (string)required

paging_token stringrequired

seller address (string)required

Possible values: Value must match regular expression G[A-Z0-9]{55}

selling

object

required

asset_type stringrequired

asset_code string

asset_issuer string

buying

object

required

asset_type stringrequired

asset_code string

asset_issuer string

amount stringrequired

price_r

object

required

n int32

d int32

price stringrequired

last_modified_ledger uint32required

last_modified_time stringrequired

sponser string

]

Example (from schema)

{
  "_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"
      }
    ]
  }
}

RetrieveAnAccountsOffers

{
  "_links": {
    "self": {
      "href": "https://\thorizon-testnet.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K/offers?cursor=&limit=10&order=asc"
    },
    "next": {
      "href": "https://\thorizon-testnet.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K/offers?cursor=164943216&limit=10&order=asc"
    },
    "prev": {
      "href": "https://\thorizon-testnet.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K/offers?cursor=164555927&limit=10&order=desc"
    }
  },
  "_embedded": {
    "records": [
      {
        "_links": {
          "self": {
            "href": "https://\thorizon-testnet.stellar.org/offers/164555927"
          },
          "offer_maker": {
            "href": "https://\thorizon-testnet.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K"
          }
        },
        "id": 164555927,
        "paging_token": "164555927",
        "seller": "GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K",
        "selling": {
          "asset_type": "native"
        },
        "buying": {
          "asset_type": "credit_alphanum4",
          "asset_code": "BB1",
          "asset_issuer": "GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN"
        },
        "amount": "214.9999939",
        "price_r": {
          "n": 10000000,
          "d": 86000001
        },
        "price": "0.1162791",
        "last_modified_ledger": 28383147,
        "last_modified_time": "2020-02-24T22:58:38Z"
      },
      {
        "_links": {
          "self": {
            "href": "https://\thorizon-testnet.stellar.org/offers/164943216"
          },
          "offer_maker": {
            "href": "https://\thorizon-testnet.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K"
          }
        },
        "id": 164943216,
        "paging_token": "164943216",
        "seller": "GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K",
        "selling": {
          "asset_type": "credit_alphanum4",
          "asset_code": "BB1",
          "asset_issuer": "GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN"
        },
        "buying": {
          "asset_type": "native"
        },
        "amount": "24.9999990",
        "price_r": {
          "n": 32224991,
          "d": 2500000
        },
        "price": "12.8899964",
        "last_modified_ledger": 28394149,
        "last_modified_time": "2020-02-25T15:49:57Z"
      }
    ]
  }
}

Loading...