REST API
- Overview
- Errors
- Paging
- Rate Limiting
- Response Format
- Streaming
- XDR
- Tutorials
  - Follow Received Payments
- Endpoints
- Resources
  - Account
  - Asset
  - Data
  - Effect
  - Ledger
  - Offer
  - Operation
  - Orderbook
  - Page
  - Payment Path
  - Trade
  - Trade Aggregation
  - Transaction
- Errors
JavaScript SDK
Go SDK
Java SDK
Ruby SDK
Python SDK
C# SDK

Operation [Go SDK]

Operations are objects that represent a desired change to the ledger: payments, offers to exchange currency, changes made to account options, etc. Operations are submitted to the Stellar network grouped in a Transaction.

To learn more about the concept of operations in the Stellar network, take a look at the Stellar operations concept guide.

Operation Types

type	type_i	description
CREATE_ACCOUNT	0	Creates a new account in Stellar network.
PAYMENT	1	Sends a simple payment between two accounts in Stellar network.
PATH_PAYMENT	2	Sends a path payment between two accounts in the Stellar network.
MANAGE_OFFER	3	Creates, updates or deletes an offer in the Stellar network.
CREATE_PASSIVE_OFFER	4	Creates an offer that won’t consume a counter offer that exactly matches this offer.
SET_OPTIONS	5	Sets account options (inflation destination, adding signers, etc.)
CHANGE_TRUST	6	Creates, updates or deletes a trust line.
ALLOW_TRUST	7	Updates the “authorized” flag of an existing trust line this is called by the issuer of the related asset.
ACCOUNT_MERGE	8	Deletes account and transfers remaining balance to destination account.
INFLATION	9	Runs inflation.
MANAGE_DATA	10	Set, modify or delete a Data Entry (name/value pair) for an account.
BUMP_SEQUENCE	11	Bumps forward the sequence number of an account.

Every operation type shares a set of common attributes and links, some operations also contain additional attributes and links specific to that operation type.

Common Attributes

	Type
id	number	The canonical id of this operation, suitable for use as the :id parameter for url templates that require an operation’s ID.
paging_token	any	A paging token suitable for use as a `cursor` parameter.
type	string	A string representation of the type of operation.
type_i	number	Specifies the type of operation, See “Types” section below for reference.

Common Links

	Relation
self	Relative link to the current operation
succeeds	Relative link to the list of operations succeeding the current operation.
precedes	Relative link to the list of operations preceding the current operation.
effects	The effects this operation triggered
transaction	The transaction this operation is part of

Each operation type will have a different set of attributes, in addition to the common attributes listed above.

Create Account

Create Account operation represents a new account creation.

Attributes

Field	Type	Description
account	string	A new account that was funded.
funder	string	Account that funded a new account.
starting_balance	string	Amount the account was funded.

Example

{
  "_links": {
    "effects": {
      "href": "/operations/402494270214144/effects/{?cursor,limit,order}",
      "templated": true
    },
    "precedes": {
      "href": "/operations?cursor=402494270214144&order=asc"
    },
    "self": {
      "href": "/operations/402494270214144"
    },
    "succeeds": {
      "href": "/operations?cursor=402494270214144&order=desc"
    },
    "transactions": {
      "href": "/transactions/402494270214144"
    }
  },
  "account": "GCEZWKCA5VLDNRLN3RPRJMRZOX3Z6G5CHCGSNFHEYVXM3XOJMDS674JZ",
  "funder": "GBIA4FH6TV64KSPDAJCNUQSM7PFL4ILGUVJDPCLUOPJ7ONMKBBVUQHRO",
  "id": 402494270214144,
  "paging_token": "402494270214144",
  "starting_balance": "10000.0",
  "type_i": 0,
  "type": "create_account"
}

Payment

A payment operation represents a payment from one account to another. This payment can be either a simple native asset payment or a fiat asset payment.

Attributes

Field	Type	Description
from	string	Sender of a payment.
to	string	Destination of a payment.
asset_type	string	Asset type (native / alphanum4 / alphanum12)
asset_code	string	Code of the destination asset.
asset_issuer	string	Asset issuer.
amount	string	Amount sent.

Links

	Example	Relation
