Retrieve a Ledgers's Effects

GET 
/ledgers/:sequence/effects

This endpoint returns the effects of a specific ledger.

Request

Path Parameters

sequence integerrequired

The sequence number of a specific ledger.

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

operation

object

href linkrequired

templated boolean

succeeds

object

href linkrequired

templated boolean

precedes

object

href linkrequired

templated boolean

id id (string)

paging_token paging_token (string)

account address (string)

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

type string

Possible values: [Account Created, Account Removed, Account Credited, Account Debited, Account Thresholds Updated, Account Home Domain Updated, Account Flags Updated, Account Inflation Destination Updated, Signer Created, Signer Removed, Signer Updated, Trustline Created, Trustline Removed, Trustline Updated, Trustline Authorized, Trustline Deauthorized, Offer Created, Offer Removed, Offer Updated, Trade, Data Created, Data Removed, Data Updated, Claimable Balance Created, Claimable Balance Claimant Created, Claimable Balance Claimed, Account Sponsorship Created, Account Sponsorship Updated, Account Sponsorship Removed, Trustline Sponsorship Created, Trustline Sponsorship Updated, Trustline Sponsorship Removed, Account Data Sponsorship Created, Account Data Sponsorship Updated, Account Data Sponsorship Removed, Claimable Balance Sponsorship Created, Claimable Balance Sponsorship Updated, Claimable Balance Sponsorship Removed, Account Signer Sponsorship Created, Account Signer Sponsorship Updated, Account Signer Sponsorship Removed, Liquidity Pool Created, Liquidity Pool Removed, Liquidity Pool Revoked, Liquidity Pool Deposited, Liquidity Pool Withdraw, Liquidity Pool Trade, Sequence Bumped]

type_i number

created_at string

]

Example (from schema)

{
  "_links": {
    "self": {
      "href": "string",
      "templated": true
    },
    "next": {
      "href": "string",
      "templated": true
    },
    "prev": {
      "href": "string",
      "templated": true
    }
  },
  "_embedded": {
    "records": [
      {
        "_links": {
          "operation": {
            "href": "string",
            "templated": true
          },
          "succeeds": {
            "href": "string",
            "templated": true
          },
          "precedes": {
            "href": "string",
            "templated": true
          }
        },
        "id": "string",
        "paging_token": "string",
        "account": "string",
        "type": "Account Created",
        "type_i": 1,
        "created_at": "string"
      }
    ]
  }
}

RetrieveALedgersEffects

{
  "_links": {
    "self": {
      "href": "https://horizon-testnet.stellar.org/ledgers/0/effects?cursor=&limit=10&order=asc"
    },
    "next": {
      "href": "https://horizon-testnet.stellar.org/ledgers/0/effects?cursor=33676838572034-1&limit=10&order=asc"
    },
    "prev": {
      "href": "https://horizon-testnet.stellar.org/ledgers/0/effects?cursor=12884905985-1&limit=10&order=desc"
    }
  },
  "_embedded": {
    "records": [
      {
        "_links": {
          "operation": {
            "href": "https://horizon-testnet.stellar.org/operations/12884905985"
          },
          "succeeds": {
            "href": "https://horizon-testnet.stellar.org/effects?order=desc&cursor=12884905985-1"
          },
          "precedes": {
            "href": "https://horizon-testnet.stellar.org/effects?order=asc&cursor=12884905985-1"
          }
        },
        "id": "0000000012884905985-0000000001",
        "paging_token": "12884905985-1",
        "account": "GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB",
        "type": "account_created",
        "type_i": 0,
        "created_at": "2015-09-30T17:15:54Z",
        "starting_balance": "20.0000000"
      },
      {
        "_links": {
          "operation": {
            "href": "https://horizon-testnet.stellar.org/operations/12884905985"
          },
          "succeeds": {
            "href": "https://horizon-testnet.stellar.org/effects?order=desc&cursor=12884905985-2"
          },
          "precedes": {
            "href": "https://horizon-testnet.stellar.org/effects?order=asc&cursor=12884905985-2"
          }
        },
        "id": "0000000012884905985-0000000002",
        "paging_token": "12884905985-2",
        "account": "GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7",
        "type": "account_debited",
        "type_i": 3,
        "created_at": "2015-09-30T17:15:54Z",
        "asset_type": "native",
        "amount": "20.0000000"
      }
    ]
  }
}

Loading...