sender	/accounts/GA5WBPYA5Y4WAEHXWR2UKO2UO4BUGHUQ74EUPKON2QHV4WRHOIRNKKH2	Sending account
receiver	/accounts/GCEZWKCA5VLDNRLN3RPRJMRZOX3Z6G5CHCGSNFHEYVXM3XOJMDS674JZ	Receiving account

Example

{
  "_links": {
    "effects": {
      "href": "/operations/58402965295104/effects/{?cursor,limit,order}",
      "templated": true
    },
    "precedes": {
      "href": "/operations?cursor=58402965295104&order=asc"
    },
    "self": {
      "href": "/operations/58402965295104"
    },
    "succeeds": {
      "href": "/operations?cursor=58402965295104&order=desc"
    },
    "transactions": {
      "href": "/transactions/58402965295104"
    }
  },
  "amount": "200.0",
  "asset_type": "native",
  "from": "GAKLBGHNHFQ3BMUYG5KU4BEWO6EYQHZHAXEWC33W34PH2RBHZDSQBD75",
  "id": 58402965295104,
  "paging_token": "58402965295104",
  "to": "GCEZWKCA5VLDNRLN3RPRJMRZOX3Z6G5CHCGSNFHEYVXM3XOJMDS674JZ",
  "type_i": 1,
  "type": "payment"
}

Path Payment

A path payment operation represents a payment from one account to another through a path. This type of payment starts as one type of asset and ends as another type of asset. There can be other assets that are traded into and out of along the path.

Attributes

Field	Type	Description
from	string	Sender of a payment.
to	string	Destination of a payment.
asset_code	string	Code of the destination asset.
asset_issuer	string	Destination asset issuer.
asset_type	string	Destination asset type (native / alphanum4 / alphanum12)
amount	string	Amount received.
source_asset_code	string	Code of the source asset.
source_asset_issuer	string	Source asset issuer.
source_asset_type	string	Source asset type (native / alphanum4 / alphanum12)
source_max	string	Max send amount.
source_amount	string	Amount sent.

Example

{
  "_links": {
    "effects": {
      "href": "/operations/25769807873/effects/{?cursor,limit,order}",
      "templated": true
    },
    "precedes": {
      "href": "/operations?cursor=25769807873\u0026order=asc"
    },
    "self": {
      "href": "/operations/25769807873"
    },
    "succeeds": {
      "href": "/operations?cursor=25769807873\u0026order=desc"
    },
    "transaction": {
      "href": "/transactions/25769807872"
    }
  },
  "amount": "10.0",
  "asset_code": "EUR",
  "asset_issuer": "GCQPYGH4K57XBDENKKX55KDTWOTK5WDWRQOH2LHEDX3EKVIQRLMESGBG",
  "asset_type": "credit_alphanum4",
  "from": "GCXKG6RN4ONIEPCMNFB732A436Z5PNDSRLGWK7GBLCMQLIFO4S7EYWVU",
  "id": 25769807873,
  "paging_token": "25769807873",
  "source_asset_code": "USD",
  "source_asset_issuer": "GC23QF2HUE52AMXUFUH3AYJAXXGXXV2VHXYYR6EYXETPKDXZSAW67XO4",
  "source_asset_type": "credit_alphanum4",
  "source_amount": "10.0",
  "source_max": "10.0",
  "to": "GA5WBPYA5Y4WAEHXWR2UKO2UO4BUGHUQ74EUPKON2QHV4WRHOIRNKKH2",
  "type_i": 2,
  "type": "path_payment"
}

Manage Offer

A “Manage Offer” operation can create, update or delete an offer to trade assets in the Stellar network. It specifies an issuer, a price and amount of a given asset to buy or sell.

When this operation is applied to the ledger, trades can potentially be executed if this offer crosses others that already exist in the ledger.

In the event that there are not enough crossing orders to fill the order completely a new “Offer” object will be created in the ledger. As other accounts make offers or payments, this offer can potentially be filled.

Attributes

Field	Type	Description
offer_id	number	Offer ID.
amount	string	Amount of asset to be sold.
buying_asset_code	string	The code of asset to buy.
buying_asset_issuer	string	The issuer of asset to buy.
buying_asset_type	string	Type of asset to buy (native / alphanum4 / alphanum12)
price	string	Price to buy a buying_asset
price_r	Object	n: price numerator, d: price denominator
selling_asset_code	string	The code of asset to sell.
selling_asset_issuer	string	The issuer of asset to sell.
selling_asset_type	string	Type of asset to sell (native / alphanum4 / alphanum12)

Example

{
  "_links": {
    "effects": {
      "href": "/operations/592323234762753/effects{?cursor,limit,order}",
      "templated": true
    },
    "precedes": {
      "href": "/operations?cursor=592323234762753\u0026order=asc"
    },
    "self": {
      "href": "/operations/592323234762753"
    },
    "succeeds": {
      "href": "/operations?cursor=592323234762753\u0026order=desc"
    },
    "transaction": {
      "href": "/transactions/592323234762752"
    }
  },
  "amount": "100.0",
  "buying_asset_code": "CHP",
  "buying_asset_issuer": "GAC2ZUXVI5266NMMGDPBMXHH4BTZKJ7MMTGXRZGX2R5YLMFRYLJ7U5EA",
  "buying_asset_type": "credit_alphanum4",
  "id": 592323234762753,
  "offer_id": 8,
  "paging_token": "592323234762753",
  "price": "2.0",
  "price_r": {
    "d": 1,
    "n": 2
  },
  "selling_asset_code": "YEN",
  "selling_asset_issuer": "GDVXG2FMFFSUMMMBIUEMWPZAIU2FNCH7QNGJMWRXRD6K5FZK5KJS4DDR",
  "selling_asset_type": "credit_alphanum4",
  "type_i": 3,
  "type": "manage_offer"
}

Create Passive Offer

“Create Passive Offer” operation creates an offer that won’t consume a counter offer that exactly matches this offer. This is useful for offers just used as 1:1 exchanges for path payments. Use Manage Offer to manage this offer after using this operation to create it.

Attributes

As in Manage Offer operation.

Example

{
  "_links": {
    "effects": {
      "href": "/operations/1127729562914817/effects{?cursor,limit,order}",
      "templated": true
    },
    "precedes": {
      "href": "/operations?cursor=1127729562914817\u0026order=asc"
    },
    "self": {
      "href": "/operations/1127729562914817"
    },
    "succeeds": {
      "href": "/operations?cursor=1127729562914817\u0026order=desc"
    },
    "transaction": {
      "href": "/transactions/1127729562914816"
    }
  },
  "amount": "11.27827",
  "buying_asset_code": "USD",
  "buying_asset_issuer": "GDS5JW5E6DRSSN5XK4LW7E6VUMFKKE2HU5WCOVFTO7P2RP7OXVCBLJ3Y",
  "buying_asset_type": "credit_alphanum4",
  "id": 1127729562914817,
  "offer_id": 9,
  "paging_token": "1127729562914817",
  "price": "1.0",
  "price_r": {
    "d": 1,
    "n": 1
  },
  "selling_asset_type": "native",
  "type_i": 4,
  "type": "create_passive_offer"
}

Set Options

Use “Set Options” operation to set following options to your account:

Set/clear account flags:
- AUTH_REQUIRED_FLAG (0x1) - if set, TrustLines are created with authorized set to false requiring the issuer to set it for each TrustLine.
- AUTH_REVOCABLE_FLAG (0x2) - if set, the authorized flag in TrustLines can be cleared. Otherwise, authorization cannot be revoked.
Set the account’s inflation destination.
Add new signers to the account.
Set home domain.

Attributes

Field	Type	Description
signer_key	string	The public key of the new signer.
signer_weight	int	The weight of the new signer (1-255).
master_key_weight	int	The weight of the master key (1-255).
low_threshold	int	The sum weight for the low threshold.
med_threshold	int	The sum weight for the medium threshold.
high_threshold	int	The sum weight for the high threshold.
home_domain	string	The home domain used for reverse federation lookup
set_flags	array	The array of numeric values of flags that has been set in this operation
set_flags_s	array	The array of string values of flags that has been set in this operation
clear_flags	array	The array of numeric values of flags that has been cleared in this operation
clear_flags_s	array	The array of string values of flags that has been cleared in this operation

Example

{
  "_links": {
    "effects": {
      "href": "/operations/696867033714691/effects{?cursor,limit,order}",
      "templated": true
    },
    "precedes": {
      "href": "/operations?cursor=696867033714691\u0026order=asc"
    },
    "self": {
      "href": "/operations/696867033714691"
    },
    "succeeds": {
      "href": "/operations?cursor=696867033714691\u0026order=desc"
    },
    "transaction": {
      "href": "/transactions/696867033714688"
    }
  },
  "high_threshold": 3,
  "home_domain": "stellar.org",
  "id": 696867033714691,
  "low_threshold": 0,
  "med_threshold": 3,
  "paging_token": "696867033714691",
  "set_flags": [
    1
  ],
  "set_flags_s": [
    "auth_required_flag"
  ],
  "type_i": 5,
  "type": "set_options"
}

Change Trust

Use “Change Trust” operation to create/update/delete a trust line from the source account to another. The issuer being trusted and the asset code are in the given Asset object.

Attributes

Field	Type	Description
asset_code	string	Asset code.
asset_issuer	string	Asset issuer.
asset_type	string	Asset type (native / alphanum4 / alphanum12)
trustee	string	Trustee account.
trustor	string	Trustor account.
limit	string	The limit for the asset.

Example

{
  "_links": {
    "effects": {
      "href": "/operations/574731048718337/effects{?cursor,limit,order}",
      "templated": true
    },
    "precedes": {
      "href": "/operations?cursor=574731048718337\u0026order=asc"
    },
    "self": {
      "href": "/operations/574731048718337"
    },
    "succeeds": {
      "href": "/operations?cursor=574731048718337\u0026order=desc"
    },
    "transaction": {
      "href": "/transactions/574731048718336"
    }
  },
  "asset_code": "CHP",
  "asset_issuer": "GAC2ZUXVI5266NMMGDPBMXHH4BTZKJ7MMTGXRZGX2R5YLMFRYLJ7U5EA",
  "asset_type": "credit_alphanum4",
  "id": 574731048718337,
  "limit": "5.0",
  "paging_token": "574731048718337",
  "trustee": "GAC2ZUXVI5266NMMGDPBMXHH4BTZKJ7MMTGXRZGX2R5YLMFRYLJ7U5EA",
  "trustor": "GDVXG2FMFFSUMMMBIUEMWPZAIU2FNCH7QNGJMWRXRD6K5FZK5KJS4DDR",
  "type_i": 6,
  "type": "change_trust"
}

Allow Trust

Updates the “authorized” flag of an existing trust line this is called by the issuer of the asset.

Heads up! Unless the issuing account has AUTH_REVOCABLE_FLAG set than the “authorized” flag can only be set and never cleared.

Attributes

Field	Type	Description
asset_code	string	Asset code.
asset_issuer	string	Asset issuer.
asset_type	string	Asset type (native / alphanum4 / alphanum12)
authorize	bool	`true` when allowing trust, `false` when revoking trust
trustee	string	Trustee account.
trustor	string	Trustor account.

Example

{
  "_links": {
    "effects": {
      "href": "/operations/34359742465/effects/{?cursor,limit,order}",
      "templated": true
    },
    "precedes": {
      "href": "/operations?cursor=34359742465\u0026order=asc"
    },
    "self": {
      "href": "/operations/34359742465"
    },
    "succeeds": {
      "href": "/operations?cursor=34359742465\u0026order=desc"
    },
    "transaction": {
      "href": "/transactions/34359742464"
    }
  },
  "asset_code": "USD",
  "asset_issuer": "GC23QF2HUE52AMXUFUH3AYJAXXGXXV2VHXYYR6EYXETPKDXZSAW67XO4",
  "asset_type": "credit_alphanum4",
  "authorize": true,
  "id": 34359742465,
  "paging_token": "34359742465",
  "trustee": "GC23QF2HUE52AMXUFUH3AYJAXXGXXV2VHXYYR6EYXETPKDXZSAW67XO4",
  "trustor": "GBXGQJWVLWOYHFLVTKWV5FGHA3LNYY2JQKM7OAJAUEQFU6LPCSEFVXON",
  "type_i": 7,
  "type": "allow_trust"
}

Account Merge

Removes the account and transfers all remaining XLM to the destination account.

Attributes

Field	Type	Description
into	string	Account ID where funds of deleted account were transferred.

Example

{
  "_links": {
    "effects": {
      "href": "/operations/799357838299137/effects{?cursor,limit,order}",
      "templated": true
    },
    "precedes": {
      "href": "/operations?cursor=799357838299137\u0026order=asc"
    },
    "self": {
      "href": "/operations/799357838299137"
    },
    "succeeds": {
      "href": "/operations?cursor=799357838299137\u0026order=desc"
    },
    "transaction": {
      "href": "/transactions/799357838299136"
    }
  },
  "account": "GBCR5OVQ54S2EKHLBZMK6VYMTXZHXN3T45Y6PRX4PX4FXDMJJGY4FD42",
  "id": 799357838299137,
  "into": "GBS43BF24ENNS3KPACUZVKK2VYPOZVBQO2CISGZ777RYGOPYC2FT6S3K",
  "paging_token": "799357838299137",
  "type_i": 8,
  "type": "account_merge"
}

Inflation

Runs inflation.

Example

{
  "_links": {
    "effects": {
      "href": "/operations/12884914177/effects/{?cursor,limit,order}",
      "templated": true
    },
    "precedes": {
      "href": "/operations?cursor=12884914177\u0026order=asc"
    },
    "self": {
      "href": "/operations/12884914177"
    },
    "succeeds": {
      "href": "/operations?cursor=12884914177\u0026order=desc"
    },
    "transaction": {
      "href": "/transactions/12884914176"
    }
  },
  "id": 12884914177,
  "paging_token": "12884914177",
  "type_i": 9,
  "type": "inflation"
}

Manage Data

Set, modify or delete a Data Entry (name/value pair) for an account.

Example

{
  "_links": {
    "self": {
      "href": "/operations/5250180907536385"
    },
    "transaction": {
      "href": "/transactions/e0710d3e410fe6b1ba77fcfec9e3789e94ff29b2424f1f4bf51e530dbbdf221c"
    },
    "effects": {
      "href": "/operations/5250180907536385/effects"
    },
    "succeeds": {
      "href": "/effects?order=desc&cursor=5250180907536385"
    },
    "precedes": {
      "href": "/effects?order=asc&cursor=5250180907536385"
    }
  },
  "id": "5250180907536385",
  "paging_token": "5250180907536385",
  "source_account": "GCGG3CIRBG2TTBR4HYZJ7JLDRFKZIYOAHFXRWLU62CA2QN52P2SUQNPJ",
  "type": "manage_data",
  "type_i": 10,
  "name": "lang",
  "value": "aW5kb25lc2lhbg=="
}

Bump Sequence

Bumps forward the sequence number of the source account of the operation, allowing it to invalidate any transactions with a smaller sequence number.

Attributes

Field	Type	Description
bumpTo	number	Desired value for the operation’s source account sequence number.

Example

{
  "_links": {
    "self": {
      "href": "/operations/1743756726273"
    },
    "transaction": {
      "href": "/transactions/328436a8dffaf6ca33c08a93279234c7d3eaf1c028804152614187dc76b7168d"
    },
    "effects": {
      "href": "/operations/1743756726273/effects"
    },
    "succeeds": {
      "href": "/effects?order=desc&cursor=1743756726273"
    },
    "precedes": {
      "href": "/effects?order=asc&cursor=1743756726273"
    }
  },
  "id": "1743756726273",
  "paging_token": "1743756726273",
  "source_account": "GBHPJ3VMVT3X7Y6HIIAPK7YPTZCF3CWO4557BKGX2GVO4O7EZHIBELLH",
  "type": "bump_sequence",
  "type_i": 11,
  "transaction_hash": "328436a8dffaf6ca33c08a93279234c7d3eaf1c028804152614187dc76b7168d",
  "bump_to": "1273737228"
}

Endpoints

Resource	Type	Resource URI Template
All Operations	Collection	`/operations`
Operations Details	Single	`/operations/:id`
Ledger Operations	Collection	`/ledgers/{id}/operations{?cursor,limit,order}`
Account Operations	Collection	`/accounts/:account_id/operations`
Account Payments	Collection	`/accounts/:account_id/payments`

Edit this doc in GitHub