diff --git a/api/anchor-platform/callbacks/event/index.mdx b/api/anchor-platform/callbacks/event/index.mdx new file mode 100644 index 000000000..e1f42f072 --- /dev/null +++ b/api/anchor-platform/callbacks/event/index.mdx @@ -0,0 +1,21 @@ +--- +title: Events +order: 0 +--- + +import {EndpointsTable} from "@site/src/components/EndpointsTable"; + +The Anchor Platform can be configured to notify the business of events, such as a transaction being initiated by a client or a payment being sent to one of the business' distribution accounts. + +Currently, the Anchor Platform takes a fairly unforgiving approach to event delivery, retrying a maximum of three times within three seconds before discarding the event. This will likely change in future releases, but for now, businesses should ensure that they implement a mechanism to recover from missed events. + +For example, if you're using the Anchor Platform's `--stellar-observer` to monitor incoming payments, a cron job can check how long it has been since a transaction was updated as ready to receive funds, and if a reasonable amount of time has passed without receiving funds, it can fetch the latest status of the transaction using the Anchor Platform's `GET /transactions/:id` endpoint to make sure the event was not missed, or continuing processing the transaction if it was. + + + +| | | +| --- | --------------------- | +| POST | [/event](../post-event.api.mdx) | + + + \ No newline at end of file diff --git a/api/anchor-platform/callbacks/get-rates.api.mdx b/api/anchor-platform/callbacks/get-rates.api.mdx index 1efe467ae..98aec44f1 100644 --- a/api/anchor-platform/callbacks/get-rates.api.mdx +++ b/api/anchor-platform/callbacks/get-rates.api.mdx @@ -5,7 +5,7 @@ description: "Transactions that involve two non-equivalent on & off-chain assets sidebar_label: "Retrieve Rates" hide_title: true hide_table_of_contents: true -api: {"description":"Transactions that involve two non-equivalent on & off-chain assets (such as USDC on Stellar and fiat EUR) must\nuse exchange rates that are communicated to the client application requesting the transaction. When clients make\nrequests to the Platform for these exchange rates, the Platform sends this request to the anchor to fetch it.\n\nRates can be [indicative](https://www.investopedia.com/terms/i/indicativequote.asp) or\n[firm](https://www.investopedia.com/terms/f/firmquote.asp). The anchor must provide an ID and expiration if the\nclient requests a firm rate.\n\nAnchors can provide discounted rates specific client applications. The Platform includes the `client_id` parameter\nfor this reason.\n\nEither `sell_amount` or `buy_amount` will be included in requests as parameters, but never both. In the same way,\neither `sell_delivery_method` and `buy_delivery_method` may be included in requests, but never both, since either\n`sell_asset` or `buy_asset` is a Stellar asset.\n","tags":["Rates","SEP-31"],"operationId":"getRates","parameters":[{"in":"query","name":"type","description":"The type of rate requested. If `firm`, the response must include `rate.id` and `rate.expires_at`.","schema":{"type":"string","enum":["indicative","firm"]},"required":true},{"in":"query","name":"client_id","description":"An identifier for the client application making the request. This ID can be used to offer different fees to different clients.\n\nClient IDs will be the Stellar public key the public key used to authenticate via SEP-10. Anchors must ensure\nthat the public key specified in the request matches a public key known to belong to the sending anchor.\n\nThis parameter will only be specified if the client is authenticated via SEP-10. Anchors can define whether or not\nauthentication is required for fetching indicative rates. Firm rates always require authentication.\n","schema":{"type":"string"}},{"in":"query","name":"sell_asset","description":"The asset the client application will send to the anchor in exchange for `buy_asset` in\n[Asset Identification Format](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0038.md#asset-identification-format).\n","schema":{"type":"string"},"required":true},{"in":"query","name":"buy_asset","description":"The asset the that the anchor will send in exchange for `sell_asset` in\n[Asset Identification Format](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0038.md#asset-identification-format).\n","schema":{"type":"string"},"required":true},{"in":"query","name":"sell_amount","description":"The amount of `sell_asset` the client application will send in exchange for `buy_asset`. Will not be used in\nconjuction with `buy_amount`.\n","schema":{"type":"string"}},{"in":"query","name":"buy_amount","description":"The amount of `buy_asset` the anchor will send in exchange for `sell_asset`. Will not be used in conjuction\nwith `sell_amount`.\n","schema":{"type":"string"}},{"in":"query","name":"country_code","description":"The [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) code of the user's current address.\nAnchors should expect this parameter to be provided if one of the assets of the buy/sell pair is fiat and it\nis available in two or more countries.\n","schema":{"type":"string"}},{"in":"query","name":"expire_after","description":"The client's desired `expires_at` date and time for the quote that can be used if this is a firm quote. This should\nbe a [UTC ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) string. Anchors should return `400 Bad\nRequest` if an expiration date on or after the requested value cannot be provided.\n","schema":{"type":"string"}},{"in":"query","name":"sell_delivery_method","description":"The method the client or user will use to deliver `sell_asset` to the Anchor. This value may affect the\nexpiration and price provided. The values used for this parameter is defined in the application's configuration.\nWill not be used in conjuction with `buy_delivery_method`.\n","schema":{"type":"string"}},{"in":"query","name":"buy_delivery_method","description":"The method the client or user wants used to receive `buy_asset` from the Anchor. This value may affect the\nexpiration and price provided. The values used for this parameter is defined in the application's configuration.\nWill not be used in conjuction with `sell_delivery_method`.\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"rate":{"type":"object","properties":{"id":{"type":"string","description":"ID of the firm quote. NOT USED when `type=indicative`."},"expires_at":{"type":"string","format":"date-time","description":"Expiration for the quote. NOT USED when `type=indicative`."},"price":{"type":"string","description":"The conversion price offered by the anchor for one unit of `buy_asset` in terms of `sell_asset`, without including fees. In traditional finance, `buy_asset` would be referred to as the base asset and `sell_asset` as the counter asset. The formula `sell_amount - fee = price * buy_amount` must hold true ([ref](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0038.md#price-formulas))."},"sell_amount":{"type":"string","description":"The amount of `sell_asset` the anchor will exchange for `buy_asset`. It could be different from the `sell_amount` provided in the request, depending on how fees are applied by the Anchor."},"buy_amount":{"type":"string","description":"The amount of `buy_asset` the anchor will provide with `sell_asset`. It could be different from the `buy_amount` provided in the request, depending on how fees are applied by the Anchor."},"fee":{"type":"object","description":"An object describing the fees added on top of the rate provided via the `price` attribute.","properties":{"total":{"type":"string","description":"The total fee to be applied."},"asset":{"type":"string","description":"The asset the fee will be charged in. Must be represented in [Asset Identification Format](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0038.md#asset-identification-format)."},"details":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the fee, for example `ACH fee`, `Brazilian conciliation fee`, `Service fee`, etc."},"description":{"type":"string","description":"A text describing the fee."},"amount":{"type":"string","description":"The amount of asset applied. If `fee.details` is provided, `sum(fee.details.amount)` should be equals `fee.total`."}},"required":["name","amount"],"title":"RateFeeDetailResponse"}}},"required":["total","asset"],"title":"RateFeeResponse"}},"required":["price","sell_amount","buy_amount"]}},"title":"RateResponse"}}}},"422":{"description":"Unprocessable Entity. This status should be returned when the anchor understood the request but cannot\nreturn a success response.\nIn these cases, the Platform will respond to the client application's request with a `400 Bad Request`\nand include the error message provided by the anchor in the response body.\n","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"id":{"type":"string"}},"required":["error"],"title":"Error"}}}},"500":{"description":"Error. The Platform will respond to the client application with the same response code and body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"id":{"type":"string"}},"required":["error"],"title":"Error"}}}}},"method":"get","path":"/rate","info":{"version":"2.0.0","description":"The Synchronous Callbacks API specification for the Stellar Anchor Platform project.\n\nThe Synchronous Callbacks API defines requests made by the Platform while it is processing a request from a client application. The\nanchor's responses to these requests affect the Platform responses to the client application.\n","title":"Synchronous Callbacks API"},"postman":{"name":"Retrieve Rates","description":{"content":"Transactions that involve two non-equivalent on & off-chain assets (such as USDC on Stellar and fiat EUR) must\nuse exchange rates that are communicated to the client application requesting the transaction. When clients make\nrequests to the Platform for these exchange rates, the Platform sends this request to the anchor to fetch it.\n\nRates can be [indicative](https://www.investopedia.com/terms/i/indicativequote.asp) or\n[firm](https://www.investopedia.com/terms/f/firmquote.asp). The anchor must provide an ID and expiration if the\nclient requests a firm rate.\n\nAnchors can provide discounted rates specific client applications. The Platform includes the `client_id` parameter\nfor this reason.\n\nEither `sell_amount` or `buy_amount` will be included in requests as parameters, but never both. In the same way,\neither `sell_delivery_method` and `buy_delivery_method` may be included in requests, but never both, since either\n`sell_asset` or `buy_asset` is a Stellar asset.\n","type":"text/plain"},"url":{"path":["rate"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) The type of rate requested. If `firm`, the response must include `rate.id` and `rate.expires_at`.","type":"text/plain"},"key":"type","value":""},{"disabled":false,"description":{"content":"An identifier for the client application making the request. This ID can be used to offer different fees to different clients.\n\nClient IDs will be the Stellar public key the public key used to authenticate via SEP-10. Anchors must ensure\nthat the public key specified in the request matches a public key known to belong to the sending anchor.\n\nThis parameter will only be specified if the client is authenticated via SEP-10. Anchors can define whether or not\nauthentication is required for fetching indicative rates. Firm rates always require authentication.\n","type":"text/plain"},"key":"client_id","value":""},{"disabled":false,"description":{"content":"(Required) The asset the client application will send to the anchor in exchange for `buy_asset` in\n[Asset Identification Format](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0038.md#asset-identification-format).\n","type":"text/plain"},"key":"sell_asset","value":""},{"disabled":false,"description":{"content":"(Required) The asset the that the anchor will send in exchange for `sell_asset` in\n[Asset Identification Format](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0038.md#asset-identification-format).\n","type":"text/plain"},"key":"buy_asset","value":""},{"disabled":false,"description":{"content":"The amount of `sell_asset` the client application will send in exchange for `buy_asset`. Will not be used in\nconjuction with `buy_amount`.\n","type":"text/plain"},"key":"sell_amount","value":""},{"disabled":false,"description":{"content":"The amount of `buy_asset` the anchor will send in exchange for `sell_asset`. Will not be used in conjuction\nwith `sell_amount`.\n","type":"text/plain"},"key":"buy_amount","value":""},{"disabled":false,"description":{"content":"The [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) code of the user's current address.\nAnchors should expect this parameter to be provided if one of the assets of the buy/sell pair is fiat and it\nis available in two or more countries.\n","type":"text/plain"},"key":"country_code","value":""},{"disabled":false,"description":{"content":"The client's desired `expires_at` date and time for the quote that can be used if this is a firm quote. This should\nbe a [UTC ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) string. Anchors should return `400 Bad\nRequest` if an expiration date on or after the requested value cannot be provided.\n","type":"text/plain"},"key":"expire_after","value":""},{"disabled":false,"description":{"content":"The method the client or user will use to deliver `sell_asset` to the Anchor. This value may affect the\nexpiration and price provided. The values used for this parameter is defined in the application's configuration.\nWill not be used in conjuction with `buy_delivery_method`.\n","type":"text/plain"},"key":"sell_delivery_method","value":""},{"disabled":false,"description":{"content":"The method the client or user wants used to receive `buy_asset` from the Anchor. This value may affect the\nexpiration and price provided. The values used for this parameter is defined in the application's configuration.\nWill not be used in conjuction with `sell_delivery_method`.\n","type":"text/plain"},"key":"buy_delivery_method","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"description":"Transactions that involve two non-equivalent on & off-chain assets (such as USDC on Stellar and fiat EUR) must\nuse exchange rates that are communicated to the client application requesting the transaction. When clients make\nrequests to the Platform for these exchange rates, the Platform sends this request to the anchor to fetch it.\n\nRates can be [indicative](https://www.investopedia.com/terms/i/indicativequote.asp) or\n[firm](https://www.investopedia.com/terms/f/firmquote.asp). The anchor must provide an ID and expiration if the\nclient requests a firm rate.\n\nAnchors can provide discounted rates specific client applications. The Platform includes the `client_id` parameter\nfor this reason.\n\nEither `sell_amount` or `buy_amount` will be included in requests as parameters, but never both. In the same way,\neither `sell_delivery_method` and `buy_delivery_method` may be included in requests, but never both, since either\n`sell_asset` or `buy_asset` is a Stellar asset.\n","tags":["Rates","SEP-31","SEP-38"],"operationId":"getRates","parameters":[{"in":"query","name":"type","description":"The type of rate requested. If `firm`, the response must include `rate.id` and `rate.expires_at`.","schema":{"type":"string","enum":["indicative","firm"]},"required":true},{"in":"query","name":"client_id","description":"An identifier for the client application making the request. This ID can be used to offer different fees to different clients.\n\nClient IDs will be the Stellar public key the public key used to authenticate via SEP-10. Anchors must ensure\nthat the public key specified in the request matches a public key known to belong to the sending anchor.\n\nThis parameter will only be specified if the client is authenticated via SEP-10. Anchors can define whether or not\nauthentication is required for fetching indicative rates. Firm rates always require authentication.\n","schema":{"type":"string"}},{"in":"query","name":"sell_asset","description":"The asset the client application will send to the anchor in exchange for `buy_asset` in\n[Asset Identification Format](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0038.md#asset-identification-format).\n","schema":{"type":"string"},"required":true},{"in":"query","name":"buy_asset","description":"The asset the that the anchor will send in exchange for `sell_asset` in\n[Asset Identification Format](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0038.md#asset-identification-format).\n","schema":{"type":"string"},"required":true},{"in":"query","name":"sell_amount","description":"The amount of `sell_asset` the client application will send in exchange for `buy_asset`. Will not be used in\nconjuction with `buy_amount`.\n","schema":{"type":"string"}},{"in":"query","name":"buy_amount","description":"The amount of `buy_asset` the anchor will send in exchange for `sell_asset`. Will not be used in conjuction\nwith `sell_amount`.\n","schema":{"type":"string"}},{"in":"query","name":"country_code","description":"The [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) code of the user's current address.\nAnchors should expect this parameter to be provided if one of the assets of the buy/sell pair is fiat and it\nis available in two or more countries.\n","schema":{"type":"string"}},{"in":"query","name":"expire_after","description":"The client's desired `expires_at` date and time for the quote that can be used if this is a firm quote. This should\nbe a [UTC ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) string. Anchors should return `400 Bad\nRequest` if an expiration date on or after the requested value cannot be provided.\n","schema":{"type":"string"}},{"in":"query","name":"sell_delivery_method","description":"The method the client or user will use to deliver `sell_asset` to the Anchor. This value may affect the\nexpiration and price provided. The values used for this parameter is defined in the application's configuration.\nWill not be used in conjuction with `buy_delivery_method`.\n","schema":{"type":"string"}},{"in":"query","name":"buy_delivery_method","description":"The method the client or user wants used to receive `buy_asset` from the Anchor. This value may affect the\nexpiration and price provided. The values used for this parameter is defined in the application's configuration.\nWill not be used in conjuction with `sell_delivery_method`.\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"rate":{"type":"object","properties":{"id":{"type":"string","description":"ID of the firm quote. NOT USED when `type=indicative`."},"expires_at":{"type":"string","format":"date-time","description":"Expiration for the quote. NOT USED when `type=indicative`."},"price":{"type":"string","description":"The conversion price offered by the anchor for one unit of `buy_asset` in terms of `sell_asset`, without including fees. In traditional finance, `buy_asset` would be referred to as the base asset and `sell_asset` as the counter asset. The formula `sell_amount - fee = price * buy_amount` must hold true ([ref](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0038.md#price-formulas))."},"sell_amount":{"type":"string","description":"The amount of `sell_asset` the anchor will exchange for `buy_asset`. It could be different from the `sell_amount` provided in the request, depending on how fees are applied by the Anchor."},"buy_amount":{"type":"string","description":"The amount of `buy_asset` the anchor will provide with `sell_asset`. It could be different from the `buy_amount` provided in the request, depending on how fees are applied by the Anchor."},"fee":{"type":"object","description":"An object describing the fees added on top of the rate provided via the `price` attribute.","properties":{"total":{"type":"string","description":"The total fee to be applied."},"asset":{"type":"string","description":"The asset the fee will be charged in. Must be represented in [Asset Identification Format](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0038.md#asset-identification-format)."},"details":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the fee, for example `ACH fee`, `Brazilian conciliation fee`, `Service fee`, etc."},"description":{"type":"string","description":"A text describing the fee."},"amount":{"type":"string","description":"The amount of asset applied. If `fee.details` is provided, `sum(fee.details.amount)` should be equals `fee.total`."}},"required":["name","amount"],"title":"RateFeeDetailResponse"}}},"required":["total","asset"],"title":"RateFeeResponse"}},"required":["price","sell_amount","buy_amount"]}},"title":"RateResponse"}}}},"422":{"description":"Unprocessable Entity. This status should be returned when the anchor understood the request but cannot\nreturn a success response.\nIn these cases, the Platform will respond to the client application's request with a `400 Bad Request`\nand include the error message provided by the anchor in the response body.\n","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"id":{"type":"string"}},"required":["error"],"title":"Error"}}}},"500":{"description":"Error. The Platform will respond to the client application with the same response code and body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"id":{"type":"string"}},"required":["error"],"title":"Error"}}}}},"method":"get","path":"/rate","info":{"version":"2.0.0","description":"The Synchronous Callbacks API specification for the Stellar Anchor Platform project.\n\nThe Synchronous Callbacks API defines requests made by the Platform while it is processing a request from a client application. The\nanchor's responses to these requests affect the Platform responses to the client application.\n","title":"Synchronous Callbacks API"},"postman":{"name":"Retrieve Rates","description":{"content":"Transactions that involve two non-equivalent on & off-chain assets (such as USDC on Stellar and fiat EUR) must\nuse exchange rates that are communicated to the client application requesting the transaction. When clients make\nrequests to the Platform for these exchange rates, the Platform sends this request to the anchor to fetch it.\n\nRates can be [indicative](https://www.investopedia.com/terms/i/indicativequote.asp) or\n[firm](https://www.investopedia.com/terms/f/firmquote.asp). The anchor must provide an ID and expiration if the\nclient requests a firm rate.\n\nAnchors can provide discounted rates specific client applications. The Platform includes the `client_id` parameter\nfor this reason.\n\nEither `sell_amount` or `buy_amount` will be included in requests as parameters, but never both. In the same way,\neither `sell_delivery_method` and `buy_delivery_method` may be included in requests, but never both, since either\n`sell_asset` or `buy_asset` is a Stellar asset.\n","type":"text/plain"},"url":{"path":["rate"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) The type of rate requested. If `firm`, the response must include `rate.id` and `rate.expires_at`.","type":"text/plain"},"key":"type","value":""},{"disabled":false,"description":{"content":"An identifier for the client application making the request. This ID can be used to offer different fees to different clients.\n\nClient IDs will be the Stellar public key the public key used to authenticate via SEP-10. Anchors must ensure\nthat the public key specified in the request matches a public key known to belong to the sending anchor.\n\nThis parameter will only be specified if the client is authenticated via SEP-10. Anchors can define whether or not\nauthentication is required for fetching indicative rates. Firm rates always require authentication.\n","type":"text/plain"},"key":"client_id","value":""},{"disabled":false,"description":{"content":"(Required) The asset the client application will send to the anchor in exchange for `buy_asset` in\n[Asset Identification Format](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0038.md#asset-identification-format).\n","type":"text/plain"},"key":"sell_asset","value":""},{"disabled":false,"description":{"content":"(Required) The asset the that the anchor will send in exchange for `sell_asset` in\n[Asset Identification Format](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0038.md#asset-identification-format).\n","type":"text/plain"},"key":"buy_asset","value":""},{"disabled":false,"description":{"content":"The amount of `sell_asset` the client application will send in exchange for `buy_asset`. Will not be used in\nconjuction with `buy_amount`.\n","type":"text/plain"},"key":"sell_amount","value":""},{"disabled":false,"description":{"content":"The amount of `buy_asset` the anchor will send in exchange for `sell_asset`. Will not be used in conjuction\nwith `sell_amount`.\n","type":"text/plain"},"key":"buy_amount","value":""},{"disabled":false,"description":{"content":"The [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) code of the user's current address.\nAnchors should expect this parameter to be provided if one of the assets of the buy/sell pair is fiat and it\nis available in two or more countries.\n","type":"text/plain"},"key":"country_code","value":""},{"disabled":false,"description":{"content":"The client's desired `expires_at` date and time for the quote that can be used if this is a firm quote. This should\nbe a [UTC ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) string. Anchors should return `400 Bad\nRequest` if an expiration date on or after the requested value cannot be provided.\n","type":"text/plain"},"key":"expire_after","value":""},{"disabled":false,"description":{"content":"The method the client or user will use to deliver `sell_asset` to the Anchor. This value may affect the\nexpiration and price provided. The values used for this parameter is defined in the application's configuration.\nWill not be used in conjuction with `buy_delivery_method`.\n","type":"text/plain"},"key":"sell_delivery_method","value":""},{"disabled":false,"description":{"content":"The method the client or user wants used to receive `buy_asset` from the Anchor. This value may affect the\nexpiration and price provided. The values used for this parameter is defined in the application's configuration.\nWill not be used in conjuction with `sell_delivery_method`.\n","type":"text/plain"},"key":"buy_delivery_method","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/anchor-platform/callbacks/synchronous-callbacks-api custom_edit_url: null @@ -13,7 +13,7 @@ custom_edit_url: null import { SepBadge } from "@site/src/components/SepBadge"; - + import ApiTabs from "@theme/ApiTabs"; import MimeTabs from "@theme/MimeTabs"; @@ -52,7 +52,7 @@ Success. An object describing the fees added on top of the rate provided via the `price` attribute. -
details object[]
  • Array [
  • ]
    • +
    details object[]
  • Array [
  • ]
    • Unprocessable Entity. This status should be returned when the anchor understood the request but cannot return a success response. diff --git a/api/anchor-platform/callbacks/post-event.api.mdx b/api/anchor-platform/callbacks/post-event.api.mdx new file mode 100644 index 000000000..e67e301c0 --- /dev/null +++ b/api/anchor-platform/callbacks/post-event.api.mdx @@ -0,0 +1,84 @@ +--- +id: post-event +title: "Receive an Event" +description: "Receive a JSON object representing an event." +sidebar_label: "Receive an Event" +hide_title: true +hide_table_of_contents: true +api: {"tags":["Events","SEP-24","SEP-31"],"operationId":"postEvent","description":"Receive a JSON object representing an event.\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["transaction_created","transaction_status_changed","transaction_error","quote_created"],"description":"The transaction event type. Can be one of the following:\n- `transaction_created` - a transaction was created through the SEP endpoints. The payload is in the `transaction` field.\n- `transaction_status_changed` - the status of a transaction has changed. The payload is in the `transaction` field.\n- `transaction_error` - error processing the transaction. The payload is in the `transaction` field.\n- `quote_created` - a quote was created via the SEP38 API. The payload is in the `quote` field.\n"},"timestamp":{"type":"string","format":"date-time"},"payload":{"type":"object","properties":{"transaction":{"oneOf":[{"type":"object","required":["id","sep","kind","status","amount_expected","destination_account","started_at"],"properties":{"id":{"type":"string"},"sep":{"type":"string","enum":["24"]},"kind":{"type":"string","enum":["deposit","withdrawal"]},"status":{"type":"string","description":"Possible status value for SEP-24 transactions","enum":["incomplete","completed","refunded","expired","error","pending_stellar","pending_external","pending_user_transfer_start","pending_user_transfer_complete","pending_anchor","pending_trust","pending_user","no_market","too_small","too_large"],"title":"StatusSEP24"},"amount_expected":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_in":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_out":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"started_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"completed_at":{"type":"string","format":"date-time"},"transfer_received_at":{"type":"string","format":"date-time"},"message":{"type":"string"},"refunds":{"type":"object","properties":{"amount_refunded":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"payments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"id_type":{"type":"string","enum":["stellar","external"]},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"requested_at":{"type":"string","format":"date-time"},"refunded_at":{"type":"string","format":"date-time"}}}}},"title":"Refunds"},"stellar_transactions":{"type":"array","items":{"type":"object","required":["id","created_at","envelope","payments"],"properties":{"id":{"type":"string","description":"The ID of the transaction in the Stellar network."},"memo":{"type":"string","description":"The memo of the transaction in the Stellar network."},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text","hash","id"]},"created_at":{"type":"string","format":"date-time","description":"The time the transaction was registered in the Stellar network."},"envelope":{"type":"string","description":"The transaction envelope, containing all the transaction information."},"payments":{"type":"array","items":{"type":"object","required":["id","payment_type","source_account","destination_account","amount"],"properties":{"id":{"type":"string","description":"The ID of the payment in the Stellar Network."},"payment_type":{"type":"string","description":"The type of payment in the Stellar Network.","enum":["payment","path_payment"],"default":"payment"},"source_account":{"type":"string","description":"The account being debited in the Stellar Network."},"destination_account":{"type":"string","description":"The account being credited in the Stellar Network."},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"}}}}},"title":"StellarTransaction"}},"source_account":{"type":"string"},"destination_account":{"type":"string"},"external_transaction_id":{"type":"string"},"memo":{"type":"string"},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text id hash"],"title":"MemoType"},"refund_memo":{"description":"if provided, this memo should be used for refund transactions","type":"string"},"refund_memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text id hash"],"title":"MemoType"}},"title":"TransactionSEP24"},{"type":"object","required":["id","sep","kind","status","started_at"],"properties":{"id":{"type":"string"},"sep":{"type":"string","enum":["31"]},"kind":{"type":"string","enum":["receive"]},"status":{"type":"string","description":"Possible status value for SEP-31 transactions","enum":["incomplete","completed","refunded","expired","error","pending_stellar","pending_external","pending_sender","pending_receiver","pending_transaction_info_update","pending_customer_info_update"],"title":"StatusSEP31"},"amount_expected":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_in":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_out":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"quote_id":{"type":"string"},"started_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"completed_at":{"type":"string","format":"date-time"},"transfer_received_at":{"type":"string","format":"date-time"},"message":{"type":"string"},"refunds":{"type":"object","properties":{"amount_refunded":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"payments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"id_type":{"type":"string","enum":["stellar","external"]},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"requested_at":{"type":"string","format":"date-time"},"refunded_at":{"type":"string","format":"date-time"}}}}},"title":"Refunds"},"stellar_transactions":{"type":"array","items":{"type":"object","required":["id","created_at","envelope","payments"],"properties":{"id":{"type":"string","description":"The ID of the transaction in the Stellar network."},"memo":{"type":"string","description":"The memo of the transaction in the Stellar network."},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text","hash","id"]},"created_at":{"type":"string","format":"date-time","description":"The time the transaction was registered in the Stellar network."},"envelope":{"type":"string","description":"The transaction envelope, containing all the transaction information."},"payments":{"type":"array","items":{"type":"object","required":["id","payment_type","source_account","destination_account","amount"],"properties":{"id":{"type":"string","description":"The ID of the payment in the Stellar Network."},"payment_type":{"type":"string","description":"The type of payment in the Stellar Network.","enum":["payment","path_payment"],"default":"payment"},"source_account":{"type":"string","description":"The account being debited in the Stellar Network."},"destination_account":{"type":"string","description":"The account being credited in the Stellar Network."},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"}}}}},"title":"StellarTransaction"}},"external_transaction_id":{"type":"string"},"customers":{"type":"object","description":"The Identification info of the sending and receiving customers. If they were created through [SEP-12](https://stellar.org/protocol/sep-12),\nthis object should contain the SEP-12 customer `id`. Otherwise, the `account` address of the customer.\n","properties":{"sender":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` field should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}},"title":"StellarId"},"receiver":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` field should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}},"title":"StellarId"}}},"creator":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` field should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}},"title":"StellarId"}},"title":"TransactionSEP31"}]},"quote":{"type":"object","properties":{"id":{"type":"string"},"sell_amount":{"type":"string"},"sell_asset":{"type":"string"},"buy_amount":{"type":"string"},"buy_asset":{"type":"string"},"expires_at":{"type":"string","format":"date-time"},"price":{"type":"string"},"total_price":{"type":"string"},"creator":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` field should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}},"title":"StellarId"},"transaction_id":{"type":"string"},"created_at":{"type":"string","format":"date-time"}},"title":"Quote"}}}},"required":["id","type","payload","timestamp"],"title":"Event"}}}},"responses":{"200":{"description":"The event is successfully processed and ready to receive next event. The response body is empty."},"400":{"description":"The event is invalid or rejected. The response body contains the error message."}},"method":"post","path":"/event","jsonRequestBodyExample":{"id":"string","type":"transaction_created","timestamp":"2023-09-13T22:33:44.954Z","payload":{"transaction":{"id":"string","sep":"24","kind":"deposit","status":"incomplete","amount_expected":{"amount":"string","asset":"string"},"amount_in":{"amount":"string","asset":"string"},"amount_out":{"amount":"string","asset":"string"},"amount_fee":{"amount":"string","asset":"string"},"started_at":"2023-09-13T22:33:44.954Z","updated_at":"2023-09-13T22:33:44.954Z","completed_at":"2023-09-13T22:33:44.954Z","transfer_received_at":"2023-09-13T22:33:44.954Z","message":"string","refunds":{"amount_refunded":{"amount":"string","asset":"string"},"amount_fee":{"amount":"string","asset":"string"},"payments":[{"id":"string","id_type":"stellar","amount":{"amount":"string","asset":"string"},"fee":{"amount":"string","asset":"string"},"requested_at":"2023-09-13T22:33:44.954Z","refunded_at":"2023-09-13T22:33:44.954Z"}]},"stellar_transactions":[{"id":"string","memo":"string","memo_type":"text","created_at":"2023-09-13T22:33:44.955Z","envelope":"string","payments":[{"id":"string","payment_type":"payment","source_account":"string","destination_account":"string","amount":{"amount":"string","asset":"string"}}]}],"source_account":"string","destination_account":"string","external_transaction_id":"string","memo":"string","memo_type":"text id hash","refund_memo":"string","refund_memo_type":"text id hash"},"quote":{"id":"string","sell_amount":"string","sell_asset":"string","buy_amount":"string","buy_asset":"string","expires_at":"2023-09-13T22:33:44.955Z","price":"string","total_price":"string","creator":{"id":"string","account":"string"},"transaction_id":"string","created_at":"2023-09-13T22:33:44.955Z"}}},"info":{"version":"2.0.0","description":"The Synchronous Callbacks API specification for the Stellar Anchor Platform project.\n\nThe Synchronous Callbacks API defines requests made by the Platform while it is processing a request from a client application. The\nanchor's responses to these requests affect the Platform responses to the client application.\n","title":"Synchronous Callbacks API"},"postman":{"name":"Receive an Event","description":{"content":"Receive a JSON object representing an event.\n","type":"text/plain"},"url":{"path":["event"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: api/anchor-platform/callbacks/synchronous-callbacks-api +custom_edit_url: null +--- + +import { SepBadge } from "@site/src/components/SepBadge"; + + + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## Receive an Event + + + +Receive a JSON object representing an event. + + +
    Request Body
      payload object required
      transaction object
    • oneOf
      amount_expected object required
      amount_in object
      amount_out object
      amount_fee object
      refunds object
      amount_refunded object
      amount_fee object
      payments object[]
    • Array [
      • amount object
      fee object
    • ]
      • stellar_transactions object[]
    • Array [
      • payments object[] required
    • Array [
      • amount object required
    • ]
    • ]
      • amount_expected object
      amount_in object
      amount_out object
      amount_fee object
      refunds object
      amount_refunded object
      amount_fee object
      payments object[]
    • Array [
      • amount object
      fee object
    • ]
      • stellar_transactions object[]
    • Array [
      • payments object[] required
    • Array [
      • amount object required
    • ]
    • ]
      • customers object
      + +The Identification info of the sending and receiving customers. If they were created through [SEP-12](https://stellar.org/protocol/sep-12), +this object should contain the SEP-12 customer `id`. Otherwise, the `account` address of the customer. + + +
      sender object
      + +StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors. + +For a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend. + +For a SEP-31 Sending Anchor, the `account` field should be used. + + +
      receiver object
      + +StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors. + +For a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend. + +For a SEP-31 Sending Anchor, the `account` field should be used. + + +
      creator object
      + +StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors. + +For a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend. + +For a SEP-31 Sending Anchor, the `account` field should be used. + + +
      • quote object
      creator object
      + +StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors. + +For a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend. + +For a SEP-31 Sending Anchor, the `account` field should be used. + + +
    + +The event is successfully processed and ready to receive next event. The response body is empty. + +
    + +The event is invalid or rejected. The response body contains the error message. + +
    diff --git a/api/anchor-platform/callbacks/put-customer.api.mdx b/api/anchor-platform/callbacks/put-customer.api.mdx index 40f48cdde..0da1fcef6 100644 --- a/api/anchor-platform/callbacks/put-customer.api.mdx +++ b/api/anchor-platform/callbacks/put-customer.api.mdx @@ -5,7 +5,7 @@ description: "**The Anchor Platform does not persist any customer KYC data.**" sidebar_label: "Create or Update Customer Info" hide_title: true hide_table_of_contents: true -api: {"tags":["Customers","SEP-12","SEP-24","SEP-31"],"description":"**The Anchor Platform does not persist any customer KYC data.**\n\nThe request and response for this endpoint are identical to the\n[`PUT /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-put)\nrequest and response defined in SEP-12.\n\nClient applications make requests with the following request body, which is forwarded to the anchor. Anchors\nmust validate and persist the data passed, and return the customer's `id`.\n","operationId":"putCustomer","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the customer as returned in the response of a previous PUT request.","type":"string"},"account":{"description":"The Stellar or Muxed Account authenticated with the Platform via SEP-10.","type":"string"},"memo":{"description":"The memo value identifying a customer with a shared account, where the shared account is `account`.","type":"string"},"memo_type":{"description":"The type of memo used to identify a customer with a shared account.","type":"string","enum":["id","hash","text"]},"type":{"description":"The type of action the customer is being KYCd for. \nSee the [Type Specification](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#type-specification) documented in SEP-12 for more info.\nFor SEP-31 you can define your own types in the assets configuration.\nFor SEP-24 pre-defined value `sep24-customer` is used.\n","type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"additional_name":{"type":"string"},"address_country_code":{"type":"string"},"state_or_province":{"type":"string"},"city":{"type":"string"},"postal_code":{"type":"string"},"address":{"type":"string"},"mobile_number":{"type":"string"},"email_address":{"type":"string"},"birth_date":{"type":"string","format":"date"},"birth_place":{"type":"string"},"birth_country_code":{"type":"string"},"bank_account_number":{"type":"string"},"bank_account_type":{"type":"string"},"bank_number":{"type":"string"},"bank_phone_number":{"type":"string"},"bank_branch_number":{"type":"string"},"tax_id":{"type":"string"},"tax_id_name":{"type":"string"},"occupation":{"type":"string"},"employer_name":{"type":"string"},"employer_address":{"type":"string"},"language_code":{"type":"string"},"id_type":{"type":"string"},"id_country_code":{"type":"string"},"id_issue_date":{"type":"string","format":"date"},"id_expiration_date":{"type":"string","format":"date"},"id_number":{"type":"string"},"ip_address":{"type":"string"},"sex":{"type":"string"}},"title":"PutCustomerRequest"}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"}},"title":"PutCustomerResponse"}}}},"400":{"description":"Invalid data.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"id":{"type":"string"}},"required":["error"],"title":"Error"}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"id":{"type":"string"}},"required":["error"],"title":"Error"}}}}},"method":"put","path":"/customer","jsonRequestBodyExample":{"id":"string","account":"string","memo":"string","memo_type":"id","type":"string","first_name":"string","last_name":"string","additional_name":"string","address_country_code":"string","state_or_province":"string","city":"string","postal_code":"string","address":"string","mobile_number":"string","email_address":"string","birth_date":"2023-08-02","birth_place":"string","birth_country_code":"string","bank_account_number":"string","bank_account_type":"string","bank_number":"string","bank_phone_number":"string","bank_branch_number":"string","tax_id":"string","tax_id_name":"string","occupation":"string","employer_name":"string","employer_address":"string","language_code":"string","id_type":"string","id_country_code":"string","id_issue_date":"2023-08-02","id_expiration_date":"2023-08-02","id_number":"string","ip_address":"string","sex":"string"},"info":{"version":"2.0.0","description":"The Synchronous Callbacks API specification for the Stellar Anchor Platform project.\n\nThe Synchronous Callbacks API defines requests made by the Platform while it is processing a request from a client application. The\nanchor's responses to these requests affect the Platform responses to the client application.\n","title":"Synchronous Callbacks API"},"postman":{"name":"Create or Update Customer Info","description":{"content":"**The Anchor Platform does not persist any customer KYC data.**\n\nThe request and response for this endpoint are identical to the\n[`PUT /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-put)\nrequest and response defined in SEP-12.\n\nClient applications make requests with the following request body, which is forwarded to the anchor. Anchors\nmust validate and persist the data passed, and return the customer's `id`.\n","type":"text/plain"},"url":{"path":["customer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"tags":["Customers","SEP-12","SEP-24","SEP-31"],"description":"**The Anchor Platform does not persist any customer KYC data.**\n\nThe request and response for this endpoint are identical to the\n[`PUT /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-put)\nrequest and response defined in SEP-12.\n\nClient applications make requests with the following request body, which is forwarded to the anchor. Anchors\nmust validate and persist the data passed, and return the customer's `id`.\n","operationId":"putCustomer","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the customer as returned in the response of a previous PUT request.","type":"string"},"account":{"description":"The Stellar or Muxed Account authenticated with the Platform via SEP-10.","type":"string"},"memo":{"description":"The memo value identifying a customer with a shared account, where the shared account is `account`.","type":"string"},"memo_type":{"description":"The type of memo used to identify a customer with a shared account.","type":"string","enum":["id","hash","text"]},"type":{"description":"The type of action the customer is being KYCd for. \nSee the [Type Specification](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#type-specification) documented in SEP-12 for more info.\nFor SEP-31 you can define your own types in the assets configuration.\nFor SEP-24 pre-defined value `sep24-customer` is used.\n","type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"additional_name":{"type":"string"},"address_country_code":{"type":"string"},"state_or_province":{"type":"string"},"city":{"type":"string"},"postal_code":{"type":"string"},"address":{"type":"string"},"mobile_number":{"type":"string"},"email_address":{"type":"string"},"birth_date":{"type":"string","format":"date"},"birth_place":{"type":"string"},"birth_country_code":{"type":"string"},"bank_account_number":{"type":"string"},"bank_account_type":{"type":"string"},"bank_number":{"type":"string"},"bank_phone_number":{"type":"string"},"bank_branch_number":{"type":"string"},"tax_id":{"type":"string"},"tax_id_name":{"type":"string"},"occupation":{"type":"string"},"employer_name":{"type":"string"},"employer_address":{"type":"string"},"language_code":{"type":"string"},"id_type":{"type":"string"},"id_country_code":{"type":"string"},"id_issue_date":{"type":"string","format":"date"},"id_expiration_date":{"type":"string","format":"date"},"id_number":{"type":"string"},"ip_address":{"type":"string"},"sex":{"type":"string"}},"title":"PutCustomerRequest"}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"}},"title":"PutCustomerResponse"}}}},"400":{"description":"Invalid data.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"id":{"type":"string"}},"required":["error"],"title":"Error"}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"id":{"type":"string"}},"required":["error"],"title":"Error"}}}}},"method":"put","path":"/customer","jsonRequestBodyExample":{"id":"string","account":"string","memo":"string","memo_type":"id","type":"string","first_name":"string","last_name":"string","additional_name":"string","address_country_code":"string","state_or_province":"string","city":"string","postal_code":"string","address":"string","mobile_number":"string","email_address":"string","birth_date":"2023-09-13","birth_place":"string","birth_country_code":"string","bank_account_number":"string","bank_account_type":"string","bank_number":"string","bank_phone_number":"string","bank_branch_number":"string","tax_id":"string","tax_id_name":"string","occupation":"string","employer_name":"string","employer_address":"string","language_code":"string","id_type":"string","id_country_code":"string","id_issue_date":"2023-09-13","id_expiration_date":"2023-09-13","id_number":"string","ip_address":"string","sex":"string"},"info":{"version":"2.0.0","description":"The Synchronous Callbacks API specification for the Stellar Anchor Platform project.\n\nThe Synchronous Callbacks API defines requests made by the Platform while it is processing a request from a client application. The\nanchor's responses to these requests affect the Platform responses to the client application.\n","title":"Synchronous Callbacks API"},"postman":{"name":"Create or Update Customer Info","description":{"content":"**The Anchor Platform does not persist any customer KYC data.**\n\nThe request and response for this endpoint are identical to the\n[`PUT /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-put)\nrequest and response defined in SEP-12.\n\nClient applications make requests with the following request body, which is forwarded to the anchor. Anchors\nmust validate and persist the data passed, and return the customer's `id`.\n","type":"text/plain"},"url":{"path":["customer"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "put api-method" info_path: api/anchor-platform/callbacks/synchronous-callbacks-api custom_edit_url: null diff --git a/api/anchor-platform/callbacks/sidebar.js b/api/anchor-platform/callbacks/sidebar.js index 2894c64a4..7abac89e6 100644 --- a/api/anchor-platform/callbacks/sidebar.js +++ b/api/anchor-platform/callbacks/sidebar.js @@ -1 +1 @@ -module.exports = [{"type":"doc","id":"anchor-platform/callbacks/synchronous-callbacks-api"},{"type":"category","label":"Unique Address","link":{"type":"generated-index","title":"Unique Address","slug":"/category/anchor-platform/callbacks/unique-address"},"items":[{"type":"doc","id":"anchor-platform/callbacks/gen-address","label":"Generate Unique Address","className":"api-method get"}]},{"type":"category","label":"Fees","link":{"type":"generated-index","title":"Fees","slug":"/category/anchor-platform/callbacks/fees"},"items":[{"type":"doc","id":"anchor-platform/callbacks/get-fee","label":"Retrieve Fees","className":"api-method get"}]},{"type":"category","label":"Rates","link":{"type":"generated-index","title":"Rates","slug":"/category/anchor-platform/callbacks/rates"},"items":[{"type":"doc","id":"anchor-platform/callbacks/get-rates","label":"Retrieve Rates","className":"api-method get"}]},{"type":"category","label":"Customers","link":{"type":"generated-index","title":"Customers","slug":"/category/anchor-platform/callbacks/customers"},"items":[{"type":"doc","id":"anchor-platform/callbacks/get-customer","label":"Retrieve Customer's Info","className":"api-method get"},{"type":"doc","id":"anchor-platform/callbacks/put-customer","label":"Create or Update Customer Info","className":"api-method put"},{"type":"doc","id":"anchor-platform/callbacks/del-customer","label":"Delete Customer Data","className":"api-method delete"}]},{"type":"category","label":"SEP-31","link":{"type":"generated-index","title":"SEP-31","slug":"/category/anchor-platform/callbacks/sep-31"},"items":[{"type":"doc","id":"anchor-platform/callbacks/gen-address","label":"Generate Unique Address","className":"api-method get"},{"type":"doc","id":"anchor-platform/callbacks/get-fee","label":"Retrieve Fees","className":"api-method get"},{"type":"doc","id":"anchor-platform/callbacks/get-rates","label":"Retrieve Rates","className":"api-method get"},{"type":"doc","id":"anchor-platform/callbacks/get-customer","label":"Retrieve Customer's Info","className":"api-method get"},{"type":"doc","id":"anchor-platform/callbacks/put-customer","label":"Create or Update Customer Info","className":"api-method put"},{"type":"doc","id":"anchor-platform/callbacks/del-customer","label":"Delete Customer Data","className":"api-method delete"}]},{"type":"category","label":"SEP-12","link":{"type":"generated-index","title":"SEP-12","slug":"/category/anchor-platform/callbacks/sep-12"},"items":[{"type":"doc","id":"anchor-platform/callbacks/get-customer","label":"Retrieve Customer's Info","className":"api-method get"},{"type":"doc","id":"anchor-platform/callbacks/put-customer","label":"Create or Update Customer Info","className":"api-method put"},{"type":"doc","id":"anchor-platform/callbacks/del-customer","label":"Delete Customer Data","className":"api-method delete"}]},{"type":"category","label":"SEP-24","link":{"type":"generated-index","title":"SEP-24","slug":"/category/anchor-platform/callbacks/sep-24"},"items":[{"type":"doc","id":"anchor-platform/callbacks/put-customer","label":"Create or Update Customer Info","className":"api-method put"}]}]; \ No newline at end of file +module.exports = [{"type":"doc","id":"anchor-platform/callbacks/synchronous-callbacks-api"},{"type":"category","label":"Unique Address","link":{"type":"generated-index","title":"Unique Address","slug":"/category/anchor-platform/callbacks/unique-address"},"items":[{"type":"doc","id":"anchor-platform/callbacks/gen-address","label":"Generate Unique Address","className":"api-method get"}]},{"type":"category","label":"Fees","link":{"type":"generated-index","title":"Fees","slug":"/category/anchor-platform/callbacks/fees"},"items":[{"type":"doc","id":"anchor-platform/callbacks/get-fee","label":"Retrieve Fees","className":"api-method get"}]},{"type":"category","label":"Rates","link":{"type":"generated-index","title":"Rates","slug":"/category/anchor-platform/callbacks/rates"},"items":[{"type":"doc","id":"anchor-platform/callbacks/get-rates","label":"Retrieve Rates","className":"api-method get"}]},{"type":"category","label":"Customers","link":{"type":"generated-index","title":"Customers","slug":"/category/anchor-platform/callbacks/customers"},"items":[{"type":"doc","id":"anchor-platform/callbacks/get-customer","label":"Retrieve Customer's Info","className":"api-method get"},{"type":"doc","id":"anchor-platform/callbacks/put-customer","label":"Create or Update Customer Info","className":"api-method put"},{"type":"doc","id":"anchor-platform/callbacks/del-customer","label":"Delete Customer Data","className":"api-method delete"}]},{"type":"category","label":"SEP-31","link":{"type":"generated-index","title":"SEP-31","slug":"/category/anchor-platform/callbacks/sep-31"},"items":[{"type":"doc","id":"anchor-platform/callbacks/gen-address","label":"Generate Unique Address","className":"api-method get"},{"type":"doc","id":"anchor-platform/callbacks/get-fee","label":"Retrieve Fees","className":"api-method get"},{"type":"doc","id":"anchor-platform/callbacks/get-rates","label":"Retrieve Rates","className":"api-method get"},{"type":"doc","id":"anchor-platform/callbacks/get-customer","label":"Retrieve Customer's Info","className":"api-method get"},{"type":"doc","id":"anchor-platform/callbacks/put-customer","label":"Create or Update Customer Info","className":"api-method put"},{"type":"doc","id":"anchor-platform/callbacks/del-customer","label":"Delete Customer Data","className":"api-method delete"},{"type":"doc","id":"anchor-platform/callbacks/post-event","label":"Receive an Event","className":"api-method post"}]},{"type":"category","label":"SEP-38","link":{"type":"generated-index","title":"SEP-38","slug":"/category/anchor-platform/callbacks/sep-38"},"items":[{"type":"doc","id":"anchor-platform/callbacks/get-rates","label":"Retrieve Rates","className":"api-method get"}]},{"type":"category","label":"SEP-12","link":{"type":"generated-index","title":"SEP-12","slug":"/category/anchor-platform/callbacks/sep-12"},"items":[{"type":"doc","id":"anchor-platform/callbacks/get-customer","label":"Retrieve Customer's Info","className":"api-method get"},{"type":"doc","id":"anchor-platform/callbacks/put-customer","label":"Create or Update Customer Info","className":"api-method put"},{"type":"doc","id":"anchor-platform/callbacks/del-customer","label":"Delete Customer Data","className":"api-method delete"}]},{"type":"category","label":"SEP-24","link":{"type":"generated-index","title":"SEP-24","slug":"/category/anchor-platform/callbacks/sep-24"},"items":[{"type":"doc","id":"anchor-platform/callbacks/put-customer","label":"Create or Update Customer Info","className":"api-method put"},{"type":"doc","id":"anchor-platform/callbacks/post-event","label":"Receive an Event","className":"api-method post"}]},{"type":"category","label":"Events","link":{"type":"generated-index","title":"Events","slug":"/category/anchor-platform/callbacks/events"},"items":[{"type":"doc","id":"anchor-platform/callbacks/post-event","label":"Receive an Event","className":"api-method post"}]}]; \ No newline at end of file diff --git a/api/anchor-platform/resources/get-transaction.api.mdx b/api/anchor-platform/resources/get-transaction.api.mdx index ac0bd6632..6111e1ab8 100644 --- a/api/anchor-platform/resources/get-transaction.api.mdx +++ b/api/anchor-platform/resources/get-transaction.api.mdx @@ -5,7 +5,7 @@ description: "Provides the information necessary for the business to determine t sidebar_label: "Retrieve a Transaction" hide_title: true hide_table_of_contents: true -api: {"tags":["Transactions","SEP-24","SEP-31"],"operationId":"getTransaction","description":"Provides the information necessary for the business to determine the state of the transaction identified by `id`, decide if any action must be taken to continue processing the transaction, and act on the decision.","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Transaction found.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["id","sep","kind","status","amount_expected","destination_account","started_at"],"properties":{"id":{"type":"string"},"sep":{"type":"string","enum":["24"]},"kind":{"type":"string","enum":["deposit","withdrawal"]},"status":{"type":"string","description":"Possible status value for SEP-24 transactions","enum":["incomplete","completed","refunded","expired","error","pending_stellar","pending_external","pending_user_transfer_start","pending_user_transfer_complete","pending_anchor","pending_trust","pending_user","no_market","too_small","too_large"],"title":"StatusSEP24"},"amount_expected":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_in":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_out":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"started_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"completed_at":{"type":"string","format":"date-time"},"transfer_received_at":{"type":"string","format":"date-time"},"message":{"type":"string"},"refunds":{"type":"object","properties":{"amount_refunded":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"payments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"id_type":{"type":"string","enum":["stellar","external"]},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"requested_at":{"type":"string","format":"date-time"},"refunded_at":{"type":"string","format":"date-time"}}}}},"title":"Refunds"},"stellar_transactions":{"type":"array","items":{"type":"object","required":["id","created_at","envelope","payments"],"properties":{"id":{"type":"string","description":"The ID of the transaction in the Stellar network."},"memo":{"type":"string","description":"The memo of the transaction in the Stellar network."},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text","hash","id"]},"created_at":{"type":"string","format":"date-time","description":"The time the transaction was registered in the Stellar network."},"envelope":{"type":"string","description":"The transaction envelope, containing all the transaction information."},"payments":{"type":"array","items":{"type":"object","required":["id","payment_type","source_account","destination_account","amount"],"properties":{"id":{"type":"string","description":"The ID of the payment in the Stellar Network."},"payment_type":{"type":"string","description":"The type of payment in the Stellar Network.","enum":["payment","path_payment"],"default":"payment"},"source_account":{"type":"string","description":"The account being debited in the Stellar Network."},"destination_account":{"type":"string","description":"The account being credited in the Stellar Network."},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"}}}}},"title":"StellarTransaction"}},"source_account":{"type":"string"},"destination_account":{"type":"string"},"external_transaction_id":{"type":"string"},"memo":{"type":"string"},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text id hash"],"title":"MemoType"}},"title":"TransactionSEP24"},{"type":"object","required":["id","sep","kind","status","started_at"],"properties":{"id":{"type":"string"},"sep":{"type":"string","enum":["31"]},"kind":{"type":"string","enum":["receive"]},"status":{"type":"string","description":"Possible status value for SEP-31 transactions","enum":["incomplete","completed","refunded","expired","error","pending_stellar","pending_external","pending_sender","pending_receiver","pending_transaction_info_update","pending_customer_info_update"],"title":"StatusSEP31"},"amount_expected":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_in":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_out":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"quote_id":{"type":"string"},"started_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"completed_at":{"type":"string","format":"date-time"},"transfer_received_at":{"type":"string","format":"date-time"},"message":{"type":"string"},"refunds":{"type":"object","properties":{"amount_refunded":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"payments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"id_type":{"type":"string","enum":["stellar","external"]},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"requested_at":{"type":"string","format":"date-time"},"refunded_at":{"type":"string","format":"date-time"}}}}},"title":"Refunds"},"stellar_transactions":{"type":"array","items":{"type":"object","required":["id","created_at","envelope","payments"],"properties":{"id":{"type":"string","description":"The ID of the transaction in the Stellar network."},"memo":{"type":"string","description":"The memo of the transaction in the Stellar network."},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text","hash","id"]},"created_at":{"type":"string","format":"date-time","description":"The time the transaction was registered in the Stellar network."},"envelope":{"type":"string","description":"The transaction envelope, containing all the transaction information."},"payments":{"type":"array","items":{"type":"object","required":["id","payment_type","source_account","destination_account","amount"],"properties":{"id":{"type":"string","description":"The ID of the payment in the Stellar Network."},"payment_type":{"type":"string","description":"The type of payment in the Stellar Network.","enum":["payment","path_payment"],"default":"payment"},"source_account":{"type":"string","description":"The account being debited in the Stellar Network."},"destination_account":{"type":"string","description":"The account being credited in the Stellar Network."},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"}}}}},"title":"StellarTransaction"}},"external_transaction_id":{"type":"string"},"customers":{"type":"object","description":"The Identification info of the sending and receiving customers. If they were created through [SEP-12](https://stellar.org/protocol/sep-12),\nthis object should contain the SEP-12 customer `id`. Otherwise, the `account` address of the customer.\n","properties":{"sender":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` field should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}},"title":"StellarId"},"receiver":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` field should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}},"title":"StellarId"}}},"creator":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` field should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}},"title":"StellarId"}},"title":"TransactionSEP31"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"id":{"type":"string"}},"required":["error"],"title":"Error"}}}},"404":{"description":"Transaction not found.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"id":{"type":"string"}},"required":["error"],"title":"Error"}}}}},"method":"get","path":"/transactions/{id}","info":{"version":"2.0.0","title":"Platform API"},"postman":{"name":"Retrieve a Transaction","description":{"content":"Provides the information necessary for the business to determine the state of the transaction identified by `id`, decide if any action must be taken to continue processing the transaction, and act on the decision.","type":"text/plain"},"url":{"path":["transactions",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Transactions","SEP-24","SEP-31"],"operationId":"getTransaction","description":"Provides the information necessary for the business to determine the state of the transaction identified by `id`, decide if any action must be taken to continue processing the transaction, and act on the decision.","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Transaction found.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["id","sep","kind","status","amount_expected","destination_account","started_at"],"properties":{"id":{"type":"string"},"sep":{"type":"string","enum":["24"]},"kind":{"type":"string","enum":["deposit","withdrawal"]},"status":{"type":"string","description":"Possible status value for SEP-24 transactions","enum":["incomplete","completed","refunded","expired","error","pending_stellar","pending_external","pending_user_transfer_start","pending_user_transfer_complete","pending_anchor","pending_trust","pending_user","no_market","too_small","too_large"],"title":"StatusSEP24"},"amount_expected":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_in":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_out":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"started_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"completed_at":{"type":"string","format":"date-time"},"transfer_received_at":{"type":"string","format":"date-time"},"message":{"type":"string"},"refunds":{"type":"object","properties":{"amount_refunded":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"payments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"id_type":{"type":"string","enum":["stellar","external"]},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"requested_at":{"type":"string","format":"date-time"},"refunded_at":{"type":"string","format":"date-time"}}}}},"title":"Refunds"},"stellar_transactions":{"type":"array","items":{"type":"object","required":["id","created_at","envelope","payments"],"properties":{"id":{"type":"string","description":"The ID of the transaction in the Stellar network."},"memo":{"type":"string","description":"The memo of the transaction in the Stellar network."},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text","hash","id"]},"created_at":{"type":"string","format":"date-time","description":"The time the transaction was registered in the Stellar network."},"envelope":{"type":"string","description":"The transaction envelope, containing all the transaction information."},"payments":{"type":"array","items":{"type":"object","required":["id","payment_type","source_account","destination_account","amount"],"properties":{"id":{"type":"string","description":"The ID of the payment in the Stellar Network."},"payment_type":{"type":"string","description":"The type of payment in the Stellar Network.","enum":["payment","path_payment"],"default":"payment"},"source_account":{"type":"string","description":"The account being debited in the Stellar Network."},"destination_account":{"type":"string","description":"The account being credited in the Stellar Network."},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"}}}}},"title":"StellarTransaction"}},"source_account":{"type":"string"},"destination_account":{"type":"string"},"external_transaction_id":{"type":"string"},"memo":{"type":"string"},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text id hash"],"title":"MemoType"},"refund_memo":{"description":"if provided, this memo should be used for refund transactions","type":"string"},"refund_memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text id hash"],"title":"MemoType"}},"title":"TransactionSEP24"},{"type":"object","required":["id","sep","kind","status","started_at"],"properties":{"id":{"type":"string"},"sep":{"type":"string","enum":["31"]},"kind":{"type":"string","enum":["receive"]},"status":{"type":"string","description":"Possible status value for SEP-31 transactions","enum":["incomplete","completed","refunded","expired","error","pending_stellar","pending_external","pending_sender","pending_receiver","pending_transaction_info_update","pending_customer_info_update"],"title":"StatusSEP31"},"amount_expected":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_in":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_out":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"quote_id":{"type":"string"},"started_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"completed_at":{"type":"string","format":"date-time"},"transfer_received_at":{"type":"string","format":"date-time"},"message":{"type":"string"},"refunds":{"type":"object","properties":{"amount_refunded":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"payments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"id_type":{"type":"string","enum":["stellar","external"]},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"requested_at":{"type":"string","format":"date-time"},"refunded_at":{"type":"string","format":"date-time"}}}}},"title":"Refunds"},"stellar_transactions":{"type":"array","items":{"type":"object","required":["id","created_at","envelope","payments"],"properties":{"id":{"type":"string","description":"The ID of the transaction in the Stellar network."},"memo":{"type":"string","description":"The memo of the transaction in the Stellar network."},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text","hash","id"]},"created_at":{"type":"string","format":"date-time","description":"The time the transaction was registered in the Stellar network."},"envelope":{"type":"string","description":"The transaction envelope, containing all the transaction information."},"payments":{"type":"array","items":{"type":"object","required":["id","payment_type","source_account","destination_account","amount"],"properties":{"id":{"type":"string","description":"The ID of the payment in the Stellar Network."},"payment_type":{"type":"string","description":"The type of payment in the Stellar Network.","enum":["payment","path_payment"],"default":"payment"},"source_account":{"type":"string","description":"The account being debited in the Stellar Network."},"destination_account":{"type":"string","description":"The account being credited in the Stellar Network."},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"}}}}},"title":"StellarTransaction"}},"external_transaction_id":{"type":"string"},"customers":{"type":"object","description":"The Identification info of the sending and receiving customers. If they were created through [SEP-12](https://stellar.org/protocol/sep-12),\nthis object should contain the SEP-12 customer `id`. Otherwise, the `account` address of the customer.\n","properties":{"sender":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` field should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}},"title":"StellarId"},"receiver":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` field should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}},"title":"StellarId"}}},"creator":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` field should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}},"title":"StellarId"}},"title":"TransactionSEP31"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"id":{"type":"string"}},"required":["error"],"title":"Error"}}}},"404":{"description":"Transaction not found.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"id":{"type":"string"}},"required":["error"],"title":"Error"}}}}},"method":"get","path":"/transactions/{id}","info":{"version":"2.0.0","title":"Platform API"},"postman":{"name":"Retrieve a Transaction","description":{"content":"Provides the information necessary for the business to determine the state of the transaction identified by `id`, decide if any action must be taken to continue processing the transaction, and act on the decision.","type":"text/plain"},"url":{"path":["transactions",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/anchor-platform/resources/platform-api custom_edit_url: null @@ -34,7 +34,7 @@ Provides the information necessary for the business to determine the state of th Transaction found. -
    Schema
    • oneOf
      amount_expected object required
      amount_in object
      amount_out object
      amount_fee object
      refunds object
      amount_refunded object
      amount_fee object
      payments object[]
    • Array [
      • amount object
      fee object
    • ]
      • stellar_transactions object[]
    • Array [
      • payments object[] required
    • Array [
      • amount object required
    • ]
    • ]
      • amount_expected object
      amount_in object
      amount_out object
      amount_fee object
      refunds object
      amount_refunded object
      amount_fee object
      payments object[]
    • Array [
      • amount object
      fee object
    • ]
      • stellar_transactions object[]
    • Array [
      • payments object[] required
    • Array [
      • amount object required
    • ]
    • ]
      • customers object
      +
      Schema
      • oneOf
        amount_expected object required
        amount_in object
        amount_out object
        amount_fee object
        refunds object
        amount_refunded object
        amount_fee object
        payments object[]
      • Array [
        • amount object
        fee object
      • ]
        • stellar_transactions object[]
      • Array [
        • payments object[] required
      • Array [
        • amount object required
      • ]
      • ]
        • amount_expected object
        amount_in object
        amount_out object
        amount_fee object
        refunds object
        amount_refunded object
        amount_fee object
        payments object[]
      • Array [
        • amount object
        fee object
      • ]
        • stellar_transactions object[]
      • Array [
        • payments object[] required
      • Array [
        • amount object required
      • ]
      • ]
        • customers object
        The Identification info of the sending and receiving customers. If they were created through [SEP-12](https://stellar.org/protocol/sep-12), this object should contain the SEP-12 customer `id`. Otherwise, the `account` address of the customer. @@ -67,7 +67,7 @@ For a SEP-12 customer, the `id` field should be sufficient to fully identify the For a SEP-31 Sending Anchor, the `account` field should be used. -
      +
    Bad Request diff --git a/api/anchor-platform/resources/get-transactions.api.mdx b/api/anchor-platform/resources/get-transactions.api.mdx index 1351db259..6bf881bf2 100644 --- a/api/anchor-platform/resources/get-transactions.api.mdx +++ b/api/anchor-platform/resources/get-transactions.api.mdx @@ -5,7 +5,7 @@ description: "Allows to query list of transactions for desired SEP. This api sup sidebar_label: "Retrieve a List of Transactions" hide_title: true hide_table_of_contents: true -api: {"tags":["Transactions","SEP-24","SEP-31"],"operationId":"getTransactions","description":"Allows to query list of transactions for desired SEP. This api supports pagination, and it's possible (and recommended) to make multiple requests to query transactions. The last page is reached when the number of elements returned by the endpoint is smaller than provided `page_size`.","parameters":[{"in":"query","name":"sep","required":true,"schema":{"type":"string","enum":[24,31]},"description":"Lookup transactions belonging to this SEP."},{"in":"query","name":"order_by","schema":{"type":"string","enum":["created_at","transfer_received_at"],"default":"created_at"},"description":"Specifies field that transactions will be ordered by. Note, that secondary sort is transaction id in ascending value.\nI.e. when timestamps for 2 or more transactions is identical, they will be sorted by id."},{"in":"query","name":"order","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"description":"Specifies order. Note, that when the field is null, all transactions with null value will be last, regardless of soring order (NULLS LAST).\nFor example, transfer time may not be specified for some transactions, resulting into `transfer_received_at` being null. If so, transactions with non-null values will be sorted and returned first, followed by all transactions with null timestamps."},{"in":"query","name":"statuses","schema":{"type":"array","items":{"type":"string","description":"Possible status values for all transactions","enum":["incomplete","completed","refunded","expired","error","pending_stellar","pending_external","pending_user_transfer_start","pending_user_transfer_complete","pending_anchor","pending_trust","pending_user","no_market","too_small","too_large","pending_sender","pending_receiver","pending_transaction_info_update","pending_customer_info_update"],"title":"StatusSEPAll"}},"description":"Filters transactions for specified array of statuses. If not provided, filtering is disabled (default behavior)"},{"in":"query","name":"page_size","schema":{"type":"integer","default":20},"description":"Size of a single search page. Must be positive."},{"in":"query","name":"page_number","schema":{"type":"integer","default":0},"description":"Page number to use for continuous search. Page count beings at 0."}],"responses":{"200":{"description":"Transaction found.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","required":["id","sep","kind","status","amount_expected","destination_account","started_at"],"properties":{"id":{"type":"string"},"sep":{"type":"string","enum":["24"]},"kind":{"type":"string","enum":["deposit","withdrawal"]},"status":{"type":"string","description":"Possible status value for SEP-24 transactions","enum":["incomplete","completed","refunded","expired","error","pending_stellar","pending_external","pending_user_transfer_start","pending_user_transfer_complete","pending_anchor","pending_trust","pending_user","no_market","too_small","too_large"],"title":"StatusSEP24"},"amount_expected":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_in":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_out":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"started_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"completed_at":{"type":"string","format":"date-time"},"transfer_received_at":{"type":"string","format":"date-time"},"message":{"type":"string"},"refunds":{"type":"object","properties":{"amount_refunded":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"payments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"id_type":{"type":"string","enum":["stellar","external"]},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"requested_at":{"type":"string","format":"date-time"},"refunded_at":{"type":"string","format":"date-time"}}}}},"title":"Refunds"},"stellar_transactions":{"type":"array","items":{"type":"object","required":["id","created_at","envelope","payments"],"properties":{"id":{"type":"string","description":"The ID of the transaction in the Stellar network."},"memo":{"type":"string","description":"The memo of the transaction in the Stellar network."},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text","hash","id"]},"created_at":{"type":"string","format":"date-time","description":"The time the transaction was registered in the Stellar network."},"envelope":{"type":"string","description":"The transaction envelope, containing all the transaction information."},"payments":{"type":"array","items":{"type":"object","required":["id","payment_type","source_account","destination_account","amount"],"properties":{"id":{"type":"string","description":"The ID of the payment in the Stellar Network."},"payment_type":{"type":"string","description":"The type of payment in the Stellar Network.","enum":["payment","path_payment"],"default":"payment"},"source_account":{"type":"string","description":"The account being debited in the Stellar Network."},"destination_account":{"type":"string","description":"The account being credited in the Stellar Network."},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"}}}}},"title":"StellarTransaction"}},"source_account":{"type":"string"},"destination_account":{"type":"string"},"external_transaction_id":{"type":"string"},"memo":{"type":"string"},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text id hash"],"title":"MemoType"}},"title":"TransactionSEP24"}}},"title":"TransactionListSEP24"},{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","required":["id","sep","kind","status","started_at"],"properties":{"id":{"type":"string"},"sep":{"type":"string","enum":["31"]},"kind":{"type":"string","enum":["receive"]},"status":{"type":"string","description":"Possible status value for SEP-31 transactions","enum":["incomplete","completed","refunded","expired","error","pending_stellar","pending_external","pending_sender","pending_receiver","pending_transaction_info_update","pending_customer_info_update"],"title":"StatusSEP31"},"amount_expected":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_in":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_out":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"quote_id":{"type":"string"},"started_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"completed_at":{"type":"string","format":"date-time"},"transfer_received_at":{"type":"string","format":"date-time"},"message":{"type":"string"},"refunds":{"type":"object","properties":{"amount_refunded":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"payments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"id_type":{"type":"string","enum":["stellar","external"]},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"requested_at":{"type":"string","format":"date-time"},"refunded_at":{"type":"string","format":"date-time"}}}}},"title":"Refunds"},"stellar_transactions":{"type":"array","items":{"type":"object","required":["id","created_at","envelope","payments"],"properties":{"id":{"type":"string","description":"The ID of the transaction in the Stellar network."},"memo":{"type":"string","description":"The memo of the transaction in the Stellar network."},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text","hash","id"]},"created_at":{"type":"string","format":"date-time","description":"The time the transaction was registered in the Stellar network."},"envelope":{"type":"string","description":"The transaction envelope, containing all the transaction information."},"payments":{"type":"array","items":{"type":"object","required":["id","payment_type","source_account","destination_account","amount"],"properties":{"id":{"type":"string","description":"The ID of the payment in the Stellar Network."},"payment_type":{"type":"string","description":"The type of payment in the Stellar Network.","enum":["payment","path_payment"],"default":"payment"},"source_account":{"type":"string","description":"The account being debited in the Stellar Network."},"destination_account":{"type":"string","description":"The account being credited in the Stellar Network."},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"}}}}},"title":"StellarTransaction"}},"external_transaction_id":{"type":"string"},"customers":{"type":"object","description":"The Identification info of the sending and receiving customers. If they were created through [SEP-12](https://stellar.org/protocol/sep-12),\nthis object should contain the SEP-12 customer `id`. Otherwise, the `account` address of the customer.\n","properties":{"sender":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` field should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}},"title":"StellarId"},"receiver":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` field should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}},"title":"StellarId"}}},"creator":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` field should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}},"title":"StellarId"}},"title":"TransactionSEP31"}}},"title":"TransactionListSEP31"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"id":{"type":"string"}},"required":["error"],"title":"Error"}}}},"404":{"description":"Transaction not found.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"id":{"type":"string"}},"required":["error"],"title":"Error"}}}}},"method":"get","path":"/transactions","info":{"version":"2.0.0","title":"Platform API"},"postman":{"name":"Retrieve a List of Transactions","description":{"content":"Allows to query list of transactions for desired SEP. This api supports pagination, and it's possible (and recommended) to make multiple requests to query transactions. The last page is reached when the number of elements returned by the endpoint is smaller than provided `page_size`.","type":"text/plain"},"url":{"path":["transactions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) Lookup transactions belonging to this SEP.","type":"text/plain"},"key":"sep","value":""},{"disabled":false,"description":{"content":"Specifies field that transactions will be ordered by. Note, that secondary sort is transaction id in ascending value.\nI.e. when timestamps for 2 or more transactions is identical, they will be sorted by id.","type":"text/plain"},"key":"order_by","value":""},{"disabled":false,"description":{"content":"Specifies order. Note, that when the field is null, all transactions with null value will be last, regardless of soring order (NULLS LAST).\nFor example, transfer time may not be specified for some transactions, resulting into `transfer_received_at` being null. If so, transactions with non-null values will be sorted and returned first, followed by all transactions with null timestamps.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"Filters transactions for specified array of statuses. If not provided, filtering is disabled (default behavior)","type":"text/plain"},"key":"statuses","value":""},{"disabled":false,"description":{"content":"Size of a single search page. Must be positive.","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"Page number to use for continuous search. Page count beings at 0.","type":"text/plain"},"key":"page_number","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Transactions","SEP-24","SEP-31"],"operationId":"getTransactions","description":"Allows to query list of transactions for desired SEP. This api supports pagination, and it's possible (and recommended) to make multiple requests to query transactions. The last page is reached when the number of elements returned by the endpoint is smaller than provided `page_size`.","parameters":[{"in":"query","name":"sep","required":true,"schema":{"type":"string","enum":[24,31]},"description":"Lookup transactions belonging to this SEP."},{"in":"query","name":"order_by","schema":{"type":"string","enum":["created_at","transfer_received_at"],"default":"created_at"},"description":"Specifies field that transactions will be ordered by. Note, that secondary sort is transaction id in ascending value.\nI.e. when timestamps for 2 or more transactions is identical, they will be sorted by id."},{"in":"query","name":"order","schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"description":"Specifies order. Note, that when the field is null, all transactions with null value will be last, regardless of soring order (NULLS LAST).\nFor example, transfer time may not be specified for some transactions, resulting into `transfer_received_at` being null. If so, transactions with non-null values will be sorted and returned first, followed by all transactions with null timestamps."},{"in":"query","name":"statuses","schema":{"type":"array","items":{"type":"string","description":"Possible status values for all transactions","enum":["incomplete","completed","refunded","expired","error","pending_stellar","pending_external","pending_user_transfer_start","pending_user_transfer_complete","pending_anchor","pending_trust","pending_user","no_market","too_small","too_large","pending_sender","pending_receiver","pending_transaction_info_update","pending_customer_info_update"],"title":"StatusSEPAll"}},"description":"Filters transactions for specified array of statuses. If not provided, filtering is disabled (default behavior)"},{"in":"query","name":"page_size","schema":{"type":"integer","default":20},"description":"Size of a single search page. Must be positive."},{"in":"query","name":"page_number","schema":{"type":"integer","default":0},"description":"Page number to use for continuous search. Page count beings at 0."}],"responses":{"200":{"description":"Transaction found.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","required":["id","sep","kind","status","amount_expected","destination_account","started_at"],"properties":{"id":{"type":"string"},"sep":{"type":"string","enum":["24"]},"kind":{"type":"string","enum":["deposit","withdrawal"]},"status":{"type":"string","description":"Possible status value for SEP-24 transactions","enum":["incomplete","completed","refunded","expired","error","pending_stellar","pending_external","pending_user_transfer_start","pending_user_transfer_complete","pending_anchor","pending_trust","pending_user","no_market","too_small","too_large"],"title":"StatusSEP24"},"amount_expected":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_in":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_out":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"started_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"completed_at":{"type":"string","format":"date-time"},"transfer_received_at":{"type":"string","format":"date-time"},"message":{"type":"string"},"refunds":{"type":"object","properties":{"amount_refunded":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"payments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"id_type":{"type":"string","enum":["stellar","external"]},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"requested_at":{"type":"string","format":"date-time"},"refunded_at":{"type":"string","format":"date-time"}}}}},"title":"Refunds"},"stellar_transactions":{"type":"array","items":{"type":"object","required":["id","created_at","envelope","payments"],"properties":{"id":{"type":"string","description":"The ID of the transaction in the Stellar network."},"memo":{"type":"string","description":"The memo of the transaction in the Stellar network."},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text","hash","id"]},"created_at":{"type":"string","format":"date-time","description":"The time the transaction was registered in the Stellar network."},"envelope":{"type":"string","description":"The transaction envelope, containing all the transaction information."},"payments":{"type":"array","items":{"type":"object","required":["id","payment_type","source_account","destination_account","amount"],"properties":{"id":{"type":"string","description":"The ID of the payment in the Stellar Network."},"payment_type":{"type":"string","description":"The type of payment in the Stellar Network.","enum":["payment","path_payment"],"default":"payment"},"source_account":{"type":"string","description":"The account being debited in the Stellar Network."},"destination_account":{"type":"string","description":"The account being credited in the Stellar Network."},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"}}}}},"title":"StellarTransaction"}},"source_account":{"type":"string"},"destination_account":{"type":"string"},"external_transaction_id":{"type":"string"},"memo":{"type":"string"},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text id hash"],"title":"MemoType"},"refund_memo":{"description":"if provided, this memo should be used for refund transactions","type":"string"},"refund_memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text id hash"],"title":"MemoType"}},"title":"TransactionSEP24"}}},"title":"TransactionListSEP24"},{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","required":["id","sep","kind","status","started_at"],"properties":{"id":{"type":"string"},"sep":{"type":"string","enum":["31"]},"kind":{"type":"string","enum":["receive"]},"status":{"type":"string","description":"Possible status value for SEP-31 transactions","enum":["incomplete","completed","refunded","expired","error","pending_stellar","pending_external","pending_sender","pending_receiver","pending_transaction_info_update","pending_customer_info_update"],"title":"StatusSEP31"},"amount_expected":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_in":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_out":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"quote_id":{"type":"string"},"started_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"completed_at":{"type":"string","format":"date-time"},"transfer_received_at":{"type":"string","format":"date-time"},"message":{"type":"string"},"refunds":{"type":"object","properties":{"amount_refunded":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"amount_fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"payments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"id_type":{"type":"string","enum":["stellar","external"]},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"},"requested_at":{"type":"string","format":"date-time"},"refunded_at":{"type":"string","format":"date-time"}}}}},"title":"Refunds"},"stellar_transactions":{"type":"array","items":{"type":"object","required":["id","created_at","envelope","payments"],"properties":{"id":{"type":"string","description":"The ID of the transaction in the Stellar network."},"memo":{"type":"string","description":"The memo of the transaction in the Stellar network."},"memo_type":{"type":"string","description":"The memo type of the transaction in the Stellar network. Should be present if memo is not null.","enum":["text","hash","id"]},"created_at":{"type":"string","format":"date-time","description":"The time the transaction was registered in the Stellar network."},"envelope":{"type":"string","description":"The transaction envelope, containing all the transaction information."},"payments":{"type":"array","items":{"type":"object","required":["id","payment_type","source_account","destination_account","amount"],"properties":{"id":{"type":"string","description":"The ID of the payment in the Stellar Network."},"payment_type":{"type":"string","description":"The type of payment in the Stellar Network.","enum":["payment","path_payment"],"default":"payment"},"source_account":{"type":"string","description":"The account being debited in the Stellar Network."},"destination_account":{"type":"string","description":"The account being credited in the Stellar Network."},"amount":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"}}}}},"title":"StellarTransaction"}},"external_transaction_id":{"type":"string"},"customers":{"type":"object","description":"The Identification info of the sending and receiving customers. If they were created through [SEP-12](https://stellar.org/protocol/sep-12),\nthis object should contain the SEP-12 customer `id`. Otherwise, the `account` address of the customer.\n","properties":{"sender":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` field should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}},"title":"StellarId"},"receiver":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` field should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}},"title":"StellarId"}}},"creator":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` field should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}},"title":"StellarId"}},"title":"TransactionSEP31"}}},"title":"TransactionListSEP31"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"id":{"type":"string"}},"required":["error"],"title":"Error"}}}},"404":{"description":"Transaction not found.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"id":{"type":"string"}},"required":["error"],"title":"Error"}}}}},"method":"get","path":"/transactions","info":{"version":"2.0.0","title":"Platform API"},"postman":{"name":"Retrieve a List of Transactions","description":{"content":"Allows to query list of transactions for desired SEP. This api supports pagination, and it's possible (and recommended) to make multiple requests to query transactions. The last page is reached when the number of elements returned by the endpoint is smaller than provided `page_size`.","type":"text/plain"},"url":{"path":["transactions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) Lookup transactions belonging to this SEP.","type":"text/plain"},"key":"sep","value":""},{"disabled":false,"description":{"content":"Specifies field that transactions will be ordered by. Note, that secondary sort is transaction id in ascending value.\nI.e. when timestamps for 2 or more transactions is identical, they will be sorted by id.","type":"text/plain"},"key":"order_by","value":""},{"disabled":false,"description":{"content":"Specifies order. Note, that when the field is null, all transactions with null value will be last, regardless of soring order (NULLS LAST).\nFor example, transfer time may not be specified for some transactions, resulting into `transfer_received_at` being null. If so, transactions with non-null values will be sorted and returned first, followed by all transactions with null timestamps.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"Filters transactions for specified array of statuses. If not provided, filtering is disabled (default behavior)","type":"text/plain"},"key":"statuses","value":""},{"disabled":false,"description":{"content":"Size of a single search page. Must be positive.","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"Page number to use for continuous search. Page count beings at 0.","type":"text/plain"},"key":"page_number","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/anchor-platform/resources/platform-api custom_edit_url: null @@ -34,7 +34,7 @@ Allows to query list of transactions for desired SEP. This api supports paginati Transaction found. -
    Schema
    • oneOf
      records object[]
    • Array [
      • amount_expected object required
      amount_in object
      amount_out object
      amount_fee object
      refunds object
      amount_refunded object
      amount_fee object
      payments object[]
    • Array [
      • amount object
      fee object
    • ]
      • stellar_transactions object[]
    • Array [
      • payments object[] required
    • Array [
      • amount object required
    • ]
    • ]
    • ]
      • records object[]
    • Array [
      • amount_expected object
      amount_in object
      amount_out object
      amount_fee object
      refunds object
      amount_refunded object
      amount_fee object
      payments object[]
    • Array [
      • amount object
      fee object
    • ]
      • stellar_transactions object[]
    • Array [
      • payments object[] required
    • Array [
      • amount object required
    • ]
    • ]
      • customers object
      +
      Schema
      • oneOf
        records object[]
      • Array [
        • amount_expected object required
        amount_in object
        amount_out object
        amount_fee object
        refunds object
        amount_refunded object
        amount_fee object
        payments object[]
      • Array [
        • amount object
        fee object
      • ]
        • stellar_transactions object[]
      • Array [
        • payments object[] required
      • Array [
        • amount object required
      • ]
      • ]
      • ]
        • records object[]
      • Array [
        • amount_expected object
        amount_in object
        amount_out object
        amount_fee object
        refunds object
        amount_refunded object
        amount_fee object
        payments object[]
      • Array [
        • amount object
        fee object
      • ]
        • stellar_transactions object[]
      • Array [
        • payments object[] required
      • Array [
        • amount object required
      • ]
      • ]
        • customers object
        The Identification info of the sending and receiving customers. If they were created through [SEP-12](https://stellar.org/protocol/sep-12), this object should contain the SEP-12 customer `id`. Otherwise, the `account` address of the customer. @@ -67,7 +67,7 @@ For a SEP-12 customer, the `id` field should be sufficient to fully identify the For a SEP-31 Sending Anchor, the `account` field should be used. -
      • ]
      +
    • ]
    Bad Request diff --git a/api/horizon/resources/cb-retrieve-related-operations.api.mdx b/api/horizon/resources/cb-retrieve-related-operations.api.mdx index b8ee27872..4e67e842e 100644 --- a/api/horizon/resources/cb-retrieve-related-operations.api.mdx +++ b/api/horizon/resources/cb-retrieve-related-operations.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint represents successful operations referencing a given sidebar_label: "Retrieve Related Operations" hide_title: true hide_table_of_contents: true -api: {"tags":["Claimable Balances"],"description":"This endpoint represents successful operations referencing a given claimable balance and can be used in streaming mode. Streaming mode allows you to listen for new operations referencing this claimable balance as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known operation unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream operations created since your request time.","operationId":"CBRetrieveRelatedOperations","parameters":[{"name":"claimable_balance_id","in":"path","required":true,"description":"A unique identifier for this claimable balance.","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}},{"name":"include_failed","in":"query","required":false,"description":"Set to true to include failed operations in results. Options include true and false.","schema":{"type":"boolean","enum":[true,false]}},{"name":"join","in":"query","required":false,"description":"Set to transactions to include the transactions which created each of the operations in the response."}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"oneOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"create_account"},"type_i":{"type":"number","example":0},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"starting_balance":{"type":"string"},"funder":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","starting_balance","funder","account"],"title":"CreateAccount"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"payment"},"type_i":{"type":"string"},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string"},"asset_code":{"enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","asset_type","from","to","amount"]}}}}},"title":"Payment"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"path_payment_strict_receive"},"type_i":{"type":"number","example":2},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"},"path":{"type":"array","items":{"type":"object","properties":{"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}}}},"source_amount":{"type":"string"},"destination_min":{"type":"string"},"source_asset_type":{"type":"string"},"source_asset_code":{"type":"string"},"source_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","from","to","amount","path","source_amount","destination_min"],"title":"PathPaymentStrictReceive"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"path_payment_strict_send"},"type_i":{"type":"number","example":13},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"},"path":{"type":"array","items":{"type":"object","properties":{"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}}}},"source_amount":{"type":"string"},"source_max":{"type":"string"},"source_asset_type":{"type":"string"},"source_asset_code":{"type":"string"},"source_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","from","to","amount","path","source_amount","source_asset_type"],"title":"PathPaymentStrictSend"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"account_merge"},"type_i":{"type":"number","example":8},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"into":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","account","into"],"title":"AccountMerge"}]}]},"examples":{"CBRetrieveRelatedOperations":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/claimable_balances/00000000178826fbfe339e1f5c53417c6fedfe2c05e8bec14303143ec46b38981b09c3f9/operations?cursor=&limit=3&order=asc"},"next":{"href":"https://horizon.stellar.org/claimable_balances/00000000178826fbfe339e1f5c53417c6fedfe2c05e8bec14303143ec46b38981b09c3f9/operations?cursor=140648659841806337&limit=3&order=asc"},"prev":{"href":"https://horizon.stellar.org/claimable_balances/00000000178826fbfe339e1f5c53417c6fedfe2c05e8bec14303143ec46b38981b09c3f9/operations?cursor=140648659841806337&limit=3&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/operations/140648659841806337"},"transaction":{"href":"https://horizon.stellar.org/transactions/fc5a98fc3869df408ebd4ac1c2e3fefec8b0a858e82ff1d14e362676708b91e8"},"effects":{"href":"https://horizon.stellar.org/operations/140648659841806337/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=140648659841806337"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=140648659841806337"}},"id":"140648659841806337","paging_token":"140648659841806337","transaction_successful":true,"source_account":"GDCJIHD3623OCYNH65UUQC3NLG2D6YCNCDPZULRLCLOA76TBQRL6A3TF","type":"create_claimable_balance","type_i":14,"created_at":"2020-11-23T16:02:38Z","transaction_hash":"fc5a98fc3869df408ebd4ac1c2e3fefec8b0a858e82ff1d14e362676708b91e8","sponsor":"GDCJIHD3623OCYNH65UUQC3NLG2D6YCNCDPZULRLCLOA76TBQRL6A3TF","asset":"BODHI:GDCJIHD3623OCYNH65UUQC3NLG2D6YCNCDPZULRLCLOA76TBQRL6A3TF","amount":"0.1000000","claimants":[{"destination":"GBEUDKANIFPTFHPWJ5T3R6RIO36RQBFGHYPAQ6STH7KMNDHAT36LHOLD","predicate":{"unconditional":true}}]}]}}}}}}}},"method":"get","path":"/claimable_balances/{claimable_balance_id}/operations","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve Related Operations","description":{"content":"This endpoint represents successful operations referencing a given claimable balance and can be used in streaming mode. Streaming mode allows you to listen for new operations referencing this claimable balance as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known operation unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream operations created since your request time.","type":"text/plain"},"url":{"path":["claimable_balances",":claimable_balance_id","operations"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Set to true to include failed operations in results. Options include true and false.","type":"text/plain"},"key":"include_failed","value":""},{"description":{"content":"Set to transactions to include the transactions which created each of the operations in the response.","type":"text/plain"},"key":"join","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) A unique identifier for this claimable balance.","type":"text/plain"},"type":"any","value":"","key":"claimable_balance_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Claimable Balances"],"description":"This endpoint represents successful operations referencing a given claimable balance and can be used in streaming mode. Streaming mode allows you to listen for new operations referencing this claimable balance as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known operation unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream operations created since your request time.","operationId":"CBRetrieveRelatedOperations","parameters":[{"name":"claimable_balance_id","in":"path","required":true,"description":"A unique identifier for this claimable balance.","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}},{"name":"include_failed","in":"query","required":false,"description":"Set to true to include failed operations in results. Options include true and false.","schema":{"type":"boolean","enum":[true,false]}},{"name":"join","in":"query","required":false,"description":"Set to transactions to include the transactions which created each of the operations in the response."}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"oneOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"create_account"},"type_i":{"type":"number","example":0},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"starting_balance":{"type":"string"},"funder":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","starting_balance","funder","account"],"title":"CreateAccount"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"payment"},"type_i":{"type":"string"},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string"},"asset_code":{"enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","asset_type","from","to","amount"]}}}}},"title":"Payment"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"path_payment_strict_receive"},"type_i":{"type":"number","example":2},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"},"path":{"type":"array","items":{"type":"object","properties":{"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}}}},"source_amount":{"type":"string"},"destination_min":{"type":"string"},"source_asset_type":{"type":"string"},"source_asset_code":{"type":"string"},"source_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","from","to","amount","path","source_amount","destination_min"],"title":"PathPaymentStrictReceive"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"path_payment_strict_send"},"type_i":{"type":"number","example":13},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"},"path":{"type":"array","items":{"type":"object","properties":{"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}}}},"source_amount":{"type":"string"},"source_max":{"type":"string"},"source_asset_type":{"type":"string"},"source_asset_code":{"type":"string"},"source_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","from","to","amount","path","source_amount","source_asset_type"],"title":"PathPaymentStrictSend"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"account_merge"},"type_i":{"type":"number","example":8},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"into":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","account","into"],"title":"AccountMerge"}]}]},"examples":{"CBRetrieveRelatedOperations":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/claimable_balances/00000000178826fbfe339e1f5c53417c6fedfe2c05e8bec14303143ec46b38981b09c3f9/operations?cursor=&limit=3&order=asc"},"next":{"href":"https://horizon.stellar.org/claimable_balances/00000000178826fbfe339e1f5c53417c6fedfe2c05e8bec14303143ec46b38981b09c3f9/operations?cursor=140648659841806337&limit=3&order=asc"},"prev":{"href":"https://horizon.stellar.org/claimable_balances/00000000178826fbfe339e1f5c53417c6fedfe2c05e8bec14303143ec46b38981b09c3f9/operations?cursor=140648659841806337&limit=3&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/operations/140648659841806337"},"transaction":{"href":"https://horizon.stellar.org/transactions/fc5a98fc3869df408ebd4ac1c2e3fefec8b0a858e82ff1d14e362676708b91e8"},"effects":{"href":"https://horizon.stellar.org/operations/140648659841806337/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=140648659841806337"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=140648659841806337"}},"id":"140648659841806337","paging_token":"140648659841806337","transaction_successful":true,"source_account":"GDCJIHD3623OCYNH65UUQC3NLG2D6YCNCDPZULRLCLOA76TBQRL6A3TF","type":"create_claimable_balance","type_i":14,"created_at":"2020-11-23T16:02:38Z","transaction_hash":"fc5a98fc3869df408ebd4ac1c2e3fefec8b0a858e82ff1d14e362676708b91e8","sponsor":"GDCJIHD3623OCYNH65UUQC3NLG2D6YCNCDPZULRLCLOA76TBQRL6A3TF","asset":"BODHI:GDCJIHD3623OCYNH65UUQC3NLG2D6YCNCDPZULRLCLOA76TBQRL6A3TF","amount":"0.1000000","claimants":[{"destination":"GBEUDKANIFPTFHPWJ5T3R6RIO36RQBFGHYPAQ6STH7KMNDHAT36LHOLD","predicate":{"unconditional":true}}]}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/claimable_balances/{claimable_balance_id}/operations","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve Related Operations","description":{"content":"This endpoint represents successful operations referencing a given claimable balance and can be used in streaming mode. Streaming mode allows you to listen for new operations referencing this claimable balance as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known operation unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream operations created since your request time.","type":"text/plain"},"url":{"path":["claimable_balances",":claimable_balance_id","operations"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Set to true to include failed operations in results. Options include true and false.","type":"text/plain"},"key":"include_failed","value":""},{"description":{"content":"Set to transactions to include the transactions which created each of the operations in the response.","type":"text/plain"},"key":"join","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) A unique identifier for this claimable balance.","type":"text/plain"},"type":"any","value":"","key":"claimable_balance_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/cb-retrieve-related-transactions.api.mdx b/api/horizon/resources/cb-retrieve-related-transactions.api.mdx index 905aa85ea..1ebac2bd9 100644 --- a/api/horizon/resources/cb-retrieve-related-transactions.api.mdx +++ b/api/horizon/resources/cb-retrieve-related-transactions.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint represents successful transactions referencing a giv sidebar_label: "Retrieve Related Transactions" hide_title: true hide_table_of_contents: true -api: {"tags":["Claimable Balances"],"description":"This endpoint represents successful transactions referencing a given claimable balance and can be used in streaming mode. Streaming mode allows you to listen for new transactions referencing this claimable balance as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known transaction unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream transactions created since your request time.","operationId":"CBRetrieveRelatedTransactions","parameters":[{"name":"claimable_balance_id","in":"path","required":true,"description":"A unique identifier for this claimable balance.","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}},{"name":"include_failed","in":"query","required":false,"description":"Set to true to include failed operations in results. Options include true and false.","schema":{"type":"boolean","enum":[true,false]}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"memo":{"type":"string"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"account":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"ledger":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"operations":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","account","ledger","operations","effects","precedes","succeeds","transaction"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"successful":{"type":"boolean"},"hash":{"type":"string"},"ledger":{"type":"integer","format":"int32"},"created_at":{"type":"string"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"account_muxed":{"type":"string"},"account_muxed_id":{"type":"string"},"source_account_sequence":{"type":"string"},"fee_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"fee_account_muxed":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"fee_account_muxed_id":{"type":"string"},"fee_charged":{"type":"string"},"max_fee":{"type":"string"},"operation_count":{"type":"integer","format":"int32"},"envelope_xdr":{"type":"string"},"result_xdr":{"type":"string"},"result_meta_xdr":{"type":"string"},"fee_meta_xdr":{"type":"string"},"memo_type":{"type":"string"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"},"valid_after":{"type":"string"},"valid_before":{"type":"string"},"preconditions":{"type":"object","properties":{"timebounds":{"type":"object","properties":{"min_time":{"type":"string"},"max_time":{"type":"string"}},"title":"TransactionPreconditionsTimebounds"},"ledgerbounds":{"type":"object","properties":{"min_ledger":{"type":"string"},"max_ledger":{"type":"string"}},"title":"TransactionPreconditionsLedgerbounds"},"min_account_sequence":{"type":"string"},"min_account_sequence_age":{"type":"string"},"min_account_sequence_ledger_gap":{"type":"integer","format":"uint32"},"extra_signers":{"type":"array","items":{"type":"string"}}},"title":"TransactionPreconditions"},"fee_bump_transaction":{"type":"object","properties":{"hash":{"type":"string","title":"hash"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"}},"title":"FeeBumpTransaction"},"inner_transaction":{"type":"object","properties":{"hash":{"type":"string","title":"hash"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"},"max_fee":{"type":"string"}},"title":"InnerTransaction"}},"required":["id","paging_token","successful","hash","ledger","created_at","source_account","source_account_sequence","fee_account","fee_charged","max_fee","operation_count","envelope_xdr","result_xdr","result_meta_xdr","memo_type","signatures"]}}}}},"title":"Transaction"}]},"examples":{"CBRetrieveRelatedTransactions":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/claimable_balances/00000000178826fbfe339e1f5c53417c6fedfe2c05e8bec14303143ec46b38981b09c3f9/transactions?cursor=&limit=2&order=asc"},"next":{"href":"https://horizon.stellar.org/claimable_balances/00000000178826fbfe339e1f5c53417c6fedfe2c05e8bec14303143ec46b38981b09c3f9/transactions?cursor=140648659841806336&limit=2&order=asc"},"prev":{"href":"https://horizon.stellar.org/claimable_balances/00000000178826fbfe339e1f5c53417c6fedfe2c05e8bec14303143ec46b38981b09c3f9/transactions?cursor=140648659841806336&limit=2&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/transactions/fc5a98fc3869df408ebd4ac1c2e3fefec8b0a858e82ff1d14e362676708b91e8"},"account":{"href":"https://horizon.stellar.org/accounts/GDCJIHD3623OCYNH65UUQC3NLG2D6YCNCDPZULRLCLOA76TBQRL6A3TF"},"ledger":{"href":"https://horizon.stellar.org/ledgers/32747318"},"operations":{"href":"https://horizon.stellar.org/transactions/fc5a98fc3869df408ebd4ac1c2e3fefec8b0a858e82ff1d14e362676708b91e8/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/fc5a98fc3869df408ebd4ac1c2e3fefec8b0a858e82ff1d14e362676708b91e8/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=140648659841806336"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=140648659841806336"},"transaction":{"href":"https://horizon.stellar.org/transactions/fc5a98fc3869df408ebd4ac1c2e3fefec8b0a858e82ff1d14e362676708b91e8"}},"id":"fc5a98fc3869df408ebd4ac1c2e3fefec8b0a858e82ff1d14e362676708b91e8","paging_token":"140648659841806336","successful":true,"hash":"fc5a98fc3869df408ebd4ac1c2e3fefec8b0a858e82ff1d14e362676708b91e8","ledger":32747318,"created_at":"2020-11-23T16:02:38Z","source_account":"GDCJIHD3623OCYNH65UUQC3NLG2D6YCNCDPZULRLCLOA76TBQRL6A3TF","source_account_sequence":"140646847365513218","fee_account":"GDCJIHD3623OCYNH65UUQC3NLG2D6YCNCDPZULRLCLOA76TBQRL6A3TF","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAAgAAAADElBx79rbhYaf3aUgLbVm0P2BNEN+aLisS3A/6YYRX4AAAAGQB862QAAAAAgAAAAEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAADgAAAAJCT0RISQAAAAAAAAAAAAAAxJQce/a24WGn92lIC21ZtD9gTRDfmi4rEtwP+mGEV+AAAAAAAA9CQAAAAAEAAAAAAAAAAElBqA1BXzKd9k9nuPoodv0YBKY+Hgh6Uz/UxozgnvyzAAAAAAAAAAAAAAABYYRX4AAAAEDf41ykW+eq8IVpJNOc4iDaht5Beil8NpQB8WMHkOxW3rocUBF3EHKqUXDIsD9CzzY7Xr1PbzVk5FZ4iBKNF4MM","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAAOAAAAAAAAAAAXiCb7/jOeH1xTQXxv7f4sBei+wUMDFD7EaziYGwnD+QAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAfOvNgAAAAAAAAAAxJQce/a24WGn92lIC21ZtD9gTRDfmi4rEtwP+mGEV+AAAAAAAcnCVAHzrZAAAAABAAAAAAAAAAAAAAAAAAAAD2dpdmluZ2JvZGhpLm9yZwABAAAAAAAAAAAAAAAAAAAAAAAAAQHzrzYAAAAAAAAAAMSUHHv2tuFhp/dpSAttWbQ/YE0Q35ouKxLcD/phhFfgAAAAAAHJwlQB862QAAAAAgAAAAAAAAAAAAAAAAAAAA9naXZpbmdib2RoaS5vcmcAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAAADAAAAAwHzrzYAAAAAAAAAAMSUHHv2tuFhp/dpSAttWbQ/YE0Q35ouKxLcD/phhFfgAAAAAAHJwlQB862QAAAAAgAAAAAAAAAAAAAAAAAAAA9naXZpbmdib2RoaS5vcmcAAQAAAAAAAAAAAAAAAAAAAAAAAAEB8682AAAAAAAAAADElBx79rbhYaf3aUgLbVm0P2BNEN+aLisS3A/6YYRX4AAAAAABycJUAfOtkAAAAAIAAAAAAAAAAAAAAAAAAAAPZ2l2aW5nYm9kaGkub3JnAAEAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAACAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAfOvNgAAAAQAAAAAF4gm+/4znh9cU0F8b+3+LAXovsFDAxQ+xGs4mBsJw/kAAAABAAAAAAAAAABJQagNQV8ynfZPZ7j6KHb9GASmPh4IelM/1MaM4J78swAAAAAAAAACQk9ESEkAAAAAAAAAAAAAAMSUHHv2tuFhp/dpSAttWbQ/YE0Q35ouKxLcD/phhFfgAAAAAAAPQkAAAAAAAAAAAQAAAAEAAAAAxJQce/a24WGn92lIC21ZtD9gTRDfmi4rEtwP+mGEV+AAAAAAAAAAAA==","fee_meta_xdr":"AAAAAgAAAAMB866UAAAAAAAAAADElBx79rbhYaf3aUgLbVm0P2BNEN+aLisS3A/6YYRX4AAAAAABycK4AfOtkAAAAAEAAAAAAAAAAAAAAAAAAAAPZ2l2aW5nYm9kaGkub3JnAAEAAAAAAAAAAAAAAAAAAAAAAAABAfOvNgAAAAAAAAAAxJQce/a24WGn92lIC21ZtD9gTRDfmi4rEtwP+mGEV+AAAAAAAcnCVAHzrZAAAAABAAAAAAAAAAAAAAAAAAAAD2dpdmluZ2JvZGhpLm9yZwABAAAAAAAAAAAAAAAAAAAA","memo_type":"none","signatures":["3+NcpFvnqvCFaSTTnOIg2obeQXopfDaUAfFjB5DsVt66HFARdxByqlFwyLA/Qs82O169T281ZORWeIgSjReDDA=="],"valid_after":"1970-01-01T00:00:00Z","preconditions":{"timebounds":{"min_time":"0"}}}]}}}}}}}},"method":"get","path":"/claimable_balances/{claimable_balance_id}/transactions","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve Related Transactions","description":{"content":"This endpoint represents successful transactions referencing a given claimable balance and can be used in streaming mode. Streaming mode allows you to listen for new transactions referencing this claimable balance as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known transaction unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream transactions created since your request time.","type":"text/plain"},"url":{"path":["claimable_balances",":claimable_balance_id","transactions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Set to true to include failed operations in results. Options include true and false.","type":"text/plain"},"key":"include_failed","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) A unique identifier for this claimable balance.","type":"text/plain"},"type":"any","value":"","key":"claimable_balance_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Claimable Balances"],"description":"This endpoint represents successful transactions referencing a given claimable balance and can be used in streaming mode. Streaming mode allows you to listen for new transactions referencing this claimable balance as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known transaction unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream transactions created since your request time.","operationId":"CBRetrieveRelatedTransactions","parameters":[{"name":"claimable_balance_id","in":"path","required":true,"description":"A unique identifier for this claimable balance.","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}},{"name":"include_failed","in":"query","required":false,"description":"Set to true to include failed operations in results. Options include true and false.","schema":{"type":"boolean","enum":[true,false]}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"memo":{"type":"string"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"account":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"ledger":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"operations":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","account","ledger","operations","effects","precedes","succeeds","transaction"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"successful":{"type":"boolean"},"hash":{"type":"string"},"ledger":{"type":"integer","format":"int32"},"created_at":{"type":"string"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"account_muxed":{"type":"string"},"account_muxed_id":{"type":"string"},"source_account_sequence":{"type":"string"},"fee_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"fee_account_muxed":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"fee_account_muxed_id":{"type":"string"},"fee_charged":{"type":"string"},"max_fee":{"type":"string"},"operation_count":{"type":"integer","format":"int32"},"envelope_xdr":{"type":"string"},"result_xdr":{"type":"string"},"result_meta_xdr":{"type":"string"},"fee_meta_xdr":{"type":"string"},"memo_type":{"type":"string"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"},"valid_after":{"type":"string"},"valid_before":{"type":"string"},"preconditions":{"type":"object","properties":{"timebounds":{"type":"object","properties":{"min_time":{"type":"string"},"max_time":{"type":"string"}},"title":"TransactionPreconditionsTimebounds"},"ledgerbounds":{"type":"object","properties":{"min_ledger":{"type":"string"},"max_ledger":{"type":"string"}},"title":"TransactionPreconditionsLedgerbounds"},"min_account_sequence":{"type":"string"},"min_account_sequence_age":{"type":"string"},"min_account_sequence_ledger_gap":{"type":"integer","format":"uint32"},"extra_signers":{"type":"array","items":{"type":"string"}}},"title":"TransactionPreconditions"},"fee_bump_transaction":{"type":"object","properties":{"hash":{"type":"string","title":"hash"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"}},"title":"FeeBumpTransaction"},"inner_transaction":{"type":"object","properties":{"hash":{"type":"string","title":"hash"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"},"max_fee":{"type":"string"}},"title":"InnerTransaction"}},"required":["id","paging_token","successful","hash","ledger","created_at","source_account","source_account_sequence","fee_account","fee_charged","max_fee","operation_count","envelope_xdr","result_xdr","result_meta_xdr","memo_type","signatures"]}}}}},"title":"Transaction"}]},"examples":{"CBRetrieveRelatedTransactions":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/claimable_balances/00000000178826fbfe339e1f5c53417c6fedfe2c05e8bec14303143ec46b38981b09c3f9/transactions?cursor=&limit=2&order=asc"},"next":{"href":"https://horizon.stellar.org/claimable_balances/00000000178826fbfe339e1f5c53417c6fedfe2c05e8bec14303143ec46b38981b09c3f9/transactions?cursor=140648659841806336&limit=2&order=asc"},"prev":{"href":"https://horizon.stellar.org/claimable_balances/00000000178826fbfe339e1f5c53417c6fedfe2c05e8bec14303143ec46b38981b09c3f9/transactions?cursor=140648659841806336&limit=2&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/transactions/fc5a98fc3869df408ebd4ac1c2e3fefec8b0a858e82ff1d14e362676708b91e8"},"account":{"href":"https://horizon.stellar.org/accounts/GDCJIHD3623OCYNH65UUQC3NLG2D6YCNCDPZULRLCLOA76TBQRL6A3TF"},"ledger":{"href":"https://horizon.stellar.org/ledgers/32747318"},"operations":{"href":"https://horizon.stellar.org/transactions/fc5a98fc3869df408ebd4ac1c2e3fefec8b0a858e82ff1d14e362676708b91e8/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/fc5a98fc3869df408ebd4ac1c2e3fefec8b0a858e82ff1d14e362676708b91e8/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=140648659841806336"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=140648659841806336"},"transaction":{"href":"https://horizon.stellar.org/transactions/fc5a98fc3869df408ebd4ac1c2e3fefec8b0a858e82ff1d14e362676708b91e8"}},"id":"fc5a98fc3869df408ebd4ac1c2e3fefec8b0a858e82ff1d14e362676708b91e8","paging_token":"140648659841806336","successful":true,"hash":"fc5a98fc3869df408ebd4ac1c2e3fefec8b0a858e82ff1d14e362676708b91e8","ledger":32747318,"created_at":"2020-11-23T16:02:38Z","source_account":"GDCJIHD3623OCYNH65UUQC3NLG2D6YCNCDPZULRLCLOA76TBQRL6A3TF","source_account_sequence":"140646847365513218","fee_account":"GDCJIHD3623OCYNH65UUQC3NLG2D6YCNCDPZULRLCLOA76TBQRL6A3TF","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAAgAAAADElBx79rbhYaf3aUgLbVm0P2BNEN+aLisS3A/6YYRX4AAAAGQB862QAAAAAgAAAAEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAADgAAAAJCT0RISQAAAAAAAAAAAAAAxJQce/a24WGn92lIC21ZtD9gTRDfmi4rEtwP+mGEV+AAAAAAAA9CQAAAAAEAAAAAAAAAAElBqA1BXzKd9k9nuPoodv0YBKY+Hgh6Uz/UxozgnvyzAAAAAAAAAAAAAAABYYRX4AAAAEDf41ykW+eq8IVpJNOc4iDaht5Beil8NpQB8WMHkOxW3rocUBF3EHKqUXDIsD9CzzY7Xr1PbzVk5FZ4iBKNF4MM","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAAOAAAAAAAAAAAXiCb7/jOeH1xTQXxv7f4sBei+wUMDFD7EaziYGwnD+QAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAfOvNgAAAAAAAAAAxJQce/a24WGn92lIC21ZtD9gTRDfmi4rEtwP+mGEV+AAAAAAAcnCVAHzrZAAAAABAAAAAAAAAAAAAAAAAAAAD2dpdmluZ2JvZGhpLm9yZwABAAAAAAAAAAAAAAAAAAAAAAAAAQHzrzYAAAAAAAAAAMSUHHv2tuFhp/dpSAttWbQ/YE0Q35ouKxLcD/phhFfgAAAAAAHJwlQB862QAAAAAgAAAAAAAAAAAAAAAAAAAA9naXZpbmdib2RoaS5vcmcAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAAADAAAAAwHzrzYAAAAAAAAAAMSUHHv2tuFhp/dpSAttWbQ/YE0Q35ouKxLcD/phhFfgAAAAAAHJwlQB862QAAAAAgAAAAAAAAAAAAAAAAAAAA9naXZpbmdib2RoaS5vcmcAAQAAAAAAAAAAAAAAAAAAAAAAAAEB8682AAAAAAAAAADElBx79rbhYaf3aUgLbVm0P2BNEN+aLisS3A/6YYRX4AAAAAABycJUAfOtkAAAAAIAAAAAAAAAAAAAAAAAAAAPZ2l2aW5nYm9kaGkub3JnAAEAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAACAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAfOvNgAAAAQAAAAAF4gm+/4znh9cU0F8b+3+LAXovsFDAxQ+xGs4mBsJw/kAAAABAAAAAAAAAABJQagNQV8ynfZPZ7j6KHb9GASmPh4IelM/1MaM4J78swAAAAAAAAACQk9ESEkAAAAAAAAAAAAAAMSUHHv2tuFhp/dpSAttWbQ/YE0Q35ouKxLcD/phhFfgAAAAAAAPQkAAAAAAAAAAAQAAAAEAAAAAxJQce/a24WGn92lIC21ZtD9gTRDfmi4rEtwP+mGEV+AAAAAAAAAAAA==","fee_meta_xdr":"AAAAAgAAAAMB866UAAAAAAAAAADElBx79rbhYaf3aUgLbVm0P2BNEN+aLisS3A/6YYRX4AAAAAABycK4AfOtkAAAAAEAAAAAAAAAAAAAAAAAAAAPZ2l2aW5nYm9kaGkub3JnAAEAAAAAAAAAAAAAAAAAAAAAAAABAfOvNgAAAAAAAAAAxJQce/a24WGn92lIC21ZtD9gTRDfmi4rEtwP+mGEV+AAAAAAAcnCVAHzrZAAAAABAAAAAAAAAAAAAAAAAAAAD2dpdmluZ2JvZGhpLm9yZwABAAAAAAAAAAAAAAAAAAAA","memo_type":"none","signatures":["3+NcpFvnqvCFaSTTnOIg2obeQXopfDaUAfFjB5DsVt66HFARdxByqlFwyLA/Qs82O169T281ZORWeIgSjReDDA=="],"valid_after":"1970-01-01T00:00:00Z","preconditions":{"timebounds":{"min_time":"0"}}}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/claimable_balances/{claimable_balance_id}/transactions","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve Related Transactions","description":{"content":"This endpoint represents successful transactions referencing a given claimable balance and can be used in streaming mode. Streaming mode allows you to listen for new transactions referencing this claimable balance as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known transaction unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream transactions created since your request time.","type":"text/plain"},"url":{"path":["claimable_balances",":claimable_balance_id","transactions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Set to true to include failed operations in results. Options include true and false.","type":"text/plain"},"key":"include_failed","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) A unique identifier for this claimable balance.","type":"text/plain"},"type":"any","value":"","key":"claimable_balance_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/get-all-offers.api.mdx b/api/horizon/resources/get-all-offers.api.mdx index b9218ea34..a1d53746d 100644 --- a/api/horizon/resources/get-all-offers.api.mdx +++ b/api/horizon/resources/get-all-offers.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint lists all currently open offers and can be used in s sidebar_label: "List All Offers" hide_title: true hide_table_of_contents: true -api: {"tags":["Offers"],"description":"This endpoint lists all currently open offers and can be used in streaming mode. Streaming mode allows you to listen for new offers 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. When filtering by buying or selling arguments, you must use a combination of selling_asset_type, selling_asset_issuer, and selling_asset_code for the selling asset, or a combination of buying_asset_type, buying_asset_issuer, and buying_asset_code for the buying asset.","operationId":"GetAllOffers","parameters":[{"name":"sponser","in":"query","required":false,"description":"Account ID of the sponsor. Every account in the response will either be sponsored by the given account ID or have a subentry (trustline, offer, or data entry) which is sponsored by the given account ID.","schema":{"type":"string","example":"GDMQQNJM4UL7QIA66P7R2PZHMQINWZBM77BEBMHLFXD5JEUAHGJ7R4JZ"}},{"name":"seller","in":"query","required":false,"description":"The account ID of the offer creator."},{"name":"selling_asset_type","in":"query","required":false,"description":"The type for the selling asset. Either native, credit_alphanum4, or credit_alphanum12.","schema":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]}},{"name":"selling_asset_issuer","in":"query","required":false,"description":"The Stellar address of the selling asset’s issuer."},{"name":"selling_asset_code","in":"query","required":false,"description":"The code for the selling asset."},{"name":"buying_asset_type","in":"query","required":false,"description":"The type for the buying asset. Either native, credit_alphanum4, or credit_alphanum12.","schema":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]}},{"name":"buying_asset_issuer","in":"query","required":false,"description":"The Stellar address of the buying asset’s issuer."},{"name":"buying_asset_code","in":"query","required":false,"description":"The code for the buying asset."},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"offer_maker":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","offer_maker"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"seller":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"selling":{"type":"object","properties":{"asset_type":{"type":"string"},"asset_code":{"type":"string"},"asset_issuer":{"type":"string"}},"required":["asset_type"],"title":"BaseAsset"},"buying":{"type":"object","properties":{"asset_type":{"type":"string"},"asset_code":{"type":"string"},"asset_issuer":{"type":"string"}},"required":["asset_type"],"title":"BaseAsset"},"amount":{"type":"string"},"price_r":{"type":"object","properties":{"n":{"type":"integer","format":"int32"},"d":{"type":"integer","format":"int32"}},"title":"Price"},"price":{"type":"string"},"last_modified_ledger":{"type":"integer","format":"uint32","title":"last_modified_ledger"},"last_modified_time":{"type":"string"},"sponser":{"type":"string"}},"required":["id","paging_token","seller","selling","buying","amount","price_r","price","last_modified_ledger","last_modified_time"]}}}}},"title":"Offer"}]},"examples":{"GetAllOffers":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/offers?cursor=&limit=3&order=asc&selling_asset_code=USD&selling_asset_issuer=GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX&selling_asset_type=credit_alphanum4"},"next":{"href":"https://horizon.stellar.org/offers?cursor=88345152&limit=3&order=asc&selling_asset_code=USD&selling_asset_issuer=GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX&selling_asset_type=credit_alphanum4"},"prev":{"href":"https://horizon.stellar.org/offers?cursor=71673427&limit=3&order=desc&selling_asset_code=USD&selling_asset_issuer=GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX&selling_asset_type=credit_alphanum4"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/offers/71673427"},"offer_maker":{"href":"https://horizon.stellar.org/accounts/GBJPWEIFX6KO4H52BF3QJDYRCLXB2P3Z3QTKWUGFOOFH5MSRZV4WLRZ7"}},"id":71673427,"paging_token":"71673427","seller":"GBJPWEIFX6KO4H52BF3QJDYRCLXB2P3Z3QTKWUGFOOFH5MSRZV4WLRZ7","selling":{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"},"buying":{"asset_type":"credit_alphanum4","asset_code":"BTC","asset_issuer":"GAUTUYY2THLF7SGITDFMXJVYH3LHDSMGEAKSBU267M2K7A3W543CKUEF"},"amount":"25.6545775","price_r":{"n":289696073,"d":25654776},"price":"11.2920913","last_modified_ledger":26981646,"last_modified_time":"2019-11-26T13:42:10Z"},{"_links":{"self":{"href":"https://horizon.stellar.org/offers/88328208"},"offer_maker":{"href":"https://horizon.stellar.org/accounts/GBSYMLHG5TGQ4O3NSPIO4DSCS4AC6YRJOQWQC3EW7O257RAUHI5SA45R"}},"id":88328208,"paging_token":"88328208","seller":"GBSYMLHG5TGQ4O3NSPIO4DSCS4AC6YRJOQWQC3EW7O257RAUHI5SA45R","selling":{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"},"buying":{"asset_type":"credit_alphanum4","asset_code":"BTC","asset_issuer":"GBVOL67TMUQBGL4TZYNMY3ZQ5WGQYFPFD5VJRWXR72VA33VFNL225PL5"},"amount":"2.4664893","price_r":{"n":500,"d":1233},"price":"0.4055150","last_modified_ledger":23886660,"last_modified_time":"2019-05-17T00:33:16Z"},{"_links":{"self":{"href":"https://horizon.stellar.org/offers/88345152"},"offer_maker":{"href":"https://horizon.stellar.org/accounts/GACTQP5TAWIXF2LV4GWGJWIUNHKDWZ2ITCFDP37FIGOFPR3ORMQRR63U"}},"id":88345152,"paging_token":"88345152","seller":"GACTQP5TAWIXF2LV4GWGJWIUNHKDWZ2ITCFDP37FIGOFPR3ORMQRR63U","selling":{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"},"buying":{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GBUYUAI75XXWDZEKLY66CFYKQPET5JR4EENXZBUZ3YXZ7DS56Z4OKOFU"},"amount":"10.0000000","price_r":{"n":11,"d":10},"price":"1.1000000","last_modified_ledger":23887778,"last_modified_time":"2019-05-17T02:19:19Z"}]}}}}}}}},"method":"get","path":"/offers","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"List All Offers","description":{"content":"This endpoint lists all currently open offers and can be used in streaming mode. Streaming mode allows you to listen for new offers 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. When filtering by buying or selling arguments, you must use a combination of selling_asset_type, selling_asset_issuer, and selling_asset_code for the selling asset, or a combination of buying_asset_type, buying_asset_issuer, and buying_asset_code for the buying asset.","type":"text/plain"},"url":{"path":["offers"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Account ID of the sponsor. Every account in the response will either be sponsored by the given account ID or have a subentry (trustline, offer, or data entry) which is sponsored by the given account ID.","type":"text/plain"},"key":"sponser","value":""},{"description":{"content":"The account ID of the offer creator.","type":"text/plain"},"key":"seller","value":""},{"disabled":false,"description":{"content":"The type for the selling asset. Either native, credit_alphanum4, or credit_alphanum12.","type":"text/plain"},"key":"selling_asset_type","value":""},{"description":{"content":"The Stellar address of the selling asset’s issuer.","type":"text/plain"},"key":"selling_asset_issuer","value":""},{"description":{"content":"The code for the selling asset.","type":"text/plain"},"key":"selling_asset_code","value":""},{"disabled":false,"description":{"content":"The type for the buying asset. Either native, credit_alphanum4, or credit_alphanum12.","type":"text/plain"},"key":"buying_asset_type","value":""},{"description":{"content":"The Stellar address of the buying asset’s issuer.","type":"text/plain"},"key":"buying_asset_issuer","value":""},{"description":{"content":"The code for the buying asset.","type":"text/plain"},"key":"buying_asset_code","value":""},{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Offers"],"description":"This endpoint lists all currently open offers and can be used in streaming mode. Streaming mode allows you to listen for new offers 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. When filtering by buying or selling arguments, you must use a combination of selling_asset_type, selling_asset_issuer, and selling_asset_code for the selling asset, or a combination of buying_asset_type, buying_asset_issuer, and buying_asset_code for the buying asset.","operationId":"GetAllOffers","parameters":[{"name":"sponser","in":"query","required":false,"description":"Account ID of the sponsor. Every account in the response will either be sponsored by the given account ID or have a subentry (trustline, offer, or data entry) which is sponsored by the given account ID.","schema":{"type":"string","example":"GDMQQNJM4UL7QIA66P7R2PZHMQINWZBM77BEBMHLFXD5JEUAHGJ7R4JZ"}},{"name":"seller","in":"query","required":false,"description":"The account ID of the offer creator."},{"name":"selling_asset_type","in":"query","required":false,"description":"The type for the selling asset. Either native, credit_alphanum4, or credit_alphanum12.","schema":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]}},{"name":"selling_asset_issuer","in":"query","required":false,"description":"The Stellar address of the selling asset’s issuer."},{"name":"selling_asset_code","in":"query","required":false,"description":"The code for the selling asset."},{"name":"buying_asset_type","in":"query","required":false,"description":"The type for the buying asset. Either native, credit_alphanum4, or credit_alphanum12.","schema":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]}},{"name":"buying_asset_issuer","in":"query","required":false,"description":"The Stellar address of the buying asset’s issuer."},{"name":"buying_asset_code","in":"query","required":false,"description":"The code for the buying asset."},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"offer_maker":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","offer_maker"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"seller":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"selling":{"type":"object","properties":{"asset_type":{"type":"string"},"asset_code":{"type":"string"},"asset_issuer":{"type":"string"}},"required":["asset_type"],"title":"BaseAsset"},"buying":{"type":"object","properties":{"asset_type":{"type":"string"},"asset_code":{"type":"string"},"asset_issuer":{"type":"string"}},"required":["asset_type"],"title":"BaseAsset"},"amount":{"type":"string"},"price_r":{"type":"object","properties":{"n":{"type":"integer","format":"int32"},"d":{"type":"integer","format":"int32"}},"title":"Price"},"price":{"type":"string"},"last_modified_ledger":{"type":"integer","format":"uint32","title":"last_modified_ledger"},"last_modified_time":{"type":"string"},"sponser":{"type":"string"}},"required":["id","paging_token","seller","selling","buying","amount","price_r","price","last_modified_ledger","last_modified_time"]}}}}},"title":"Offer"}]},"examples":{"GetAllOffers":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/offers?cursor=&limit=3&order=asc&selling_asset_code=USD&selling_asset_issuer=GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX&selling_asset_type=credit_alphanum4"},"next":{"href":"https://horizon.stellar.org/offers?cursor=88345152&limit=3&order=asc&selling_asset_code=USD&selling_asset_issuer=GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX&selling_asset_type=credit_alphanum4"},"prev":{"href":"https://horizon.stellar.org/offers?cursor=71673427&limit=3&order=desc&selling_asset_code=USD&selling_asset_issuer=GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX&selling_asset_type=credit_alphanum4"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/offers/71673427"},"offer_maker":{"href":"https://horizon.stellar.org/accounts/GBJPWEIFX6KO4H52BF3QJDYRCLXB2P3Z3QTKWUGFOOFH5MSRZV4WLRZ7"}},"id":71673427,"paging_token":"71673427","seller":"GBJPWEIFX6KO4H52BF3QJDYRCLXB2P3Z3QTKWUGFOOFH5MSRZV4WLRZ7","selling":{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"},"buying":{"asset_type":"credit_alphanum4","asset_code":"BTC","asset_issuer":"GAUTUYY2THLF7SGITDFMXJVYH3LHDSMGEAKSBU267M2K7A3W543CKUEF"},"amount":"25.6545775","price_r":{"n":289696073,"d":25654776},"price":"11.2920913","last_modified_ledger":26981646,"last_modified_time":"2019-11-26T13:42:10Z"},{"_links":{"self":{"href":"https://horizon.stellar.org/offers/88328208"},"offer_maker":{"href":"https://horizon.stellar.org/accounts/GBSYMLHG5TGQ4O3NSPIO4DSCS4AC6YRJOQWQC3EW7O257RAUHI5SA45R"}},"id":88328208,"paging_token":"88328208","seller":"GBSYMLHG5TGQ4O3NSPIO4DSCS4AC6YRJOQWQC3EW7O257RAUHI5SA45R","selling":{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"},"buying":{"asset_type":"credit_alphanum4","asset_code":"BTC","asset_issuer":"GBVOL67TMUQBGL4TZYNMY3ZQ5WGQYFPFD5VJRWXR72VA33VFNL225PL5"},"amount":"2.4664893","price_r":{"n":500,"d":1233},"price":"0.4055150","last_modified_ledger":23886660,"last_modified_time":"2019-05-17T00:33:16Z"},{"_links":{"self":{"href":"https://horizon.stellar.org/offers/88345152"},"offer_maker":{"href":"https://horizon.stellar.org/accounts/GACTQP5TAWIXF2LV4GWGJWIUNHKDWZ2ITCFDP37FIGOFPR3ORMQRR63U"}},"id":88345152,"paging_token":"88345152","seller":"GACTQP5TAWIXF2LV4GWGJWIUNHKDWZ2ITCFDP37FIGOFPR3ORMQRR63U","selling":{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"},"buying":{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GBUYUAI75XXWDZEKLY66CFYKQPET5JR4EENXZBUZ3YXZ7DS56Z4OKOFU"},"amount":"10.0000000","price_r":{"n":11,"d":10},"price":"1.1000000","last_modified_ledger":23887778,"last_modified_time":"2019-05-17T02:19:19Z"}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/offers","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"List All Offers","description":{"content":"This endpoint lists all currently open offers and can be used in streaming mode. Streaming mode allows you to listen for new offers 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. When filtering by buying or selling arguments, you must use a combination of selling_asset_type, selling_asset_issuer, and selling_asset_code for the selling asset, or a combination of buying_asset_type, buying_asset_issuer, and buying_asset_code for the buying asset.","type":"text/plain"},"url":{"path":["offers"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Account ID of the sponsor. Every account in the response will either be sponsored by the given account ID or have a subentry (trustline, offer, or data entry) which is sponsored by the given account ID.","type":"text/plain"},"key":"sponser","value":""},{"description":{"content":"The account ID of the offer creator.","type":"text/plain"},"key":"seller","value":""},{"disabled":false,"description":{"content":"The type for the selling asset. Either native, credit_alphanum4, or credit_alphanum12.","type":"text/plain"},"key":"selling_asset_type","value":""},{"description":{"content":"The Stellar address of the selling asset’s issuer.","type":"text/plain"},"key":"selling_asset_issuer","value":""},{"description":{"content":"The code for the selling asset.","type":"text/plain"},"key":"selling_asset_code","value":""},{"disabled":false,"description":{"content":"The type for the buying asset. Either native, credit_alphanum4, or credit_alphanum12.","type":"text/plain"},"key":"buying_asset_type","value":""},{"description":{"content":"The Stellar address of the buying asset’s issuer.","type":"text/plain"},"key":"buying_asset_issuer","value":""},{"description":{"content":"The code for the buying asset.","type":"text/plain"},"key":"buying_asset_code","value":""},{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/get-all-trades.api.mdx b/api/horizon/resources/get-all-trades.api.mdx index b31740b8f..be13243b6 100644 --- a/api/horizon/resources/get-all-trades.api.mdx +++ b/api/horizon/resources/get-all-trades.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint lists all trades and can be used in streaming mode. sidebar_label: "List All Trades" hide_title: true hide_table_of_contents: true -api: {"tags":["Trades"],"description":"This endpoint lists all trades and can be used in streaming mode. Streaming mode allows you to listen for new trades 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. When filtering for a specific orderbook, you must use use all six of these arguments: base_asset_type, base_asset_issuer, base_asset_code, counter_asset_type, counter_asset_issuer, and counter_asset_code. If the base or counter asset is XLM, you only need to indicate the asset type as native and do not need to designate the code or the issuer.","operationId":"GetAllTrades","parameters":[{"name":"offer_id","in":"query","required":false,"description":"The offer ID. Used to filter for trades originating from a specific offer."},{"name":"base_asset_type","in":"query","required":false,"description":"The type for the base asset. Either native, credit_alphanum4, or credit_alphanum12.","schema":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]}},{"name":"base_asset_issuer","in":"query","required":false,"description":"The Stellar address of the base asset’s issuer.","schema":{"type":"string","example":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"}},{"name":"base_asset_code","in":"query","required":false,"description":"The code for the base asset.","schema":{"type":"string","example":"USD"}},{"name":"counter_asset_type","in":"query","required":false,"description":"The type for the counter asset. Either native, credit_alphanum4, or credit_alphanum12.","schema":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]}},{"name":"counter_asset_issuer","in":"query","required":false,"description":"The Stellar address of the counter asset’s issuer.","schema":{"type":"string","example":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"}},{"name":"counter_asset_code","in":"query","required":false,"description":"The code for the counter asset."},{"name":"trade_type","in":"query","required":false,"description":"Can be set to all, orderbook, or liquidity_pools to filter only trades executed across a given mechanism.","schema":{"type":"string","enum":["all","orderbook","liquidity_pools"]}},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"base":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"counter":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"operation":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","base","counter","operation"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string","title":"paging_token"},"ledger_close_time":{"type":"string"},"offer_id":{"type":"string"},"trade_type":{"type":"string"},"liquidity_pool_fee_bp":{"type":"number","format":"uint32"},"base_liquidity_pool_id":{"type":"string"},"base_offer_id":{"type":"string"},"base_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"base_amount":{"type":"string"},"base_asset_type":{"type":"string"},"base_asset_code":{"type":"string"},"base_asset_issuer":{"type":"string"},"counter_liquidity_pool_id":{"type":"string"},"counter_offer_id":{"type":"string"},"counter_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"counter_amount":{"type":"string"},"counter_asset_type":{"type":"string"},"counter_asset_code":{"type":"string"},"counter_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"base_is_seller":{"type":"boolean"},"price":{"required":["id","paging_token","ledger_close_time","trade_type","base_amount","base_asset_type","counter_amount","counter_asset_type","base_is_seller"],"type":"object","properties":{"n":{"type":"string"},"d":{"type":"string"}},"title":"tradePrice"}}}}}}},"title":"Trade"}]},"examples":{"GetAllTrades":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/trades?base_asset_code=USD&base_asset_issuer=GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX&base_asset_type=credit_alphanum4&counter_asset_type=native&cursor=&limit=3&order=asc"},"next":{"href":"https://horizon.stellar.org/trades?base_asset_code=USD&base_asset_issuer=GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX&base_asset_type=credit_alphanum4&counter_asset_type=native&cursor=83056000260648961-0&limit=3&order=asc"},"prev":{"href":"https://horizon.stellar.org/trades?base_asset_code=USD&base_asset_issuer=GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX&base_asset_type=credit_alphanum4&counter_asset_type=native&cursor=82854686553571330-0&limit=3&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":""},"base":{"href":"https://horizon.stellar.org/accounts/GD47M25MLSCSYP4SIVNQXVQ4KWNLVGXS4S2AXPTYEJK6OY4VALJWK4BS"},"counter":{"href":"https://horizon.stellar.org/accounts/GBCHK52UXADCQCO7FBA5VBYPGCJFXHCNAVJTMUEKOCCNKJH5F35UZU5T"},"operation":{"href":"https://horizon.stellar.org/operations/82854686553571330"}},"id":"82854686553571330-0","paging_token":"82854686553571330-0","ledger_close_time":"2018-08-05T00:55:34Z","offer_id":"23074703","base_offer_id":"23074703","base_account":"GD47M25MLSCSYP4SIVNQXVQ4KWNLVGXS4S2AXPTYEJK6OY4VALJWK4BS","base_amount":"22.9174941","base_asset_type":"credit_alphanum4","base_asset_code":"USD","base_asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","counter_offer_id":"4694540704980959234","counter_account":"GBCHK52UXADCQCO7FBA5VBYPGCJFXHCNAVJTMUEKOCCNKJH5F35UZU5T","counter_amount":"97.9999800","counter_asset_type":"native","base_is_seller":true,"price":{"n":"106905209","d":"25000000"}},{"_links":{"self":{"href":""},"base":{"href":"https://horizon.stellar.org/accounts/GD47M25MLSCSYP4SIVNQXVQ4KWNLVGXS4S2AXPTYEJK6OY4VALJWK4BS"},"counter":{"href":"https://horizon.stellar.org/accounts/GDURV3I6U5OTUV75WWAG2HWZTQHNMCR3NR2P5GPKDCIS2AEWCFSOLVFU"},"operation":{"href":"https://horizon.stellar.org/operations/83005225157287937"}},"id":"83005225157287937-0","paging_token":"83005225157287937-0","ledger_close_time":"2018-08-07T02:01:53Z","offer_id":"23400441","base_offer_id":"23400441","base_account":"GD47M25MLSCSYP4SIVNQXVQ4KWNLVGXS4S2AXPTYEJK6OY4VALJWK4BS","base_amount":"1.0000000","base_asset_type":"credit_alphanum4","base_asset_code":"USD","base_asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","counter_offer_id":"4694691243584675841","counter_account":"GDURV3I6U5OTUV75WWAG2HWZTQHNMCR3NR2P5GPKDCIS2AEWCFSOLVFU","counter_amount":"4.3080953","counter_asset_type":"native","base_is_seller":true,"price":{"n":"430809521","d":"100000000"}},{"_links":{"self":{"href":""},"base":{"href":"https://horizon.stellar.org/accounts/GD47M25MLSCSYP4SIVNQXVQ4KWNLVGXS4S2AXPTYEJK6OY4VALJWK4BS"},"counter":{"href":"https://horizon.stellar.org/accounts/GBNDB4UHLDRBLR35JNU4ADYG3J5WA4LJZOPBXMNHZKTKSL37BDX4UBQY"},"operation":{"href":"https://horizon.stellar.org/operations/83056000260648961"}},"id":"83056000260648961-0","paging_token":"83056000260648961-0","ledger_close_time":"2018-08-07T18:27:33Z","offer_id":"23400441","base_offer_id":"23400441","base_account":"GD47M25MLSCSYP4SIVNQXVQ4KWNLVGXS4S2AXPTYEJK6OY4VALJWK4BS","base_amount":"1.0000000","base_asset_type":"credit_alphanum4","base_asset_code":"USD","base_asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","counter_offer_id":"4694742018688036865","counter_account":"GBNDB4UHLDRBLR35JNU4ADYG3J5WA4LJZOPBXMNHZKTKSL37BDX4UBQY","counter_amount":"4.3080953","counter_asset_type":"native","base_is_seller":true,"price":{"n":"430809521","d":"100000000"}}]}}}}}}}},"method":"get","path":"/trades","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"List All Trades","description":{"content":"This endpoint lists all trades and can be used in streaming mode. Streaming mode allows you to listen for new trades 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. When filtering for a specific orderbook, you must use use all six of these arguments: base_asset_type, base_asset_issuer, base_asset_code, counter_asset_type, counter_asset_issuer, and counter_asset_code. If the base or counter asset is XLM, you only need to indicate the asset type as native and do not need to designate the code or the issuer.","type":"text/plain"},"url":{"path":["trades"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"The offer ID. Used to filter for trades originating from a specific offer.","type":"text/plain"},"key":"offer_id","value":""},{"disabled":false,"description":{"content":"The type for the base asset. Either native, credit_alphanum4, or credit_alphanum12.","type":"text/plain"},"key":"base_asset_type","value":""},{"disabled":false,"description":{"content":"The Stellar address of the base asset’s issuer.","type":"text/plain"},"key":"base_asset_issuer","value":""},{"disabled":false,"description":{"content":"The code for the base asset.","type":"text/plain"},"key":"base_asset_code","value":""},{"disabled":false,"description":{"content":"The type for the counter asset. Either native, credit_alphanum4, or credit_alphanum12.","type":"text/plain"},"key":"counter_asset_type","value":""},{"disabled":false,"description":{"content":"The Stellar address of the counter asset’s issuer.","type":"text/plain"},"key":"counter_asset_issuer","value":""},{"description":{"content":"The code for the counter asset.","type":"text/plain"},"key":"counter_asset_code","value":""},{"disabled":false,"description":{"content":"Can be set to all, orderbook, or liquidity_pools to filter only trades executed across a given mechanism.","type":"text/plain"},"key":"trade_type","value":""},{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Trades"],"description":"This endpoint lists all trades and can be used in streaming mode. Streaming mode allows you to listen for new trades 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. When filtering for a specific orderbook, you must use use all six of these arguments: base_asset_type, base_asset_issuer, base_asset_code, counter_asset_type, counter_asset_issuer, and counter_asset_code. If the base or counter asset is XLM, you only need to indicate the asset type as native and do not need to designate the code or the issuer.","operationId":"GetAllTrades","parameters":[{"name":"offer_id","in":"query","required":false,"description":"The offer ID. Used to filter for trades originating from a specific offer."},{"name":"base_asset_type","in":"query","required":false,"description":"The type for the base asset. Either native, credit_alphanum4, or credit_alphanum12.","schema":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]}},{"name":"base_asset_issuer","in":"query","required":false,"description":"The Stellar address of the base asset’s issuer.","schema":{"type":"string","example":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"}},{"name":"base_asset_code","in":"query","required":false,"description":"The code for the base asset.","schema":{"type":"string","example":"USD"}},{"name":"counter_asset_type","in":"query","required":false,"description":"The type for the counter asset. Either native, credit_alphanum4, or credit_alphanum12.","schema":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]}},{"name":"counter_asset_issuer","in":"query","required":false,"description":"The Stellar address of the counter asset’s issuer.","schema":{"type":"string","example":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"}},{"name":"counter_asset_code","in":"query","required":false,"description":"The code for the counter asset."},{"name":"trade_type","in":"query","required":false,"description":"Can be set to all, orderbook, or liquidity_pools to filter only trades executed across a given mechanism.","schema":{"type":"string","enum":["all","orderbook","liquidity_pools"]}},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"base":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"counter":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"operation":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","base","counter","operation"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string","title":"paging_token"},"ledger_close_time":{"type":"string"},"offer_id":{"type":"string"},"trade_type":{"type":"string"},"liquidity_pool_fee_bp":{"type":"number","format":"uint32"},"base_liquidity_pool_id":{"type":"string"},"base_offer_id":{"type":"string"},"base_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"base_amount":{"type":"string"},"base_asset_type":{"type":"string"},"base_asset_code":{"type":"string"},"base_asset_issuer":{"type":"string"},"counter_liquidity_pool_id":{"type":"string"},"counter_offer_id":{"type":"string"},"counter_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"counter_amount":{"type":"string"},"counter_asset_type":{"type":"string"},"counter_asset_code":{"type":"string"},"counter_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"base_is_seller":{"type":"boolean"},"price":{"required":["id","paging_token","ledger_close_time","trade_type","base_amount","base_asset_type","counter_amount","counter_asset_type","base_is_seller"],"type":"object","properties":{"n":{"type":"string"},"d":{"type":"string"}},"title":"tradePrice"}}}}}}},"title":"Trade"}]},"examples":{"GetAllTrades":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/trades?base_asset_code=USD&base_asset_issuer=GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX&base_asset_type=credit_alphanum4&counter_asset_type=native&cursor=&limit=3&order=asc"},"next":{"href":"https://horizon.stellar.org/trades?base_asset_code=USD&base_asset_issuer=GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX&base_asset_type=credit_alphanum4&counter_asset_type=native&cursor=83056000260648961-0&limit=3&order=asc"},"prev":{"href":"https://horizon.stellar.org/trades?base_asset_code=USD&base_asset_issuer=GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX&base_asset_type=credit_alphanum4&counter_asset_type=native&cursor=82854686553571330-0&limit=3&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":""},"base":{"href":"https://horizon.stellar.org/accounts/GD47M25MLSCSYP4SIVNQXVQ4KWNLVGXS4S2AXPTYEJK6OY4VALJWK4BS"},"counter":{"href":"https://horizon.stellar.org/accounts/GBCHK52UXADCQCO7FBA5VBYPGCJFXHCNAVJTMUEKOCCNKJH5F35UZU5T"},"operation":{"href":"https://horizon.stellar.org/operations/82854686553571330"}},"id":"82854686553571330-0","paging_token":"82854686553571330-0","ledger_close_time":"2018-08-05T00:55:34Z","offer_id":"23074703","base_offer_id":"23074703","base_account":"GD47M25MLSCSYP4SIVNQXVQ4KWNLVGXS4S2AXPTYEJK6OY4VALJWK4BS","base_amount":"22.9174941","base_asset_type":"credit_alphanum4","base_asset_code":"USD","base_asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","counter_offer_id":"4694540704980959234","counter_account":"GBCHK52UXADCQCO7FBA5VBYPGCJFXHCNAVJTMUEKOCCNKJH5F35UZU5T","counter_amount":"97.9999800","counter_asset_type":"native","base_is_seller":true,"price":{"n":"106905209","d":"25000000"}},{"_links":{"self":{"href":""},"base":{"href":"https://horizon.stellar.org/accounts/GD47M25MLSCSYP4SIVNQXVQ4KWNLVGXS4S2AXPTYEJK6OY4VALJWK4BS"},"counter":{"href":"https://horizon.stellar.org/accounts/GDURV3I6U5OTUV75WWAG2HWZTQHNMCR3NR2P5GPKDCIS2AEWCFSOLVFU"},"operation":{"href":"https://horizon.stellar.org/operations/83005225157287937"}},"id":"83005225157287937-0","paging_token":"83005225157287937-0","ledger_close_time":"2018-08-07T02:01:53Z","offer_id":"23400441","base_offer_id":"23400441","base_account":"GD47M25MLSCSYP4SIVNQXVQ4KWNLVGXS4S2AXPTYEJK6OY4VALJWK4BS","base_amount":"1.0000000","base_asset_type":"credit_alphanum4","base_asset_code":"USD","base_asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","counter_offer_id":"4694691243584675841","counter_account":"GDURV3I6U5OTUV75WWAG2HWZTQHNMCR3NR2P5GPKDCIS2AEWCFSOLVFU","counter_amount":"4.3080953","counter_asset_type":"native","base_is_seller":true,"price":{"n":"430809521","d":"100000000"}},{"_links":{"self":{"href":""},"base":{"href":"https://horizon.stellar.org/accounts/GD47M25MLSCSYP4SIVNQXVQ4KWNLVGXS4S2AXPTYEJK6OY4VALJWK4BS"},"counter":{"href":"https://horizon.stellar.org/accounts/GBNDB4UHLDRBLR35JNU4ADYG3J5WA4LJZOPBXMNHZKTKSL37BDX4UBQY"},"operation":{"href":"https://horizon.stellar.org/operations/83056000260648961"}},"id":"83056000260648961-0","paging_token":"83056000260648961-0","ledger_close_time":"2018-08-07T18:27:33Z","offer_id":"23400441","base_offer_id":"23400441","base_account":"GD47M25MLSCSYP4SIVNQXVQ4KWNLVGXS4S2AXPTYEJK6OY4VALJWK4BS","base_amount":"1.0000000","base_asset_type":"credit_alphanum4","base_asset_code":"USD","base_asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","counter_offer_id":"4694742018688036865","counter_account":"GBNDB4UHLDRBLR35JNU4ADYG3J5WA4LJZOPBXMNHZKTKSL37BDX4UBQY","counter_amount":"4.3080953","counter_asset_type":"native","base_is_seller":true,"price":{"n":"430809521","d":"100000000"}}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/trades","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"List All Trades","description":{"content":"This endpoint lists all trades and can be used in streaming mode. Streaming mode allows you to listen for new trades 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. When filtering for a specific orderbook, you must use use all six of these arguments: base_asset_type, base_asset_issuer, base_asset_code, counter_asset_type, counter_asset_issuer, and counter_asset_code. If the base or counter asset is XLM, you only need to indicate the asset type as native and do not need to designate the code or the issuer.","type":"text/plain"},"url":{"path":["trades"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"The offer ID. Used to filter for trades originating from a specific offer.","type":"text/plain"},"key":"offer_id","value":""},{"disabled":false,"description":{"content":"The type for the base asset. Either native, credit_alphanum4, or credit_alphanum12.","type":"text/plain"},"key":"base_asset_type","value":""},{"disabled":false,"description":{"content":"The Stellar address of the base asset’s issuer.","type":"text/plain"},"key":"base_asset_issuer","value":""},{"disabled":false,"description":{"content":"The code for the base asset.","type":"text/plain"},"key":"base_asset_code","value":""},{"disabled":false,"description":{"content":"The type for the counter asset. Either native, credit_alphanum4, or credit_alphanum12.","type":"text/plain"},"key":"counter_asset_type","value":""},{"disabled":false,"description":{"content":"The Stellar address of the counter asset’s issuer.","type":"text/plain"},"key":"counter_asset_issuer","value":""},{"description":{"content":"The code for the counter asset.","type":"text/plain"},"key":"counter_asset_code","value":""},{"disabled":false,"description":{"content":"Can be set to all, orderbook, or liquidity_pools to filter only trades executed across a given mechanism.","type":"text/plain"},"key":"trade_type","value":""},{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/get-effects-by-account-id.api.mdx b/api/horizon/resources/get-effects-by-account-id.api.mdx index f21bb9c55..649126e93 100644 --- a/api/horizon/resources/get-effects-by-account-id.api.mdx +++ b/api/horizon/resources/get-effects-by-account-id.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint returns the effects of a specific account and can be sidebar_label: "Retrieve an Account's Effects" hide_title: true hide_table_of_contents: true -api: {"tags":["Accounts"],"description":"This endpoint returns the effects of a specific account and can be used in streaming mode. Streaming mode allows you to listen for new effects for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known effect unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream effects created since your request time.","operationId":"GetEffectsByAccountId","parameters":[{"name":"account_id","in":"path","required":true,"description":"This account’s public key encoded in a base32 string representation.","schema":{"type":"string","example":"GDMQQNJM4UL7QIA66P7R2PZHMQINWZBM77BEBMHLFXD5JEUAHGJ7R4JZ"}},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"oneOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"create_account"},"type_i":{"type":"number","example":0},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"starting_balance":{"type":"string"},"funder":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","starting_balance","funder","account"],"title":"CreateAccount"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"payment"},"type_i":{"type":"string"},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string"},"asset_code":{"enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","asset_type","from","to","amount"]}}}}},"title":"Payment"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"path_payment_strict_receive"},"type_i":{"type":"number","example":2},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"},"path":{"type":"array","items":{"type":"object","properties":{"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}}}},"source_amount":{"type":"string"},"destination_min":{"type":"string"},"source_asset_type":{"type":"string"},"source_asset_code":{"type":"string"},"source_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","from","to","amount","path","source_amount","destination_min"],"title":"PathPaymentStrictReceive"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"path_payment_strict_send"},"type_i":{"type":"number","example":13},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"},"path":{"type":"array","items":{"type":"object","properties":{"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}}}},"source_amount":{"type":"string"},"source_max":{"type":"string"},"source_asset_type":{"type":"string"},"source_asset_code":{"type":"string"},"source_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","from","to","amount","path","source_amount","source_asset_type"],"title":"PathPaymentStrictSend"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"account_merge"},"type_i":{"type":"number","example":8},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"into":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","account","into"],"title":"AccountMerge"}]}]},"examples":{"RetrieveAnAccountsEffects":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/accounts/GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE/effects?cursor=&limit=10&order=asc"},"next":{"href":"https://horizon.stellar.org/accounts/GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE/effects?cursor=147350483860869151-1&limit=10&order=asc"},"prev":{"href":"https://horizon.stellar.org/accounts/GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE/effects?cursor=110694007436259329-1&limit=10&order=desc"}},"_embedded":{"records":[{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/110694007436259329"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=110694007436259329-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=110694007436259329-1"}},"id":"0110694007436259329-0000000001","paging_token":"110694007436259329-1","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"account_created","type_i":0,"created_at":"2019-09-11T13:16:44Z","starting_balance":"1.0000000"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/110694007436259329"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=110694007436259329-3"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=110694007436259329-3"}},"id":"0110694007436259329-0000000003","paging_token":"110694007436259329-3","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"signer_created","type_i":10,"created_at":"2019-09-11T13:16:44Z","weight":1,"public_key":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","key":""},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/110694007436259330"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=110694007436259330-2"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=110694007436259330-2"}},"id":"0110694007436259330-0000000002","paging_token":"110694007436259330-2","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"account_credited","type_i":2,"created_at":"2019-09-11T13:16:44Z","asset_type":"native","amount":"355.2904739"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/115354197276323841"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=115354197276323841-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=115354197276323841-1"}},"id":"0115354197276323841-0000000001","paging_token":"115354197276323841-1","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"account_credited","type_i":2,"created_at":"2019-11-18T19:59:40Z","asset_type":"native","amount":"688.4065454"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/117356420835532801"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=117356420835532801-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=117356420835532801-1"}},"id":"0117356420835532801-0000000001","paging_token":"117356420835532801-1","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"account_credited","type_i":2,"created_at":"2019-12-18T08:23:35Z","asset_type":"native","amount":"355.3887598"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/119399833130811393"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=119399833130811393-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=119399833130811393-1"}},"id":"0119399833130811393-0000000001","paging_token":"119399833130811393-1","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"trustline_created","type_i":20,"created_at":"2020-01-17T20:13:22Z","asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","limit":"922337203685.4775000"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/119399833130811394"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=119399833130811394-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=119399833130811394-1"}},"id":"0119399833130811394-0000000001","paging_token":"119399833130811394-1","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"trade","type_i":33,"created_at":"2020-01-17T20:13:22Z","seller":"GCM4PT6XDZBWOOENDS6FOU22GJQLJPV2GC7VRVII4TFGZBA3ZXNM55SV","offer_id":"147625249","sold_amount":"539.0320108","sold_asset_type":"native","bought_amount":"32.8490620","bought_asset_type":"credit_alphanum4","bought_asset_code":"USD","bought_asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/119399833130811394"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=119399833130811394-3"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=119399833130811394-3"}},"id":"0119399833130811394-0000000003","paging_token":"119399833130811394-3","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"trade","type_i":33,"created_at":"2020-01-17T20:13:22Z","seller":"GBDVKE33GVVMBXX73OHIBRP6RAHKHHW2P4PQVV6UNOKQCOXU7GNUM4QI","offer_id":"147618811","sold_amount":"854.9537682","sold_asset_type":"native","bought_amount":"52.0920258","bought_asset_type":"credit_alphanum4","bought_asset_code":"USD","bought_asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/119400713599217665"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=119400713599217665-2"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=119400713599217665-2"}},"id":"0119400713599217665-0000000002","paging_token":"119400713599217665-2","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"account_debited","type_i":3,"created_at":"2020-01-17T20:32:38Z","asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","amount":"84.9410878"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/147350483860869151"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=147350483860869151-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=147350483860869151-1"}},"id":"0147350483860869151-0000000001","paging_token":"147350483860869151-1","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"account_credited","type_i":2,"created_at":"2021-03-06T19:27:33Z","asset_type":"native","amount":"0.0000001"}]}}}}}}}},"method":"get","path":"/accounts/{account_id}/effects","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve an Account's Effects","description":{"content":"This endpoint returns the effects of a specific account and can be used in streaming mode. Streaming mode allows you to listen for new effects for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known effect unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream effects created since your request time.","type":"text/plain"},"url":{"path":["accounts",":account_id","effects"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) This account’s public key encoded in a base32 string representation.","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Accounts"],"description":"This endpoint returns the effects of a specific account and can be used in streaming mode. Streaming mode allows you to listen for new effects for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known effect unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream effects created since your request time.","operationId":"GetEffectsByAccountId","parameters":[{"name":"account_id","in":"path","required":true,"description":"This account’s public key encoded in a base32 string representation.","schema":{"type":"string","example":"GDMQQNJM4UL7QIA66P7R2PZHMQINWZBM77BEBMHLFXD5JEUAHGJ7R4JZ"}},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"oneOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"create_account"},"type_i":{"type":"number","example":0},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"starting_balance":{"type":"string"},"funder":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","starting_balance","funder","account"],"title":"CreateAccount"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"payment"},"type_i":{"type":"string"},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string"},"asset_code":{"enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","asset_type","from","to","amount"]}}}}},"title":"Payment"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"path_payment_strict_receive"},"type_i":{"type":"number","example":2},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"},"path":{"type":"array","items":{"type":"object","properties":{"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}}}},"source_amount":{"type":"string"},"destination_min":{"type":"string"},"source_asset_type":{"type":"string"},"source_asset_code":{"type":"string"},"source_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","from","to","amount","path","source_amount","destination_min"],"title":"PathPaymentStrictReceive"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"path_payment_strict_send"},"type_i":{"type":"number","example":13},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"},"path":{"type":"array","items":{"type":"object","properties":{"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}}}},"source_amount":{"type":"string"},"source_max":{"type":"string"},"source_asset_type":{"type":"string"},"source_asset_code":{"type":"string"},"source_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","from","to","amount","path","source_amount","source_asset_type"],"title":"PathPaymentStrictSend"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"account_merge"},"type_i":{"type":"number","example":8},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"into":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","account","into"],"title":"AccountMerge"}]}]},"examples":{"RetrieveAnAccountsEffects":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/accounts/GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE/effects?cursor=&limit=10&order=asc"},"next":{"href":"https://horizon.stellar.org/accounts/GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE/effects?cursor=147350483860869151-1&limit=10&order=asc"},"prev":{"href":"https://horizon.stellar.org/accounts/GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE/effects?cursor=110694007436259329-1&limit=10&order=desc"}},"_embedded":{"records":[{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/110694007436259329"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=110694007436259329-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=110694007436259329-1"}},"id":"0110694007436259329-0000000001","paging_token":"110694007436259329-1","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"account_created","type_i":0,"created_at":"2019-09-11T13:16:44Z","starting_balance":"1.0000000"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/110694007436259329"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=110694007436259329-3"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=110694007436259329-3"}},"id":"0110694007436259329-0000000003","paging_token":"110694007436259329-3","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"signer_created","type_i":10,"created_at":"2019-09-11T13:16:44Z","weight":1,"public_key":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","key":""},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/110694007436259330"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=110694007436259330-2"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=110694007436259330-2"}},"id":"0110694007436259330-0000000002","paging_token":"110694007436259330-2","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"account_credited","type_i":2,"created_at":"2019-09-11T13:16:44Z","asset_type":"native","amount":"355.2904739"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/115354197276323841"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=115354197276323841-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=115354197276323841-1"}},"id":"0115354197276323841-0000000001","paging_token":"115354197276323841-1","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"account_credited","type_i":2,"created_at":"2019-11-18T19:59:40Z","asset_type":"native","amount":"688.4065454"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/117356420835532801"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=117356420835532801-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=117356420835532801-1"}},"id":"0117356420835532801-0000000001","paging_token":"117356420835532801-1","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"account_credited","type_i":2,"created_at":"2019-12-18T08:23:35Z","asset_type":"native","amount":"355.3887598"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/119399833130811393"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=119399833130811393-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=119399833130811393-1"}},"id":"0119399833130811393-0000000001","paging_token":"119399833130811393-1","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"trustline_created","type_i":20,"created_at":"2020-01-17T20:13:22Z","asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","limit":"922337203685.4775000"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/119399833130811394"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=119399833130811394-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=119399833130811394-1"}},"id":"0119399833130811394-0000000001","paging_token":"119399833130811394-1","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"trade","type_i":33,"created_at":"2020-01-17T20:13:22Z","seller":"GCM4PT6XDZBWOOENDS6FOU22GJQLJPV2GC7VRVII4TFGZBA3ZXNM55SV","offer_id":"147625249","sold_amount":"539.0320108","sold_asset_type":"native","bought_amount":"32.8490620","bought_asset_type":"credit_alphanum4","bought_asset_code":"USD","bought_asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/119399833130811394"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=119399833130811394-3"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=119399833130811394-3"}},"id":"0119399833130811394-0000000003","paging_token":"119399833130811394-3","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"trade","type_i":33,"created_at":"2020-01-17T20:13:22Z","seller":"GBDVKE33GVVMBXX73OHIBRP6RAHKHHW2P4PQVV6UNOKQCOXU7GNUM4QI","offer_id":"147618811","sold_amount":"854.9537682","sold_asset_type":"native","bought_amount":"52.0920258","bought_asset_type":"credit_alphanum4","bought_asset_code":"USD","bought_asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/119400713599217665"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=119400713599217665-2"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=119400713599217665-2"}},"id":"0119400713599217665-0000000002","paging_token":"119400713599217665-2","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"account_debited","type_i":3,"created_at":"2020-01-17T20:32:38Z","asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","amount":"84.9410878"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/147350483860869151"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=147350483860869151-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=147350483860869151-1"}},"id":"0147350483860869151-0000000001","paging_token":"147350483860869151-1","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"account_credited","type_i":2,"created_at":"2021-03-06T19:27:33Z","asset_type":"native","amount":"0.0000001"}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/accounts/{account_id}/effects","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve an Account's Effects","description":{"content":"This endpoint returns the effects of a specific account and can be used in streaming mode. Streaming mode allows you to listen for new effects for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known effect unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream effects created since your request time.","type":"text/plain"},"url":{"path":["accounts",":account_id","effects"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) This account’s public key encoded in a base32 string representation.","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/get-offers-by-account-id.api.mdx b/api/horizon/resources/get-offers-by-account-id.api.mdx index 893798d4f..4947bbd20 100644 --- a/api/horizon/resources/get-offers-by-account-id.api.mdx +++ b/api/horizon/resources/get-offers-by-account-id.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint represents all offers a given account has currently sidebar_label: "Retrieve an Account's Offers" hide_title: true hide_table_of_contents: true -api: {"tags":["Accounts"],"description":"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.","operationId":"GetOffersByAccountId","parameters":[{"name":"account_id","in":"path","required":true,"description":"This account’s public key encoded in a base32 string representation.","schema":{"type":"string","example":"GDMQQNJM4UL7QIA66P7R2PZHMQINWZBM77BEBMHLFXD5JEUAHGJ7R4JZ"}},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"offer_maker":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","offer_maker"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"seller":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"selling":{"type":"object","properties":{"asset_type":{"type":"string"},"asset_code":{"type":"string"},"asset_issuer":{"type":"string"}},"required":["asset_type"],"title":"BaseAsset"},"buying":{"type":"object","properties":{"asset_type":{"type":"string"},"asset_code":{"type":"string"},"asset_issuer":{"type":"string"}},"required":["asset_type"],"title":"BaseAsset"},"amount":{"type":"string"},"price_r":{"type":"object","properties":{"n":{"type":"integer","format":"int32"},"d":{"type":"integer","format":"int32"}},"title":"Price"},"price":{"type":"string"},"last_modified_ledger":{"type":"integer","format":"uint32","title":"last_modified_ledger"},"last_modified_time":{"type":"string"},"sponser":{"type":"string"}},"required":["id","paging_token","seller","selling","buying","amount","price_r","price","last_modified_ledger","last_modified_time"]}}}}},"title":"Offer"}]},"examples":{"RetrieveAnAccountsOffers":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K/offers?cursor=&limit=10&order=asc"},"next":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K/offers?cursor=164943216&limit=10&order=asc"},"prev":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K/offers?cursor=164555927&limit=10&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/offers/164555927"},"offer_maker":{"href":"https://horizon.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://horizon.stellar.org/offers/164943216"},"offer_maker":{"href":"https://horizon.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"}]}}}}}}}},"method":"get","path":"/accounts/{account_id}/offers","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve an Account's Offers","description":{"content":"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.","type":"text/plain"},"url":{"path":["accounts",":account_id","offers"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) This account’s public key encoded in a base32 string representation.","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Accounts"],"description":"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.","operationId":"GetOffersByAccountId","parameters":[{"name":"account_id","in":"path","required":true,"description":"This account’s public key encoded in a base32 string representation.","schema":{"type":"string","example":"GDMQQNJM4UL7QIA66P7R2PZHMQINWZBM77BEBMHLFXD5JEUAHGJ7R4JZ"}},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"offer_maker":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","offer_maker"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"seller":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"selling":{"type":"object","properties":{"asset_type":{"type":"string"},"asset_code":{"type":"string"},"asset_issuer":{"type":"string"}},"required":["asset_type"],"title":"BaseAsset"},"buying":{"type":"object","properties":{"asset_type":{"type":"string"},"asset_code":{"type":"string"},"asset_issuer":{"type":"string"}},"required":["asset_type"],"title":"BaseAsset"},"amount":{"type":"string"},"price_r":{"type":"object","properties":{"n":{"type":"integer","format":"int32"},"d":{"type":"integer","format":"int32"}},"title":"Price"},"price":{"type":"string"},"last_modified_ledger":{"type":"integer","format":"uint32","title":"last_modified_ledger"},"last_modified_time":{"type":"string"},"sponser":{"type":"string"}},"required":["id","paging_token","seller","selling","buying","amount","price_r","price","last_modified_ledger","last_modified_time"]}}}}},"title":"Offer"}]},"examples":{"RetrieveAnAccountsOffers":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K/offers?cursor=&limit=10&order=asc"},"next":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K/offers?cursor=164943216&limit=10&order=asc"},"prev":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K/offers?cursor=164555927&limit=10&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/offers/164555927"},"offer_maker":{"href":"https://horizon.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://horizon.stellar.org/offers/164943216"},"offer_maker":{"href":"https://horizon.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"}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/accounts/{account_id}/offers","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve an Account's Offers","description":{"content":"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.","type":"text/plain"},"url":{"path":["accounts",":account_id","offers"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) This account’s public key encoded in a base32 string representation.","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/get-operations-by-account-id.api.mdx b/api/horizon/resources/get-operations-by-account-id.api.mdx index fec92914e..b4d80bb1b 100644 --- a/api/horizon/resources/get-operations-by-account-id.api.mdx +++ b/api/horizon/resources/get-operations-by-account-id.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint represents successful operations for a given account sidebar_label: "Retrieve an Account's Operations" hide_title: true hide_table_of_contents: true -api: {"tags":["Accounts"],"description":"This endpoint represents successful operations for a given account and can be used in streaming mode. Streaming mode allows you to listen for new operations for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known operation unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream operations created since your request time.","operationId":"GetOperationsByAccountId","parameters":[{"name":"account_id","in":"path","required":true,"description":"This account’s public key encoded in a base32 string representation.","schema":{"type":"string","example":"GDMQQNJM4UL7QIA66P7R2PZHMQINWZBM77BEBMHLFXD5JEUAHGJ7R4JZ"}},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}},{"name":"include_failed","in":"query","required":false,"description":"Set to true to include failed operations in results. Options include true and false.","schema":{"type":"boolean","enum":[true,false]}},{"name":"join","in":"query","required":false,"description":"Set to transactions to include the transactions which created each of the operations in the response."}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"oneOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"create_account"},"type_i":{"type":"number","example":0},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"starting_balance":{"type":"string"},"funder":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","starting_balance","funder","account"],"title":"CreateAccount"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"payment"},"type_i":{"type":"string"},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string"},"asset_code":{"enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","asset_type","from","to","amount"]}}}}},"title":"Payment"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"path_payment_strict_receive"},"type_i":{"type":"number","example":2},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"},"path":{"type":"array","items":{"type":"object","properties":{"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}}}},"source_amount":{"type":"string"},"destination_min":{"type":"string"},"source_asset_type":{"type":"string"},"source_asset_code":{"type":"string"},"source_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","from","to","amount","path","source_amount","destination_min"],"title":"PathPaymentStrictReceive"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"path_payment_strict_send"},"type_i":{"type":"number","example":13},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"},"path":{"type":"array","items":{"type":"object","properties":{"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}}}},"source_amount":{"type":"string"},"source_max":{"type":"string"},"source_asset_type":{"type":"string"},"source_asset_code":{"type":"string"},"source_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","from","to","amount","path","source_amount","source_asset_type"],"title":"PathPaymentStrictSend"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"account_merge"},"type_i":{"type":"number","example":8},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"into":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","account","into"],"title":"AccountMerge"}]}]},"examples":{"RetrieveAnAccountsOperations":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/accounts/GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA/operations?cursor=&limit=10&order=asc"},"next":{"href":"https://horizon.stellar.org/accounts/GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA/operations?cursor=120194466505179137&limit=10&order=asc"},"prev":{"href":"https://horizon.stellar.org/accounts/GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA/operations?cursor=120192344791343105&limit=10&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120192344791343105"},"transaction":{"href":"https://horizon.stellar.org/transactions/ef0fe04ac3c7de7228ca2598886059868ad05c224a041e8b2d9ee2a8a9dd6894"},"effects":{"href":"https://horizon.stellar.org/operations/120192344791343105/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120192344791343105"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120192344791343105"}},"id":"120192344791343105","paging_token":"120192344791343105","transaction_successful":true,"source_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","type":"create_account","type_i":0,"created_at":"2020-01-29T19:43:59Z","transaction_hash":"ef0fe04ac3c7de7228ca2598886059868ad05c224a041e8b2d9ee2a8a9dd6894","starting_balance":"2.0000000","funder":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","account":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120192370561220609"},"transaction":{"href":"https://horizon.stellar.org/transactions/c1cb850f413e4038c4120bd9badc07bb8ef85a46649a4d5c9c16e578a2d30589"},"effects":{"href":"https://horizon.stellar.org/operations/120192370561220609/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120192370561220609"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120192370561220609"}},"id":"120192370561220609","paging_token":"120192370561220609","transaction_successful":true,"source_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","type":"payment","type_i":1,"created_at":"2020-01-29T19:44:36Z","transaction_hash":"c1cb850f413e4038c4120bd9badc07bb8ef85a46649a4d5c9c16e578a2d30589","asset_type":"native","from":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","to":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA","amount":"200.0000000"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120192452165550081"},"transaction":{"href":"https://horizon.stellar.org/transactions/0e6bc30f2b2f50ca0ecedef5a527309c74964e7daa6018976cd2c686c5df4be3"},"effects":{"href":"https://horizon.stellar.org/operations/120192452165550081/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120192452165550081"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120192452165550081"}},"id":"120192452165550081","paging_token":"120192452165550081","transaction_successful":true,"source_account":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA","type":"change_trust","type_i":6,"created_at":"2020-01-29T19:46:20Z","transaction_hash":"0e6bc30f2b2f50ca0ecedef5a527309c74964e7daa6018976cd2c686c5df4be3","asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","limit":"922337203685.4775807","trustee":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","trustor":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120192477935251457"},"transaction":{"href":"https://horizon.stellar.org/transactions/ec4116595bdfa8c1039c40af425e497c91fcf387c2a2a0cfa1f3bf64733f1f23"},"effects":{"href":"https://horizon.stellar.org/operations/120192477935251457/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120192477935251457"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120192477935251457"}},"id":"120192477935251457","paging_token":"120192477935251457","transaction_successful":true,"source_account":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA","type":"change_trust","type_i":6,"created_at":"2020-01-29T19:46:55Z","transaction_hash":"ec4116595bdfa8c1039c40af425e497c91fcf387c2a2a0cfa1f3bf64733f1f23","asset_type":"credit_alphanum4","asset_code":"NGNT","asset_issuer":"GAWODAROMJ33V5YDFY3NPYTHVYQG7MJXVJ2ND3AOGIHYRWINES6ACCPD","limit":"922337203685.4775807","trustee":"GAWODAROMJ33V5YDFY3NPYTHVYQG7MJXVJ2ND3AOGIHYRWINES6ACCPD","trustor":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120192490820268033"},"transaction":{"href":"https://horizon.stellar.org/transactions/81f2b857cb47d7c63ca12e2ec3466f6f17b4990bf492ef752c9c6d2035ca11ff"},"effects":{"href":"https://horizon.stellar.org/operations/120192490820268033/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120192490820268033"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120192490820268033"}},"id":"120192490820268033","paging_token":"120192490820268033","transaction_successful":true,"source_account":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA","type":"change_trust","type_i":6,"created_at":"2020-01-29T19:47:11Z","transaction_hash":"81f2b857cb47d7c63ca12e2ec3466f6f17b4990bf492ef752c9c6d2035ca11ff","asset_type":"credit_alphanum4","asset_code":"EURT","asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","limit":"922337203685.4775807","trustee":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","trustor":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120192499410071553"},"transaction":{"href":"https://horizon.stellar.org/transactions/34b28df891c6a09968a2f0a6b410300b08b09c5f58cd12fe64fda59d29688f6e"},"effects":{"href":"https://horizon.stellar.org/operations/120192499410071553/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120192499410071553"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120192499410071553"}},"id":"120192499410071553","paging_token":"120192499410071553","transaction_successful":true,"source_account":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA","type":"change_trust","type_i":6,"created_at":"2020-01-29T19:47:22Z","transaction_hash":"34b28df891c6a09968a2f0a6b410300b08b09c5f58cd12fe64fda59d29688f6e","asset_type":"credit_alphanum4","asset_code":"BB1","asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","limit":"922337203685.4775807","trustee":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","trustor":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120192508000047105"},"transaction":{"href":"https://horizon.stellar.org/transactions/12a8e8f11a697ee06a092eb0700c2b713fe07d29ffab190988d5bb248caf1917"},"effects":{"href":"https://horizon.stellar.org/operations/120192508000047105/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120192508000047105"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120192508000047105"}},"id":"120192508000047105","paging_token":"120192508000047105","transaction_successful":true,"source_account":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA","type":"change_trust","type_i":6,"created_at":"2020-01-29T19:47:33Z","transaction_hash":"12a8e8f11a697ee06a092eb0700c2b713fe07d29ffab190988d5bb248caf1917","asset_type":"credit_alphanum4","asset_code":"CNY","asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","limit":"922337203685.4775807","trustee":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","trustor":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120192542359883777"},"transaction":{"href":"https://horizon.stellar.org/transactions/36b9c9aa3c4a22a1e8274f69b1bbfdd5764e55b80804a8d9c6b35c14e4147580"},"effects":{"href":"https://horizon.stellar.org/operations/120192542359883777/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120192542359883777"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120192542359883777"}},"id":"120192542359883777","paging_token":"120192542359883777","transaction_successful":true,"source_account":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA","type":"manage_buy_offer","type_i":12,"created_at":"2020-01-29T19:48:16Z","transaction_hash":"36b9c9aa3c4a22a1e8274f69b1bbfdd5764e55b80804a8d9c6b35c14e4147580","amount":"3.0000000","price":"18.1088911","price_r":{"n":181088911,"d":10000000},"buying_asset_type":"credit_alphanum4","buying_asset_code":"EURT","buying_asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","selling_asset_type":"native","offer_id":"0"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120192568129794049"},"transaction":{"href":"https://horizon.stellar.org/transactions/f0362887d2b9b853e7b464b174adfceb4c73ffb6a45e10b7cb3bff9cfa808340"},"effects":{"href":"https://horizon.stellar.org/operations/120192568129794049/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120192568129794049"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120192568129794049"}},"id":"120192568129794049","paging_token":"120192568129794049","transaction_successful":true,"source_account":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA","type":"manage_buy_offer","type_i":12,"created_at":"2020-01-29T19:48:54Z","transaction_hash":"f0362887d2b9b853e7b464b174adfceb4c73ffb6a45e10b7cb3bff9cfa808340","amount":"200.0000000","price":"0.0459893","price_r":{"n":459893,"d":10000000},"buying_asset_type":"credit_alphanum4","buying_asset_code":"NGNT","buying_asset_issuer":"GAWODAROMJ33V5YDFY3NPYTHVYQG7MJXVJ2ND3AOGIHYRWINES6ACCPD","selling_asset_type":"native","offer_id":"0"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120194466505179137"},"transaction":{"href":"https://horizon.stellar.org/transactions/a470f40ba0c1fd17cb957e0b438bd873b110ffb808b8133a5144cea3f5a66d0d"},"effects":{"href":"https://horizon.stellar.org/operations/120194466505179137/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120194466505179137"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120194466505179137"}},"id":"120194466505179137","paging_token":"120194466505179137","transaction_successful":true,"source_account":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA","type":"change_trust","type_i":6,"created_at":"2020-01-29T20:31:28Z","transaction_hash":"a470f40ba0c1fd17cb957e0b438bd873b110ffb808b8133a5144cea3f5a66d0d","asset_type":"credit_alphanum4","asset_code":"CNY","asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","limit":"0.0000000","trustee":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","trustor":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA"}]}}}}}}}},"method":"get","path":"/accounts/{account_id}/operations","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve an Account's Operations","description":{"content":"This endpoint represents successful operations for a given account and can be used in streaming mode. Streaming mode allows you to listen for new operations for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known operation unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream operations created since your request time.","type":"text/plain"},"url":{"path":["accounts",":account_id","operations"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Set to true to include failed operations in results. Options include true and false.","type":"text/plain"},"key":"include_failed","value":""},{"description":{"content":"Set to transactions to include the transactions which created each of the operations in the response.","type":"text/plain"},"key":"join","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) This account’s public key encoded in a base32 string representation.","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Accounts"],"description":"This endpoint represents successful operations for a given account and can be used in streaming mode. Streaming mode allows you to listen for new operations for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known operation unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream operations created since your request time.","operationId":"GetOperationsByAccountId","parameters":[{"name":"account_id","in":"path","required":true,"description":"This account’s public key encoded in a base32 string representation.","schema":{"type":"string","example":"GDMQQNJM4UL7QIA66P7R2PZHMQINWZBM77BEBMHLFXD5JEUAHGJ7R4JZ"}},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}},{"name":"include_failed","in":"query","required":false,"description":"Set to true to include failed operations in results. Options include true and false.","schema":{"type":"boolean","enum":[true,false]}},{"name":"join","in":"query","required":false,"description":"Set to transactions to include the transactions which created each of the operations in the response."}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"oneOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"create_account"},"type_i":{"type":"number","example":0},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"starting_balance":{"type":"string"},"funder":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","starting_balance","funder","account"],"title":"CreateAccount"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"payment"},"type_i":{"type":"string"},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string"},"asset_code":{"enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","asset_type","from","to","amount"]}}}}},"title":"Payment"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"path_payment_strict_receive"},"type_i":{"type":"number","example":2},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"},"path":{"type":"array","items":{"type":"object","properties":{"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}}}},"source_amount":{"type":"string"},"destination_min":{"type":"string"},"source_asset_type":{"type":"string"},"source_asset_code":{"type":"string"},"source_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","from","to","amount","path","source_amount","destination_min"],"title":"PathPaymentStrictReceive"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"path_payment_strict_send"},"type_i":{"type":"number","example":13},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"},"path":{"type":"array","items":{"type":"object","properties":{"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}}}},"source_amount":{"type":"string"},"source_max":{"type":"string"},"source_asset_type":{"type":"string"},"source_asset_code":{"type":"string"},"source_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","from","to","amount","path","source_amount","source_asset_type"],"title":"PathPaymentStrictSend"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"account_merge"},"type_i":{"type":"number","example":8},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"into":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","account","into"],"title":"AccountMerge"}]}]},"examples":{"RetrieveAnAccountsOperations":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/accounts/GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA/operations?cursor=&limit=10&order=asc"},"next":{"href":"https://horizon.stellar.org/accounts/GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA/operations?cursor=120194466505179137&limit=10&order=asc"},"prev":{"href":"https://horizon.stellar.org/accounts/GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA/operations?cursor=120192344791343105&limit=10&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120192344791343105"},"transaction":{"href":"https://horizon.stellar.org/transactions/ef0fe04ac3c7de7228ca2598886059868ad05c224a041e8b2d9ee2a8a9dd6894"},"effects":{"href":"https://horizon.stellar.org/operations/120192344791343105/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120192344791343105"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120192344791343105"}},"id":"120192344791343105","paging_token":"120192344791343105","transaction_successful":true,"source_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","type":"create_account","type_i":0,"created_at":"2020-01-29T19:43:59Z","transaction_hash":"ef0fe04ac3c7de7228ca2598886059868ad05c224a041e8b2d9ee2a8a9dd6894","starting_balance":"2.0000000","funder":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","account":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120192370561220609"},"transaction":{"href":"https://horizon.stellar.org/transactions/c1cb850f413e4038c4120bd9badc07bb8ef85a46649a4d5c9c16e578a2d30589"},"effects":{"href":"https://horizon.stellar.org/operations/120192370561220609/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120192370561220609"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120192370561220609"}},"id":"120192370561220609","paging_token":"120192370561220609","transaction_successful":true,"source_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","type":"payment","type_i":1,"created_at":"2020-01-29T19:44:36Z","transaction_hash":"c1cb850f413e4038c4120bd9badc07bb8ef85a46649a4d5c9c16e578a2d30589","asset_type":"native","from":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","to":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA","amount":"200.0000000"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120192452165550081"},"transaction":{"href":"https://horizon.stellar.org/transactions/0e6bc30f2b2f50ca0ecedef5a527309c74964e7daa6018976cd2c686c5df4be3"},"effects":{"href":"https://horizon.stellar.org/operations/120192452165550081/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120192452165550081"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120192452165550081"}},"id":"120192452165550081","paging_token":"120192452165550081","transaction_successful":true,"source_account":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA","type":"change_trust","type_i":6,"created_at":"2020-01-29T19:46:20Z","transaction_hash":"0e6bc30f2b2f50ca0ecedef5a527309c74964e7daa6018976cd2c686c5df4be3","asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","limit":"922337203685.4775807","trustee":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","trustor":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120192477935251457"},"transaction":{"href":"https://horizon.stellar.org/transactions/ec4116595bdfa8c1039c40af425e497c91fcf387c2a2a0cfa1f3bf64733f1f23"},"effects":{"href":"https://horizon.stellar.org/operations/120192477935251457/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120192477935251457"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120192477935251457"}},"id":"120192477935251457","paging_token":"120192477935251457","transaction_successful":true,"source_account":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA","type":"change_trust","type_i":6,"created_at":"2020-01-29T19:46:55Z","transaction_hash":"ec4116595bdfa8c1039c40af425e497c91fcf387c2a2a0cfa1f3bf64733f1f23","asset_type":"credit_alphanum4","asset_code":"NGNT","asset_issuer":"GAWODAROMJ33V5YDFY3NPYTHVYQG7MJXVJ2ND3AOGIHYRWINES6ACCPD","limit":"922337203685.4775807","trustee":"GAWODAROMJ33V5YDFY3NPYTHVYQG7MJXVJ2ND3AOGIHYRWINES6ACCPD","trustor":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120192490820268033"},"transaction":{"href":"https://horizon.stellar.org/transactions/81f2b857cb47d7c63ca12e2ec3466f6f17b4990bf492ef752c9c6d2035ca11ff"},"effects":{"href":"https://horizon.stellar.org/operations/120192490820268033/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120192490820268033"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120192490820268033"}},"id":"120192490820268033","paging_token":"120192490820268033","transaction_successful":true,"source_account":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA","type":"change_trust","type_i":6,"created_at":"2020-01-29T19:47:11Z","transaction_hash":"81f2b857cb47d7c63ca12e2ec3466f6f17b4990bf492ef752c9c6d2035ca11ff","asset_type":"credit_alphanum4","asset_code":"EURT","asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","limit":"922337203685.4775807","trustee":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","trustor":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120192499410071553"},"transaction":{"href":"https://horizon.stellar.org/transactions/34b28df891c6a09968a2f0a6b410300b08b09c5f58cd12fe64fda59d29688f6e"},"effects":{"href":"https://horizon.stellar.org/operations/120192499410071553/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120192499410071553"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120192499410071553"}},"id":"120192499410071553","paging_token":"120192499410071553","transaction_successful":true,"source_account":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA","type":"change_trust","type_i":6,"created_at":"2020-01-29T19:47:22Z","transaction_hash":"34b28df891c6a09968a2f0a6b410300b08b09c5f58cd12fe64fda59d29688f6e","asset_type":"credit_alphanum4","asset_code":"BB1","asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","limit":"922337203685.4775807","trustee":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","trustor":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120192508000047105"},"transaction":{"href":"https://horizon.stellar.org/transactions/12a8e8f11a697ee06a092eb0700c2b713fe07d29ffab190988d5bb248caf1917"},"effects":{"href":"https://horizon.stellar.org/operations/120192508000047105/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120192508000047105"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120192508000047105"}},"id":"120192508000047105","paging_token":"120192508000047105","transaction_successful":true,"source_account":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA","type":"change_trust","type_i":6,"created_at":"2020-01-29T19:47:33Z","transaction_hash":"12a8e8f11a697ee06a092eb0700c2b713fe07d29ffab190988d5bb248caf1917","asset_type":"credit_alphanum4","asset_code":"CNY","asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","limit":"922337203685.4775807","trustee":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","trustor":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120192542359883777"},"transaction":{"href":"https://horizon.stellar.org/transactions/36b9c9aa3c4a22a1e8274f69b1bbfdd5764e55b80804a8d9c6b35c14e4147580"},"effects":{"href":"https://horizon.stellar.org/operations/120192542359883777/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120192542359883777"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120192542359883777"}},"id":"120192542359883777","paging_token":"120192542359883777","transaction_successful":true,"source_account":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA","type":"manage_buy_offer","type_i":12,"created_at":"2020-01-29T19:48:16Z","transaction_hash":"36b9c9aa3c4a22a1e8274f69b1bbfdd5764e55b80804a8d9c6b35c14e4147580","amount":"3.0000000","price":"18.1088911","price_r":{"n":181088911,"d":10000000},"buying_asset_type":"credit_alphanum4","buying_asset_code":"EURT","buying_asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","selling_asset_type":"native","offer_id":"0"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120192568129794049"},"transaction":{"href":"https://horizon.stellar.org/transactions/f0362887d2b9b853e7b464b174adfceb4c73ffb6a45e10b7cb3bff9cfa808340"},"effects":{"href":"https://horizon.stellar.org/operations/120192568129794049/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120192568129794049"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120192568129794049"}},"id":"120192568129794049","paging_token":"120192568129794049","transaction_successful":true,"source_account":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA","type":"manage_buy_offer","type_i":12,"created_at":"2020-01-29T19:48:54Z","transaction_hash":"f0362887d2b9b853e7b464b174adfceb4c73ffb6a45e10b7cb3bff9cfa808340","amount":"200.0000000","price":"0.0459893","price_r":{"n":459893,"d":10000000},"buying_asset_type":"credit_alphanum4","buying_asset_code":"NGNT","buying_asset_issuer":"GAWODAROMJ33V5YDFY3NPYTHVYQG7MJXVJ2ND3AOGIHYRWINES6ACCPD","selling_asset_type":"native","offer_id":"0"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120194466505179137"},"transaction":{"href":"https://horizon.stellar.org/transactions/a470f40ba0c1fd17cb957e0b438bd873b110ffb808b8133a5144cea3f5a66d0d"},"effects":{"href":"https://horizon.stellar.org/operations/120194466505179137/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120194466505179137"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120194466505179137"}},"id":"120194466505179137","paging_token":"120194466505179137","transaction_successful":true,"source_account":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA","type":"change_trust","type_i":6,"created_at":"2020-01-29T20:31:28Z","transaction_hash":"a470f40ba0c1fd17cb957e0b438bd873b110ffb808b8133a5144cea3f5a66d0d","asset_type":"credit_alphanum4","asset_code":"CNY","asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","limit":"0.0000000","trustee":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","trustor":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA"}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/accounts/{account_id}/operations","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve an Account's Operations","description":{"content":"This endpoint represents successful operations for a given account and can be used in streaming mode. Streaming mode allows you to listen for new operations for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known operation unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream operations created since your request time.","type":"text/plain"},"url":{"path":["accounts",":account_id","operations"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Set to true to include failed operations in results. Options include true and false.","type":"text/plain"},"key":"include_failed","value":""},{"description":{"content":"Set to transactions to include the transactions which created each of the operations in the response.","type":"text/plain"},"key":"join","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) This account’s public key encoded in a base32 string representation.","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/get-payments-by-account-id.api.mdx b/api/horizon/resources/get-payments-by-account-id.api.mdx index 4386cf1b6..20cb0f467 100644 --- a/api/horizon/resources/get-payments-by-account-id.api.mdx +++ b/api/horizon/resources/get-payments-by-account-id.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint represents successful payments for a given account a sidebar_label: "Retrieve an Account's Payments" hide_title: true hide_table_of_contents: true -api: {"tags":["Accounts"],"description":"This endpoint represents successful payments for a given account and can be used in streaming mode. Streaming mode allows you to listen for new payments for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known payment unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream payments created since your request time.","operationId":"GetPaymentsByAccountId","parameters":[{"name":"account_id","in":"path","required":true,"description":"This account’s public key encoded in a base32 string representation.","schema":{"type":"string","example":"GDMQQNJM4UL7QIA66P7R2PZHMQINWZBM77BEBMHLFXD5JEUAHGJ7R4JZ"}},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}},{"name":"include_failed","in":"query","required":false,"description":"Set to true to include failed operations in results. Options include true and false.","schema":{"type":"boolean","enum":[true,false]}},{"name":"join","in":"query","required":false,"description":"Set to transactions to include the transactions which created each of the operations in the response."}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"payment"},"type_i":{"type":"string"},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string"},"asset_code":{"enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","asset_type","from","to","amount"]}}}}},"title":"Payment"}]},"examples":{"RetrieveAnAccountsPayments":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/accounts/GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE/payments?cursor=&limit=10&order=asc"},"next":{"href":"https://horizon.stellar.org/accounts/GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE/payments?cursor=148289273518190684&limit=10&order=asc"},"prev":{"href":"https://horizon.stellar.org/accounts/GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE/payments?cursor=110694007436259329&limit=10&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/operations/110694007436259329"},"transaction":{"href":"https://horizon.stellar.org/transactions/26c996aa6afb299b6761f2335277196715160ade6aa001a755116448b145d3a7"},"effects":{"href":"https://horizon.stellar.org/operations/110694007436259329/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=110694007436259329"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=110694007436259329"}},"id":"110694007436259329","paging_token":"110694007436259329","transaction_successful":true,"source_account":"GB44UMO65PK5NWMRP4S2OSZA5BD4ACOW5KQ6TWLLO2MP7S7N5MJ2MJVI","type":"create_account","type_i":0,"created_at":"2019-09-11T13:16:44Z","transaction_hash":"26c996aa6afb299b6761f2335277196715160ade6aa001a755116448b145d3a7","starting_balance":"1.0000000","funder":"GB44UMO65PK5NWMRP4S2OSZA5BD4ACOW5KQ6TWLLO2MP7S7N5MJ2MJVI","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/110694007436259330"},"transaction":{"href":"https://horizon.stellar.org/transactions/26c996aa6afb299b6761f2335277196715160ade6aa001a755116448b145d3a7"},"effects":{"href":"https://horizon.stellar.org/operations/110694007436259330/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=110694007436259330"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=110694007436259330"}},"id":"110694007436259330","paging_token":"110694007436259330","transaction_successful":true,"source_account":"GB44UMO65PK5NWMRP4S2OSZA5BD4ACOW5KQ6TWLLO2MP7S7N5MJ2MJVI","type":"account_merge","type_i":8,"created_at":"2019-09-11T13:16:44Z","transaction_hash":"26c996aa6afb299b6761f2335277196715160ade6aa001a755116448b145d3a7","account":"GB44UMO65PK5NWMRP4S2OSZA5BD4ACOW5KQ6TWLLO2MP7S7N5MJ2MJVI","into":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/115354197276323841"},"transaction":{"href":"https://horizon.stellar.org/transactions/c09d4cee993d60d73c80f036666966738a26b8f3b25d7275b93fd995505b5e5b"},"effects":{"href":"https://horizon.stellar.org/operations/115354197276323841/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=115354197276323841"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=115354197276323841"}},"id":"115354197276323841","paging_token":"115354197276323841","transaction_successful":true,"source_account":"GDV4KECLSZLKRVH4ZTWVAS4I3W2LPAPV66ADFFUZKGIVOTK6GMKGJT53","type":"payment","type_i":1,"created_at":"2019-11-18T19:59:40Z","transaction_hash":"c09d4cee993d60d73c80f036666966738a26b8f3b25d7275b93fd995505b5e5b","asset_type":"native","from":"GDV4KECLSZLKRVH4ZTWVAS4I3W2LPAPV66ADFFUZKGIVOTK6GMKGJT53","to":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","amount":"688.4065454"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/117356420835532801"},"transaction":{"href":"https://horizon.stellar.org/transactions/c25dd84798076ee8ea126c78407d61c7e8f3efdf8739274f56b07a7029500b00"},"effects":{"href":"https://horizon.stellar.org/operations/117356420835532801/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=117356420835532801"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=117356420835532801"}},"id":"117356420835532801","paging_token":"117356420835532801","transaction_successful":true,"source_account":"GDV4KECLSZLKRVH4ZTWVAS4I3W2LPAPV66ADFFUZKGIVOTK6GMKGJT53","type":"payment","type_i":1,"created_at":"2019-12-18T08:23:35Z","transaction_hash":"c25dd84798076ee8ea126c78407d61c7e8f3efdf8739274f56b07a7029500b00","asset_type":"native","from":"GDV4KECLSZLKRVH4ZTWVAS4I3W2LPAPV66ADFFUZKGIVOTK6GMKGJT53","to":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","amount":"355.3887598"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/119400713599217665"},"transaction":{"href":"https://horizon.stellar.org/transactions/b9d7c534b5fa168570a5bffe0f2089de150d00bf8cbd19ec93e897c565958f3f"},"effects":{"href":"https://horizon.stellar.org/operations/119400713599217665/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=119400713599217665"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=119400713599217665"}},"id":"119400713599217665","paging_token":"119400713599217665","transaction_successful":true,"source_account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"payment","type_i":1,"created_at":"2020-01-17T20:32:38Z","transaction_hash":"b9d7c534b5fa168570a5bffe0f2089de150d00bf8cbd19ec93e897c565958f3f","asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","from":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","to":"GASWJWFRYE55KC7MGANZMMRBK5NPXT3HMPDQ6SEXZN6ZPWYXVVYBFRTE","amount":"84.9410878"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/147350483860869151"},"transaction":{"href":"https://horizon.stellar.org/transactions/b53cd1d3a95ad2fd7141b3b800e8cd3af1658d2d72b2274d1bd116cf0e58f193"},"effects":{"href":"https://horizon.stellar.org/operations/147350483860869151/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=147350483860869151"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=147350483860869151"}},"id":"147350483860869151","paging_token":"147350483860869151","transaction_successful":true,"source_account":"GBDSJHAGNQDL2WZ5LBRSIVI6MUHJO6CLKF5XFVUK7GMPUQ4NBLSYVAHX","type":"payment","type_i":1,"created_at":"2021-03-06T19:27:33Z","transaction_hash":"b53cd1d3a95ad2fd7141b3b800e8cd3af1658d2d72b2274d1bd116cf0e58f193","asset_type":"native","from":"GBDSJHAGNQDL2WZ5LBRSIVI6MUHJO6CLKF5XFVUK7GMPUQ4NBLSYVAHX","to":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","amount":"0.0000001"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/147354181828010015"},"transaction":{"href":"https://horizon.stellar.org/transactions/1be9f5f3dcd28c4fa70f5f5ed79d7332da14741e55a5abe4132d4c04da7b6f1e"},"effects":{"href":"https://horizon.stellar.org/operations/147354181828010015/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=147354181828010015"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=147354181828010015"}},"id":"147354181828010015","paging_token":"147354181828010015","transaction_successful":true,"source_account":"GCVZ5PHDFGUV6YXN7I735RE5AJSFOOWPT4A2WHCGTGXOQ6KVWM3TYEQC","type":"payment","type_i":1,"created_at":"2021-03-06T20:49:34Z","transaction_hash":"1be9f5f3dcd28c4fa70f5f5ed79d7332da14741e55a5abe4132d4c04da7b6f1e","asset_type":"native","from":"GCVZ5PHDFGUV6YXN7I735RE5AJSFOOWPT4A2WHCGTGXOQ6KVWM3TYEQC","to":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","amount":"0.0000001"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/147355590577238047"},"transaction":{"href":"https://horizon.stellar.org/transactions/ba6bca6dce0c01d9d9cebcc79466c986b18a8cb3b67030f6424b6563778ab947"},"effects":{"href":"https://horizon.stellar.org/operations/147355590577238047/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=147355590577238047"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=147355590577238047"}},"id":"147355590577238047","paging_token":"147355590577238047","transaction_successful":true,"source_account":"GBDSJHAGNQDL2WZ5LBRSIVI6MUHJO6CLKF5XFVUK7GMPUQ4NBLSYVAHX","type":"payment","type_i":1,"created_at":"2021-03-06T21:19:49Z","transaction_hash":"ba6bca6dce0c01d9d9cebcc79466c986b18a8cb3b67030f6424b6563778ab947","asset_type":"native","from":"GBDSJHAGNQDL2WZ5LBRSIVI6MUHJO6CLKF5XFVUK7GMPUQ4NBLSYVAHX","to":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","amount":"0.0000001"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/148286782436462682"},"transaction":{"href":"https://horizon.stellar.org/transactions/74afe177a6ecf466899bbdbd339a796e1995a3c8c4084c556849a702759bb7c1"},"effects":{"href":"https://horizon.stellar.org/operations/148286782436462682/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=148286782436462682"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=148286782436462682"}},"id":"148286782436462682","paging_token":"148286782436462682","transaction_successful":true,"source_account":"GDAXCWDQAYP2VC2UR2KRLVD7JQYIYMQ7BGFY647BCG4CFANT7JYNSO4S","type":"payment","type_i":1,"created_at":"2021-03-20T12:48:24Z","transaction_hash":"74afe177a6ecf466899bbdbd339a796e1995a3c8c4084c556849a702759bb7c1","asset_type":"native","from":"GDAXCWDQAYP2VC2UR2KRLVD7JQYIYMQ7BGFY647BCG4CFANT7JYNSO4S","to":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","amount":"0.0000001"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/148289273518190684"},"transaction":{"href":"https://horizon.stellar.org/transactions/de50646ece611a9fbd2b222b910f020f94e654064d64fd54f50358d3d13e7f49"},"effects":{"href":"https://horizon.stellar.org/operations/148289273518190684/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=148289273518190684"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=148289273518190684"}},"id":"148289273518190684","paging_token":"148289273518190684","transaction_successful":true,"source_account":"GC2LS7Z564TGWRVCIHTSEIZBO5WUZSNR2MA544FE4JPXMAUMDQI2JR6N","type":"payment","type_i":1,"created_at":"2021-03-20T13:42:07Z","transaction_hash":"de50646ece611a9fbd2b222b910f020f94e654064d64fd54f50358d3d13e7f49","asset_type":"native","from":"GC2LS7Z564TGWRVCIHTSEIZBO5WUZSNR2MA544FE4JPXMAUMDQI2JR6N","to":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","amount":"0.0000001"}]}}}}}}}},"method":"get","path":"/accounts/{account_id}/payments","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve an Account's Payments","description":{"content":"This endpoint represents successful payments for a given account and can be used in streaming mode. Streaming mode allows you to listen for new payments for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known payment unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream payments created since your request time.","type":"text/plain"},"url":{"path":["accounts",":account_id","payments"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Set to true to include failed operations in results. Options include true and false.","type":"text/plain"},"key":"include_failed","value":""},{"description":{"content":"Set to transactions to include the transactions which created each of the operations in the response.","type":"text/plain"},"key":"join","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) This account’s public key encoded in a base32 string representation.","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Accounts"],"description":"This endpoint represents successful payments for a given account and can be used in streaming mode. Streaming mode allows you to listen for new payments for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known payment unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream payments created since your request time.","operationId":"GetPaymentsByAccountId","parameters":[{"name":"account_id","in":"path","required":true,"description":"This account’s public key encoded in a base32 string representation.","schema":{"type":"string","example":"GDMQQNJM4UL7QIA66P7R2PZHMQINWZBM77BEBMHLFXD5JEUAHGJ7R4JZ"}},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}},{"name":"include_failed","in":"query","required":false,"description":"Set to true to include failed operations in results. Options include true and false.","schema":{"type":"boolean","enum":[true,false]}},{"name":"join","in":"query","required":false,"description":"Set to transactions to include the transactions which created each of the operations in the response."}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"payment"},"type_i":{"type":"string"},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string"},"asset_code":{"enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","asset_type","from","to","amount"]}}}}},"title":"Payment"}]},"examples":{"RetrieveAnAccountsPayments":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/accounts/GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE/payments?cursor=&limit=10&order=asc"},"next":{"href":"https://horizon.stellar.org/accounts/GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE/payments?cursor=148289273518190684&limit=10&order=asc"},"prev":{"href":"https://horizon.stellar.org/accounts/GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE/payments?cursor=110694007436259329&limit=10&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/operations/110694007436259329"},"transaction":{"href":"https://horizon.stellar.org/transactions/26c996aa6afb299b6761f2335277196715160ade6aa001a755116448b145d3a7"},"effects":{"href":"https://horizon.stellar.org/operations/110694007436259329/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=110694007436259329"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=110694007436259329"}},"id":"110694007436259329","paging_token":"110694007436259329","transaction_successful":true,"source_account":"GB44UMO65PK5NWMRP4S2OSZA5BD4ACOW5KQ6TWLLO2MP7S7N5MJ2MJVI","type":"create_account","type_i":0,"created_at":"2019-09-11T13:16:44Z","transaction_hash":"26c996aa6afb299b6761f2335277196715160ade6aa001a755116448b145d3a7","starting_balance":"1.0000000","funder":"GB44UMO65PK5NWMRP4S2OSZA5BD4ACOW5KQ6TWLLO2MP7S7N5MJ2MJVI","account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/110694007436259330"},"transaction":{"href":"https://horizon.stellar.org/transactions/26c996aa6afb299b6761f2335277196715160ade6aa001a755116448b145d3a7"},"effects":{"href":"https://horizon.stellar.org/operations/110694007436259330/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=110694007436259330"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=110694007436259330"}},"id":"110694007436259330","paging_token":"110694007436259330","transaction_successful":true,"source_account":"GB44UMO65PK5NWMRP4S2OSZA5BD4ACOW5KQ6TWLLO2MP7S7N5MJ2MJVI","type":"account_merge","type_i":8,"created_at":"2019-09-11T13:16:44Z","transaction_hash":"26c996aa6afb299b6761f2335277196715160ade6aa001a755116448b145d3a7","account":"GB44UMO65PK5NWMRP4S2OSZA5BD4ACOW5KQ6TWLLO2MP7S7N5MJ2MJVI","into":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/115354197276323841"},"transaction":{"href":"https://horizon.stellar.org/transactions/c09d4cee993d60d73c80f036666966738a26b8f3b25d7275b93fd995505b5e5b"},"effects":{"href":"https://horizon.stellar.org/operations/115354197276323841/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=115354197276323841"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=115354197276323841"}},"id":"115354197276323841","paging_token":"115354197276323841","transaction_successful":true,"source_account":"GDV4KECLSZLKRVH4ZTWVAS4I3W2LPAPV66ADFFUZKGIVOTK6GMKGJT53","type":"payment","type_i":1,"created_at":"2019-11-18T19:59:40Z","transaction_hash":"c09d4cee993d60d73c80f036666966738a26b8f3b25d7275b93fd995505b5e5b","asset_type":"native","from":"GDV4KECLSZLKRVH4ZTWVAS4I3W2LPAPV66ADFFUZKGIVOTK6GMKGJT53","to":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","amount":"688.4065454"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/117356420835532801"},"transaction":{"href":"https://horizon.stellar.org/transactions/c25dd84798076ee8ea126c78407d61c7e8f3efdf8739274f56b07a7029500b00"},"effects":{"href":"https://horizon.stellar.org/operations/117356420835532801/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=117356420835532801"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=117356420835532801"}},"id":"117356420835532801","paging_token":"117356420835532801","transaction_successful":true,"source_account":"GDV4KECLSZLKRVH4ZTWVAS4I3W2LPAPV66ADFFUZKGIVOTK6GMKGJT53","type":"payment","type_i":1,"created_at":"2019-12-18T08:23:35Z","transaction_hash":"c25dd84798076ee8ea126c78407d61c7e8f3efdf8739274f56b07a7029500b00","asset_type":"native","from":"GDV4KECLSZLKRVH4ZTWVAS4I3W2LPAPV66ADFFUZKGIVOTK6GMKGJT53","to":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","amount":"355.3887598"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/119400713599217665"},"transaction":{"href":"https://horizon.stellar.org/transactions/b9d7c534b5fa168570a5bffe0f2089de150d00bf8cbd19ec93e897c565958f3f"},"effects":{"href":"https://horizon.stellar.org/operations/119400713599217665/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=119400713599217665"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=119400713599217665"}},"id":"119400713599217665","paging_token":"119400713599217665","transaction_successful":true,"source_account":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","type":"payment","type_i":1,"created_at":"2020-01-17T20:32:38Z","transaction_hash":"b9d7c534b5fa168570a5bffe0f2089de150d00bf8cbd19ec93e897c565958f3f","asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","from":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","to":"GASWJWFRYE55KC7MGANZMMRBK5NPXT3HMPDQ6SEXZN6ZPWYXVVYBFRTE","amount":"84.9410878"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/147350483860869151"},"transaction":{"href":"https://horizon.stellar.org/transactions/b53cd1d3a95ad2fd7141b3b800e8cd3af1658d2d72b2274d1bd116cf0e58f193"},"effects":{"href":"https://horizon.stellar.org/operations/147350483860869151/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=147350483860869151"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=147350483860869151"}},"id":"147350483860869151","paging_token":"147350483860869151","transaction_successful":true,"source_account":"GBDSJHAGNQDL2WZ5LBRSIVI6MUHJO6CLKF5XFVUK7GMPUQ4NBLSYVAHX","type":"payment","type_i":1,"created_at":"2021-03-06T19:27:33Z","transaction_hash":"b53cd1d3a95ad2fd7141b3b800e8cd3af1658d2d72b2274d1bd116cf0e58f193","asset_type":"native","from":"GBDSJHAGNQDL2WZ5LBRSIVI6MUHJO6CLKF5XFVUK7GMPUQ4NBLSYVAHX","to":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","amount":"0.0000001"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/147354181828010015"},"transaction":{"href":"https://horizon.stellar.org/transactions/1be9f5f3dcd28c4fa70f5f5ed79d7332da14741e55a5abe4132d4c04da7b6f1e"},"effects":{"href":"https://horizon.stellar.org/operations/147354181828010015/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=147354181828010015"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=147354181828010015"}},"id":"147354181828010015","paging_token":"147354181828010015","transaction_successful":true,"source_account":"GCVZ5PHDFGUV6YXN7I735RE5AJSFOOWPT4A2WHCGTGXOQ6KVWM3TYEQC","type":"payment","type_i":1,"created_at":"2021-03-06T20:49:34Z","transaction_hash":"1be9f5f3dcd28c4fa70f5f5ed79d7332da14741e55a5abe4132d4c04da7b6f1e","asset_type":"native","from":"GCVZ5PHDFGUV6YXN7I735RE5AJSFOOWPT4A2WHCGTGXOQ6KVWM3TYEQC","to":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","amount":"0.0000001"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/147355590577238047"},"transaction":{"href":"https://horizon.stellar.org/transactions/ba6bca6dce0c01d9d9cebcc79466c986b18a8cb3b67030f6424b6563778ab947"},"effects":{"href":"https://horizon.stellar.org/operations/147355590577238047/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=147355590577238047"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=147355590577238047"}},"id":"147355590577238047","paging_token":"147355590577238047","transaction_successful":true,"source_account":"GBDSJHAGNQDL2WZ5LBRSIVI6MUHJO6CLKF5XFVUK7GMPUQ4NBLSYVAHX","type":"payment","type_i":1,"created_at":"2021-03-06T21:19:49Z","transaction_hash":"ba6bca6dce0c01d9d9cebcc79466c986b18a8cb3b67030f6424b6563778ab947","asset_type":"native","from":"GBDSJHAGNQDL2WZ5LBRSIVI6MUHJO6CLKF5XFVUK7GMPUQ4NBLSYVAHX","to":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","amount":"0.0000001"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/148286782436462682"},"transaction":{"href":"https://horizon.stellar.org/transactions/74afe177a6ecf466899bbdbd339a796e1995a3c8c4084c556849a702759bb7c1"},"effects":{"href":"https://horizon.stellar.org/operations/148286782436462682/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=148286782436462682"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=148286782436462682"}},"id":"148286782436462682","paging_token":"148286782436462682","transaction_successful":true,"source_account":"GDAXCWDQAYP2VC2UR2KRLVD7JQYIYMQ7BGFY647BCG4CFANT7JYNSO4S","type":"payment","type_i":1,"created_at":"2021-03-20T12:48:24Z","transaction_hash":"74afe177a6ecf466899bbdbd339a796e1995a3c8c4084c556849a702759bb7c1","asset_type":"native","from":"GDAXCWDQAYP2VC2UR2KRLVD7JQYIYMQ7BGFY647BCG4CFANT7JYNSO4S","to":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","amount":"0.0000001"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/148289273518190684"},"transaction":{"href":"https://horizon.stellar.org/transactions/de50646ece611a9fbd2b222b910f020f94e654064d64fd54f50358d3d13e7f49"},"effects":{"href":"https://horizon.stellar.org/operations/148289273518190684/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=148289273518190684"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=148289273518190684"}},"id":"148289273518190684","paging_token":"148289273518190684","transaction_successful":true,"source_account":"GC2LS7Z564TGWRVCIHTSEIZBO5WUZSNR2MA544FE4JPXMAUMDQI2JR6N","type":"payment","type_i":1,"created_at":"2021-03-20T13:42:07Z","transaction_hash":"de50646ece611a9fbd2b222b910f020f94e654064d64fd54f50358d3d13e7f49","asset_type":"native","from":"GC2LS7Z564TGWRVCIHTSEIZBO5WUZSNR2MA544FE4JPXMAUMDQI2JR6N","to":"GCNL55IJTH2HX26HLNIGYD2JIQLTBAQL3SVPNZA6PXK7NAVHU423WOTE","amount":"0.0000001"}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/accounts/{account_id}/payments","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve an Account's Payments","description":{"content":"This endpoint represents successful payments for a given account and can be used in streaming mode. Streaming mode allows you to listen for new payments for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known payment unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream payments created since your request time.","type":"text/plain"},"url":{"path":["accounts",":account_id","payments"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Set to true to include failed operations in results. Options include true and false.","type":"text/plain"},"key":"include_failed","value":""},{"description":{"content":"Set to transactions to include the transactions which created each of the operations in the response.","type":"text/plain"},"key":"join","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) This account’s public key encoded in a base32 string representation.","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/get-trades-by-account-id.api.mdx b/api/horizon/resources/get-trades-by-account-id.api.mdx index e95107e86..ec288015f 100644 --- a/api/horizon/resources/get-trades-by-account-id.api.mdx +++ b/api/horizon/resources/get-trades-by-account-id.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint represents all trades for a given account and can be sidebar_label: "Retrieve an Account's Trades" hide_title: true hide_table_of_contents: true -api: {"tags":["Accounts"],"description":"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.","operationId":"GetTradesByAccountId","parameters":[{"name":"account_id","in":"path","required":true,"description":"This account’s public key encoded in a base32 string representation.","schema":{"type":"string","example":"GDMQQNJM4UL7QIA66P7R2PZHMQINWZBM77BEBMHLFXD5JEUAHGJ7R4JZ"}},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"base":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"counter":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"operation":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","base","counter","operation"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string","title":"paging_token"},"ledger_close_time":{"type":"string"},"offer_id":{"type":"string"},"trade_type":{"type":"string"},"liquidity_pool_fee_bp":{"type":"number","format":"uint32"},"base_liquidity_pool_id":{"type":"string"},"base_offer_id":{"type":"string"},"base_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"base_amount":{"type":"string"},"base_asset_type":{"type":"string"},"base_asset_code":{"type":"string"},"base_asset_issuer":{"type":"string"},"counter_liquidity_pool_id":{"type":"string"},"counter_offer_id":{"type":"string"},"counter_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"counter_amount":{"type":"string"},"counter_asset_type":{"type":"string"},"counter_asset_code":{"type":"string"},"counter_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"base_is_seller":{"type":"boolean"},"price":{"required":["id","paging_token","ledger_close_time","trade_type","base_amount","base_asset_type","counter_amount","counter_asset_type","base_is_seller"],"type":"object","properties":{"n":{"type":"string"},"d":{"type":"string"}},"title":"tradePrice"}}}}}}},"title":"Trade"}]},"examples":{"RetrieveAnAccountsTrades":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K/trades?cursor=&limit=3&order=asc"},"next":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K/trades?cursor=107449584845914113-0&limit=3&order=asc"},"prev":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K/trades?cursor=107449468881756161-0&limit=3&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":""},"base":{"href":"https://horizon.stellar.org/accounts/GCO7OW5P2PP7WDN6YUDXUUOPAR4ZHJSDDCZTIAQRTRZHKQWV45WUPBWX"},"counter":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K"},"operation":{"href":"https://horizon.stellar.org/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"}},{"_links":{"self":{"href":""},"base":{"href":"https://horizon.stellar.org/accounts/GCQDOTIILRG634IRWAODTUS6H6Q7VUUNKZINBDJOXGJFR7YZ57FGYV7B"},"counter":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K"},"operation":{"href":"https://horizon.stellar.org/operations/107449486061649921"}},"id":"107449486061649921-0","paging_token":"107449486061649921-0","ledger_close_time":"2019-07-26T09:17:25Z","trade_type":"orderbook","base_offer_id":"104273938","base_account":"GCQDOTIILRG634IRWAODTUS6H6Q7VUUNKZINBDJOXGJFR7YZ57FGYV7B","base_amount":"10.0000000","base_asset_type":"native","counter_offer_id":"4719135504489037825","counter_account":"GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K","counter_amount":"1.0000000","counter_asset_type":"credit_alphanum4","counter_asset_code":"BB1","counter_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","base_is_seller":true,"price":{"n":"1","d":"10"}},{"_links":{"self":{"href":""},"base":{"href":"https://horizon.stellar.org/accounts/GAMU5TQFUMDGVKYQPPDCD2MKKUUWELSQAEKNNU4RFQCWFSRBPJA2MAGQ"},"counter":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K"},"operation":{"href":"https://horizon.stellar.org/operations/107449584845914113"}},"id":"107449584845914113-0","paging_token":"107449584845914113-0","ledger_close_time":"2019-07-26T09:19:30Z","trade_type":"orderbook","base_offer_id":"104299223","base_account":"GAMU5TQFUMDGVKYQPPDCD2MKKUUWELSQAEKNNU4RFQCWFSRBPJA2MAGQ","base_amount":"748.5338945","base_asset_type":"native","counter_offer_id":"104299548","counter_account":"GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K","counter_amount":"74.8533887","counter_asset_type":"credit_alphanum4","counter_asset_code":"BB1","counter_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","base_is_seller":true,"price":{"n":"10000000","d":"100000001"}}]}}}}}}}},"method":"get","path":"/accounts/{account_id}/trades","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve an Account's Trades","description":{"content":"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.","type":"text/plain"},"url":{"path":["accounts",":account_id","trades"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) This account’s public key encoded in a base32 string representation.","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Accounts"],"description":"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.","operationId":"GetTradesByAccountId","parameters":[{"name":"account_id","in":"path","required":true,"description":"This account’s public key encoded in a base32 string representation.","schema":{"type":"string","example":"GDMQQNJM4UL7QIA66P7R2PZHMQINWZBM77BEBMHLFXD5JEUAHGJ7R4JZ"}},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"base":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"counter":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"operation":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","base","counter","operation"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string","title":"paging_token"},"ledger_close_time":{"type":"string"},"offer_id":{"type":"string"},"trade_type":{"type":"string"},"liquidity_pool_fee_bp":{"type":"number","format":"uint32"},"base_liquidity_pool_id":{"type":"string"},"base_offer_id":{"type":"string"},"base_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"base_amount":{"type":"string"},"base_asset_type":{"type":"string"},"base_asset_code":{"type":"string"},"base_asset_issuer":{"type":"string"},"counter_liquidity_pool_id":{"type":"string"},"counter_offer_id":{"type":"string"},"counter_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"counter_amount":{"type":"string"},"counter_asset_type":{"type":"string"},"counter_asset_code":{"type":"string"},"counter_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"base_is_seller":{"type":"boolean"},"price":{"required":["id","paging_token","ledger_close_time","trade_type","base_amount","base_asset_type","counter_amount","counter_asset_type","base_is_seller"],"type":"object","properties":{"n":{"type":"string"},"d":{"type":"string"}},"title":"tradePrice"}}}}}}},"title":"Trade"}]},"examples":{"RetrieveAnAccountsTrades":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K/trades?cursor=&limit=3&order=asc"},"next":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K/trades?cursor=107449584845914113-0&limit=3&order=asc"},"prev":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K/trades?cursor=107449468881756161-0&limit=3&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":""},"base":{"href":"https://horizon.stellar.org/accounts/GCO7OW5P2PP7WDN6YUDXUUOPAR4ZHJSDDCZTIAQRTRZHKQWV45WUPBWX"},"counter":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K"},"operation":{"href":"https://horizon.stellar.org/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"}},{"_links":{"self":{"href":""},"base":{"href":"https://horizon.stellar.org/accounts/GCQDOTIILRG634IRWAODTUS6H6Q7VUUNKZINBDJOXGJFR7YZ57FGYV7B"},"counter":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K"},"operation":{"href":"https://horizon.stellar.org/operations/107449486061649921"}},"id":"107449486061649921-0","paging_token":"107449486061649921-0","ledger_close_time":"2019-07-26T09:17:25Z","trade_type":"orderbook","base_offer_id":"104273938","base_account":"GCQDOTIILRG634IRWAODTUS6H6Q7VUUNKZINBDJOXGJFR7YZ57FGYV7B","base_amount":"10.0000000","base_asset_type":"native","counter_offer_id":"4719135504489037825","counter_account":"GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K","counter_amount":"1.0000000","counter_asset_type":"credit_alphanum4","counter_asset_code":"BB1","counter_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","base_is_seller":true,"price":{"n":"1","d":"10"}},{"_links":{"self":{"href":""},"base":{"href":"https://horizon.stellar.org/accounts/GAMU5TQFUMDGVKYQPPDCD2MKKUUWELSQAEKNNU4RFQCWFSRBPJA2MAGQ"},"counter":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K"},"operation":{"href":"https://horizon.stellar.org/operations/107449584845914113"}},"id":"107449584845914113-0","paging_token":"107449584845914113-0","ledger_close_time":"2019-07-26T09:19:30Z","trade_type":"orderbook","base_offer_id":"104299223","base_account":"GAMU5TQFUMDGVKYQPPDCD2MKKUUWELSQAEKNNU4RFQCWFSRBPJA2MAGQ","base_amount":"748.5338945","base_asset_type":"native","counter_offer_id":"104299548","counter_account":"GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K","counter_amount":"74.8533887","counter_asset_type":"credit_alphanum4","counter_asset_code":"BB1","counter_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","base_is_seller":true,"price":{"n":"10000000","d":"100000001"}}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/accounts/{account_id}/trades","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve an Account's Trades","description":{"content":"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.","type":"text/plain"},"url":{"path":["accounts",":account_id","trades"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) This account’s public key encoded in a base32 string representation.","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/get-trades-by-offer-id.api.mdx b/api/horizon/resources/get-trades-by-offer-id.api.mdx index 15ba476f2..4612db6bc 100644 --- a/api/horizon/resources/get-trades-by-offer-id.api.mdx +++ b/api/horizon/resources/get-trades-by-offer-id.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint represents all trades for a given offer and can be u sidebar_label: "Retrieve an Offer's Trades" hide_title: true hide_table_of_contents: true -api: {"tags":["Offers"],"description":"This endpoint represents all trades for a given offer and can be used in streaming mode. Streaming mode allows you to listen for trades for this offer 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.","operationId":"GetTradesByOfferId","parameters":[{"name":"offer_id","in":"path","required":true,"description":"A unique identifier for this offer."},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"base":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"counter":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"operation":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","base","counter","operation"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string","title":"paging_token"},"ledger_close_time":{"type":"string"},"offer_id":{"type":"string"},"trade_type":{"type":"string"},"liquidity_pool_fee_bp":{"type":"number","format":"uint32"},"base_liquidity_pool_id":{"type":"string"},"base_offer_id":{"type":"string"},"base_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"base_amount":{"type":"string"},"base_asset_type":{"type":"string"},"base_asset_code":{"type":"string"},"base_asset_issuer":{"type":"string"},"counter_liquidity_pool_id":{"type":"string"},"counter_offer_id":{"type":"string"},"counter_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"counter_amount":{"type":"string"},"counter_asset_type":{"type":"string"},"counter_asset_code":{"type":"string"},"counter_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"base_is_seller":{"type":"boolean"},"price":{"required":["id","paging_token","ledger_close_time","trade_type","base_amount","base_asset_type","counter_amount","counter_asset_type","base_is_seller"],"type":"object","properties":{"n":{"type":"string"},"d":{"type":"string"}},"title":"tradePrice"}}}}}}},"title":"Trade"}]},"examples":{"GetTradesByOfferId":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/offers/104078276/trades?cursor=&limit=3&order=asc"},"next":{"href":"https://horizon.stellar.org/offers/104078276/trades?cursor=107449584845914113-0&limit=3&order=asc"},"prev":{"href":"https://horizon.stellar.org/offers/104078276/trades?cursor=107449468881756161-0&limit=3&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":""},"base":{"href":"https://horizon.stellar.org/accounts/GCO7OW5P2PP7WDN6YUDXUUOPAR4ZHJSDDCZTIAQRTRZHKQWV45WUPBWX"},"counter":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K"},"operation":{"href":"https://horizon.stellar.org/operations/107449468881756161"}},"id":"107449468881756161-0","paging_token":"107449468881756161-0","ledger_close_time":"2019-07-26T09:17:02Z","offer_id":"104078276","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}}]}}}}}}}},"method":"get","path":"/offers/{offer_id}/trades","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve an Offer's Trades","description":{"content":"This endpoint represents all trades for a given offer and can be used in streaming mode. Streaming mode allows you to listen for trades for this offer 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.","type":"text/plain"},"url":{"path":["offers",":offer_id","trades"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) A unique identifier for this offer.","type":"text/plain"},"type":"any","value":"","key":"offer_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Offers"],"description":"This endpoint represents all trades for a given offer and can be used in streaming mode. Streaming mode allows you to listen for trades for this offer 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.","operationId":"GetTradesByOfferId","parameters":[{"name":"offer_id","in":"path","required":true,"description":"A unique identifier for this offer."},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"base":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"counter":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"operation":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","base","counter","operation"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string","title":"paging_token"},"ledger_close_time":{"type":"string"},"offer_id":{"type":"string"},"trade_type":{"type":"string"},"liquidity_pool_fee_bp":{"type":"number","format":"uint32"},"base_liquidity_pool_id":{"type":"string"},"base_offer_id":{"type":"string"},"base_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"base_amount":{"type":"string"},"base_asset_type":{"type":"string"},"base_asset_code":{"type":"string"},"base_asset_issuer":{"type":"string"},"counter_liquidity_pool_id":{"type":"string"},"counter_offer_id":{"type":"string"},"counter_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"counter_amount":{"type":"string"},"counter_asset_type":{"type":"string"},"counter_asset_code":{"type":"string"},"counter_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"base_is_seller":{"type":"boolean"},"price":{"required":["id","paging_token","ledger_close_time","trade_type","base_amount","base_asset_type","counter_amount","counter_asset_type","base_is_seller"],"type":"object","properties":{"n":{"type":"string"},"d":{"type":"string"}},"title":"tradePrice"}}}}}}},"title":"Trade"}]},"examples":{"GetTradesByOfferId":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/offers/104078276/trades?cursor=&limit=3&order=asc"},"next":{"href":"https://horizon.stellar.org/offers/104078276/trades?cursor=107449584845914113-0&limit=3&order=asc"},"prev":{"href":"https://horizon.stellar.org/offers/104078276/trades?cursor=107449468881756161-0&limit=3&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":""},"base":{"href":"https://horizon.stellar.org/accounts/GCO7OW5P2PP7WDN6YUDXUUOPAR4ZHJSDDCZTIAQRTRZHKQWV45WUPBWX"},"counter":{"href":"https://horizon.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K"},"operation":{"href":"https://horizon.stellar.org/operations/107449468881756161"}},"id":"107449468881756161-0","paging_token":"107449468881756161-0","ledger_close_time":"2019-07-26T09:17:02Z","offer_id":"104078276","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}}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/offers/{offer_id}/trades","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve an Offer's Trades","description":{"content":"This endpoint represents all trades for a given offer and can be used in streaming mode. Streaming mode allows you to listen for trades for this offer 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.","type":"text/plain"},"url":{"path":["offers",":offer_id","trades"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) A unique identifier for this offer.","type":"text/plain"},"type":"any","value":"","key":"offer_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/get-transactions-by-account-id.api.mdx b/api/horizon/resources/get-transactions-by-account-id.api.mdx index cb15643a0..fca31e86a 100644 --- a/api/horizon/resources/get-transactions-by-account-id.api.mdx +++ b/api/horizon/resources/get-transactions-by-account-id.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint represents successful transactions for a given accou sidebar_label: "Retrieve an Account's Transactions" hide_title: true hide_table_of_contents: true -api: {"tags":["Accounts"],"description":"This endpoint represents successful transactions for a given account and can be used in streaming mode. Streaming mode allows you to listen for new transactions for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known transaction unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream transactions created since your request time.","operationId":"GetTransactionsByAccountId","parameters":[{"name":"account_id","in":"path","required":true,"description":"This account’s public key encoded in a base32 string representation.","schema":{"type":"string","example":"GDMQQNJM4UL7QIA66P7R2PZHMQINWZBM77BEBMHLFXD5JEUAHGJ7R4JZ"}},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}},{"name":"include_failed","in":"query","required":false,"description":"Set to true to include failed operations in results. Options include true and false.","schema":{"type":"boolean","enum":[true,false]}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"memo":{"type":"string"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"account":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"ledger":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"operations":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","account","ledger","operations","effects","precedes","succeeds","transaction"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"successful":{"type":"boolean"},"hash":{"type":"string"},"ledger":{"type":"integer","format":"int32"},"created_at":{"type":"string"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"account_muxed":{"type":"string"},"account_muxed_id":{"type":"string"},"source_account_sequence":{"type":"string"},"fee_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"fee_account_muxed":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"fee_account_muxed_id":{"type":"string"},"fee_charged":{"type":"string"},"max_fee":{"type":"string"},"operation_count":{"type":"integer","format":"int32"},"envelope_xdr":{"type":"string"},"result_xdr":{"type":"string"},"result_meta_xdr":{"type":"string"},"fee_meta_xdr":{"type":"string"},"memo_type":{"type":"string"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"},"valid_after":{"type":"string"},"valid_before":{"type":"string"},"preconditions":{"type":"object","properties":{"timebounds":{"type":"object","properties":{"min_time":{"type":"string"},"max_time":{"type":"string"}},"title":"TransactionPreconditionsTimebounds"},"ledgerbounds":{"type":"object","properties":{"min_ledger":{"type":"string"},"max_ledger":{"type":"string"}},"title":"TransactionPreconditionsLedgerbounds"},"min_account_sequence":{"type":"string"},"min_account_sequence_age":{"type":"string"},"min_account_sequence_ledger_gap":{"type":"integer","format":"uint32"},"extra_signers":{"type":"array","items":{"type":"string"}}},"title":"TransactionPreconditions"},"fee_bump_transaction":{"type":"object","properties":{"hash":{"type":"string","title":"hash"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"}},"title":"FeeBumpTransaction"},"inner_transaction":{"type":"object","properties":{"hash":{"type":"string","title":"hash"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"},"max_fee":{"type":"string"}},"title":"InnerTransaction"}},"required":["id","paging_token","successful","hash","ledger","created_at","source_account","source_account_sequence","fee_account","fee_charged","max_fee","operation_count","envelope_xdr","result_xdr","result_meta_xdr","memo_type","signatures"]}}}}},"title":"Transaction"}]},"examples":{"RetrieveAnAccountsTransactions":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/accounts/GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU/transactions?cursor=&limit=10&order=asc"},"next":{"href":"https://horizon.stellar.org/accounts/GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU/transactions?cursor=122152984477229056&limit=10&order=asc"},"prev":{"href":"https://horizon.stellar.org/accounts/GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU/transactions?cursor=94658837230923776&limit=10&order=desc"}},"_embedded":{"records":[{"memo":"","memo_bytes":"","_links":{"self":{"href":"https://horizon.stellar.org/transactions/4826a3d41a5a795bf795767d0fb5e39c4abbcf695cf888b3578aa126b5b257ee"},"account":{"href":"https://horizon.stellar.org/accounts/GBYSOAM7D42RMUN4LCKCFYNXZU3F7TJVKD2NMR672J4372BCH6DE4BKR"},"ledger":{"href":"https://horizon.stellar.org/ledgers/22039478"},"operations":{"href":"https://horizon.stellar.org/transactions/4826a3d41a5a795bf795767d0fb5e39c4abbcf695cf888b3578aa126b5b257ee/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/4826a3d41a5a795bf795767d0fb5e39c4abbcf695cf888b3578aa126b5b257ee/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=94658837230923776"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=94658837230923776"},"transaction":{"href":"https://horizon.stellar.org/transactions/4826a3d41a5a795bf795767d0fb5e39c4abbcf695cf888b3578aa126b5b257ee"}},"id":"4826a3d41a5a795bf795767d0fb5e39c4abbcf695cf888b3578aa126b5b257ee","paging_token":"94658837230923776","successful":true,"hash":"4826a3d41a5a795bf795767d0fb5e39c4abbcf695cf888b3578aa126b5b257ee","ledger":22039478,"created_at":"2019-01-18T14:40:47Z","source_account":"GBYSOAM7D42RMUN4LCKCFYNXZU3F7TJVKD2NMR672J4372BCH6DE4BKR","source_account_sequence":"90296735301107721","fee_account":"GBYSOAM7D42RMUN4LCKCFYNXZU3F7TJVKD2NMR672J4372BCH6DE4BKR","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAAHEnAZ8fNRZRvFiUIuG3zTZfzTVQ9NZH39J5v+giP4ZOAAAAZAFAzGcAAAAJAAAAAQAAAAAAAAAAAAAAAFxB5cMAAAABAAAAAAAAAAEAAAAAAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAAC+vCAAAAAAAAAAAEiP4ZOAAAAQO421wcb/JYfBpnYEJzHpMyQnrM8rHd4PUoyHXpPlvQAUGzARqwbX8hcLSM4tlk51AwbuZOaZfWCaFQfzFZJuAA=","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAVBLtgAAAAAAAAAAcScBnx81FlG8WJQi4bfNNl/NNVD01kff0nm/6CI/hk4AAAAAI9MEZAFAzGcAAAAIAAAAAAAAAAEAAAAA7Nxp7lmV7taqQfqoSP+tlqjOHWeANaQYFqhDkCQERZQAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAVBLtgAAAAAAAAAAcScBnx81FlG8WJQi4bfNNl/NNVD01kff0nm/6CI/hk4AAAAAI9MEZAFAzGcAAAAJAAAAAAAAAAEAAAAA7Nxp7lmV7taqQfqoSP+tlqjOHWeANaQYFqhDkCQERZQAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAAAwAAAAMBUEu2AAAAAAAAAABxJwGfHzUWUbxYlCLht802X801UPTWR9/Seb/oIj+GTgAAAAAj0wRkAUDMZwAAAAkAAAAAAAAAAQAAAADs3GnuWZXu1qpB+qhI/62WqM4dZ4A1pBgWqEOQJARFlAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBUEu2AAAAAAAAAABxJwGfHzUWUbxYlCLht802X801UPTWR9/Seb/oIj+GTgAAAAAg2BPkAUDMZwAAAAkAAAAAAAAAAQAAAADs3GnuWZXu1qpB+qhI/62WqM4dZ4A1pBgWqEOQJARFlAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAABUEu2AAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAAC+vCAAVBLtgAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMBUCemAAAAAAAAAABxJwGfHzUWUbxYlCLht802X801UPTWR9/Seb/oIj+GTgAAAAAj0wTIAUDMZwAAAAgAAAAAAAAAAQAAAADs3GnuWZXu1qpB+qhI/62WqM4dZ4A1pBgWqEOQJARFlAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBUEu2AAAAAAAAAABxJwGfHzUWUbxYlCLht802X801UPTWR9/Seb/oIj+GTgAAAAAj0wRkAUDMZwAAAAgAAAAAAAAAAQAAAADs3GnuWZXu1qpB+qhI/62WqM4dZ4A1pBgWqEOQJARFlAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"text","signatures":["7jbXBxv8lh8GmdgQnMekzJCeszysd3g9SjIdek+W9ABQbMBGrBtfyFwtIzi2WTnUDBu5k5pl9YJoVB/MVkm4AA=="],"valid_after":"1970-01-01T00:00:00Z","valid_before":"2019-01-18T14:42:11Z","preconditions":{"timebounds":{"min_time":"0","max_time":"1547822531"}}},{"_links":{"self":{"href":"https://horizon.stellar.org/transactions/ec8d5d6e64dc4df1bc8d8c200e048d6740d1e9f680612baeda0f78678c9ca666"},"account":{"href":"https://horizon.stellar.org/accounts/GAL62GEDMQFWRQLZXJKT4WFRFTIKPPTC2ALSD45VMK7ZUUZVBXWWXUAX"},"ledger":{"href":"https://horizon.stellar.org/ledgers/23895910"},"operations":{"href":"https://horizon.stellar.org/transactions/ec8d5d6e64dc4df1bc8d8c200e048d6740d1e9f680612baeda0f78678c9ca666/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/ec8d5d6e64dc4df1bc8d8c200e048d6740d1e9f680612baeda0f78678c9ca666/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=102632151958179840"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=102632151958179840"},"transaction":{"href":"https://horizon.stellar.org/transactions/ec8d5d6e64dc4df1bc8d8c200e048d6740d1e9f680612baeda0f78678c9ca666"}},"id":"ec8d5d6e64dc4df1bc8d8c200e048d6740d1e9f680612baeda0f78678c9ca666","paging_token":"102632151958179840","successful":true,"hash":"ec8d5d6e64dc4df1bc8d8c200e048d6740d1e9f680612baeda0f78678c9ca666","ledger":23895910,"created_at":"2019-05-17T14:43:53Z","source_account":"GAL62GEDMQFWRQLZXJKT4WFRFTIKPPTC2ALSD45VMK7ZUUZVBXWWXUAX","source_account_sequence":"93143259236270083","fee_account":"GAL62GEDMQFWRQLZXJKT4WFRFTIKPPTC2ALSD45VMK7ZUUZVBXWWXUAX","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAABftGINkC2jBebpVPlixLNCnvmLQFyHztWK/mlM1De1rAAAAZAFK6U0AAAADAAAAAQAAAAAAAAAAAAAAAFzeydEAAAAAAAAAAQAAAAAAAAABAAAAAGpZ5X06Hz48sKzzVFo//X67YFenBLxaxzuJcPuXebqxAAAAAAAAAALLQXgAAAAAAAAAAAE1De1rAAAAQLFFYK9rGA2Um2Vwguj4Ra3T6gaeturf4Qw/0LcG/qa/oXZeu6s7ZrB3wVVJu0m123Z7zirYoo576IS8agzLKQQ=","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAABAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAWyfZgAAAAAAAAAAF+0Yg2QLaMF5ulU+WLEs0Ke+YtAXIfO1Yr+aUzUN7WsAAAAC1fwL1AFK6U0AAAACAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAWyfZgAAAAAAAAAAF+0Yg2QLaMF5ulU+WLEs0Ke+YtAXIfO1Yr+aUzUN7WsAAAAC1fwL1AFK6U0AAAADAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAABAAAAAMBUEu2AAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAAC+vCAAVBLtgAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBbJ9mAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALOPGiAAVBLtgAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAMBbJ9mAAAAAAAAAAAX7RiDZAtowXm6VT5YsSzQp75i0Bch87Viv5pTNQ3tawAAAALV/AvUAUrpTQAAAAMAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBbJ9mAAAAAAAAAAAX7RiDZAtowXm6VT5YsSzQp75i0Bch87Viv5pTNQ3tawAAAAAKupPUAUrpTQAAAAMAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMBS+8PAAAAAAAAAAAX7RiDZAtowXm6VT5YsSzQp75i0Bch87Viv5pTNQ3tawAAAALV/Aw4AUrpTQAAAAIAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBbJ9mAAAAAAAAAAAX7RiDZAtowXm6VT5YsSzQp75i0Bch87Viv5pTNQ3tawAAAALV/AvUAUrpTQAAAAIAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"none","signatures":["sUVgr2sYDZSbZXCC6PhFrdPqBp626t/hDD/Qtwb+pr+hdl67qztmsHfBVUm7SbXbdnvOKtiijnvohLxqDMspBA=="],"valid_after":"1970-01-01T00:00:00Z","valid_before":"2019-05-17T14:48:49Z","preconditions":{"timebounds":{"min_time":"0","max_time":"1558104529"}}},{"_links":{"self":{"href":"https://horizon.stellar.org/transactions/5427d2719db9ca33706e9c06c04f91bd353e0e6f5185c6f47b517b338b8d81b2"},"account":{"href":"https://horizon.stellar.org/accounts/GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU"},"ledger":{"href":"https://horizon.stellar.org/ledgers/27114571"},"operations":{"href":"https://horizon.stellar.org/transactions/5427d2719db9ca33706e9c06c04f91bd353e0e6f5185c6f47b517b338b8d81b2/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/5427d2719db9ca33706e9c06c04f91bd353e0e6f5185c6f47b517b338b8d81b2/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=116456195690164224"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=116456195690164224"},"transaction":{"href":"https://horizon.stellar.org/transactions/5427d2719db9ca33706e9c06c04f91bd353e0e6f5185c6f47b517b338b8d81b2"}},"id":"5427d2719db9ca33706e9c06c04f91bd353e0e6f5185c6f47b517b338b8d81b2","paging_token":"116456195690164224","successful":true,"hash":"5427d2719db9ca33706e9c06c04f91bd353e0e6f5185c6f47b517b338b8d81b2","ledger":27114571,"created_at":"2019-12-04T22:03:41Z","source_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","source_account_sequence":"94658837230911489","fee_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAAGpZ5X06Hz48sKzzVFo//X67YFenBLxaxzuJcPuXebqxAAAAZAFQS7YAAAABAAAAAQAAAAAAAAAAAAAAAF3oLZMAAAAAAAAAAQAAAAAAAAABAAAAAARD8QZr6wa97ii5JeeuMJEXycVsEO1dBekjRTcI9AadAAAAAAAAAAABMS0AAAAAAAAAAAGXebqxAAAAQND+muz3883MoHmTtuhsDb4awF1U3EDJ2FQn8Ia2C9L+Rz62Z9EvH8rl81d3oPxrjUnedZmjOnptn6Agm5alHwc=","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAABAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAZ28SwAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACzjxoHAFQS7YAAAAAAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAZ28SwAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACzjxoHAFQS7YAAAABAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAABAAAAAMBnbwPAAAAAAAAAAAEQ/EGa+sGve4ouSXnrjCRF8nFbBDtXQXpI0U3CPQGnQAAAABxZQNiAZtraAAAABsAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBnbxLAAAAAAAAAAAEQ/EGa+sGve4ouSXnrjCRF8nFbBDtXQXpI0U3CPQGnQAAAAByljBiAZtraAAAABsAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAMBnbxLAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALOPGgcAVBLtgAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBnbxLAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALNCzscAVBLtgAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMBbJ9mAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALOPGiAAVBLtgAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBnbxLAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALOPGgcAVBLtgAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"none","signatures":["0P6a7PfzzcygeZO26GwNvhrAXVTcQMnYVCfwhrYL0v5HPrZn0S8fyuXzV3eg/GuNSd51maM6em2foCCblqUfBw=="],"valid_after":"1970-01-01T00:00:00Z","valid_before":"2019-12-04T22:05:07Z","preconditions":{"timebounds":{"min_time":"0","max_time":"1575497107"}}},{"memo":"hello universe","memo_bytes":"aGVsbG8gdW5pdmVyc2U=","_links":{"self":{"href":"https://horizon.stellar.org/transactions/ef0fe04ac3c7de7228ca2598886059868ad05c224a041e8b2d9ee2a8a9dd6894"},"account":{"href":"https://horizon.stellar.org/accounts/GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU"},"ledger":{"href":"https://horizon.stellar.org/ledgers/27984461"},"operations":{"href":"https://horizon.stellar.org/transactions/ef0fe04ac3c7de7228ca2598886059868ad05c224a041e8b2d9ee2a8a9dd6894/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/ef0fe04ac3c7de7228ca2598886059868ad05c224a041e8b2d9ee2a8a9dd6894/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=120192344791343104"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=120192344791343104"},"transaction":{"href":"https://horizon.stellar.org/transactions/ef0fe04ac3c7de7228ca2598886059868ad05c224a041e8b2d9ee2a8a9dd6894"}},"id":"ef0fe04ac3c7de7228ca2598886059868ad05c224a041e8b2d9ee2a8a9dd6894","paging_token":"120192344791343104","successful":true,"hash":"ef0fe04ac3c7de7228ca2598886059868ad05c224a041e8b2d9ee2a8a9dd6894","ledger":27984461,"created_at":"2020-01-29T19:43:59Z","source_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","source_account_sequence":"94658837230911490","fee_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAAGpZ5X06Hz48sKzzVFo//X67YFenBLxaxzuJcPuXebqxAAAAZAFQS7YAAAACAAAAAQAAAAAAAAAAAAAAAF4x4NYAAAABAAAADmhlbGxvIHVuaXZlcnNlAAAAAAABAAAAAAAAAAAAAAAAMOWtdEZJweWBDrIVGDQOVodinrlXbfzBfquR7AFtxW4AAAAAATEtAAAAAAAAAAABl3m6sQAAAEDwdDlpQv5IfweTkLjytpWIa+bpQv7BAHRFpMCHscM3g+WBKjXPVEnSP1BghLuy3uhvgv4LnCkI+gFEDZxwV/YF","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAasCTQAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACzQs6uAFQS7YAAAABAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAasCTQAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACzQs6uAFQS7YAAAACAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAAAwAAAAMBqwJNAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALNCzq4AVBLtgAAAAIAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBqwJNAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALL2g24AVBLtgAAAAIAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAABqwJNAAAAAAAAAAAw5a10RknB5YEOshUYNA5Wh2KeuVdt/MF+q5HsAW3FbgAAAAABMS0AAasCTQAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMBnbxLAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALNCzscAVBLtgAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBqwJNAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALNCzq4AVBLtgAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"text","signatures":["8HQ5aUL+SH8Hk5C48raViGvm6UL+wQB0RaTAh7HDN4PlgSo1z1RJ0j9QYIS7st7ob4L+C5wpCPoBRA2ccFf2BQ=="],"valid_after":"1970-01-01T00:00:00Z","valid_before":"2020-01-29T19:45:26Z","preconditions":{"timebounds":{"min_time":"0","max_time":"1580327126"}}},{"_links":{"self":{"href":"https://horizon.stellar.org/transactions/c1cb850f413e4038c4120bd9badc07bb8ef85a46649a4d5c9c16e578a2d30589"},"account":{"href":"https://horizon.stellar.org/accounts/GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU"},"ledger":{"href":"https://horizon.stellar.org/ledgers/27984467"},"operations":{"href":"https://horizon.stellar.org/transactions/c1cb850f413e4038c4120bd9badc07bb8ef85a46649a4d5c9c16e578a2d30589/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/c1cb850f413e4038c4120bd9badc07bb8ef85a46649a4d5c9c16e578a2d30589/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=120192370561220608"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=120192370561220608"},"transaction":{"href":"https://horizon.stellar.org/transactions/c1cb850f413e4038c4120bd9badc07bb8ef85a46649a4d5c9c16e578a2d30589"}},"id":"c1cb850f413e4038c4120bd9badc07bb8ef85a46649a4d5c9c16e578a2d30589","paging_token":"120192370561220608","successful":true,"hash":"c1cb850f413e4038c4120bd9badc07bb8ef85a46649a4d5c9c16e578a2d30589","ledger":27984467,"created_at":"2020-01-29T19:44:36Z","source_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","source_account_sequence":"94658837230911491","fee_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAAGpZ5X06Hz48sKzzVFo//X67YFenBLxaxzuJcPuXebqxAAAAZAFQS7YAAAADAAAAAQAAAAAAAAAAAAAAAF4x4PoAAAAAAAAAAQAAAAAAAAABAAAAADDlrXRGScHlgQ6yFRg0DlaHYp65V238wX6rkewBbcVuAAAAAAAAAAB3NZQAAAAAAAAAAAGXebqxAAAAQMzdIubro9XQUTkhf0YbDBNM5tqC/zS7fGb0BLFq+QxXT7VAS7dDMno9A2f1df4nnyeHqVl+CuKcpwwwS04JSgE=","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAABAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAasCUwAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACy9oNVAFQS7YAAAACAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAasCUwAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACy9oNVAFQS7YAAAADAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAABAAAAAMBqwJNAAAAAAAAAAAw5a10RknB5YEOshUYNA5Wh2KeuVdt/MF+q5HsAW3FbgAAAAABMS0AAasCTQAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBqwJTAAAAAAAAAAAw5a10RknB5YEOshUYNA5Wh2KeuVdt/MF+q5HsAW3FbgAAAAB4ZsEAAasCTQAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAMBqwJTAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALL2g1UAVBLtgAAAAMAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBqwJTAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAJUpHlUAVBLtgAAAAMAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMBqwJNAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALL2g24AVBLtgAAAAIAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBqwJTAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALL2g1UAVBLtgAAAAIAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"none","signatures":["zN0i5uuj1dBROSF/RhsME0zm2oL/NLt8ZvQEsWr5DFdPtUBLt0Myej0DZ/V1/iefJ4epWX4K4pynDDBLTglKAQ=="],"valid_after":"1970-01-01T00:00:00Z","valid_before":"2020-01-29T19:46:02Z","preconditions":{"timebounds":{"min_time":"0","max_time":"1580327162"}}},{"_links":{"self":{"href":"https://horizon.stellar.org/transactions/e0f3d6e327a6de01223a8f0e2b88e97abeaf1f514f95f8e7c55f18b951f09dbe"},"account":{"href":"https://horizon.stellar.org/accounts/GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU"},"ledger":{"href":"https://horizon.stellar.org/ledgers/28000615"},"operations":{"href":"https://horizon.stellar.org/transactions/e0f3d6e327a6de01223a8f0e2b88e97abeaf1f514f95f8e7c55f18b951f09dbe/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/e0f3d6e327a6de01223a8f0e2b88e97abeaf1f514f95f8e7c55f18b951f09dbe/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=120261725693136896"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=120261725693136896"},"transaction":{"href":"https://horizon.stellar.org/transactions/e0f3d6e327a6de01223a8f0e2b88e97abeaf1f514f95f8e7c55f18b951f09dbe"}},"id":"e0f3d6e327a6de01223a8f0e2b88e97abeaf1f514f95f8e7c55f18b951f09dbe","paging_token":"120261725693136896","successful":true,"hash":"e0f3d6e327a6de01223a8f0e2b88e97abeaf1f514f95f8e7c55f18b951f09dbe","ledger":28000615,"created_at":"2020-01-30T21:45:07Z","source_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","source_account_sequence":"94658837230911492","fee_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAAGpZ5X06Hz48sKzzVFo//X67YFenBLxaxzuJcPuXebqxAAAAZAFQS7YAAAAEAAAAAQAAAAAAAAAAAAAAAF4zTrgAAAAAAAAAAQAAAAAAAAABAAAAABhkaLZ/GHrh4vaarKkeK7PX2c581NvMfPvtTyATuVziAAAAAAAAAAAF9eEAAAAAAAAAAAGXebqxAAAAQB9XBu17Olvry7c8CqLJXqvK5csy2r3lGiP3HyR5JcryL8QQjSuwGr/LEFFKIS5Afo/jh9fCzGzJzZQ4DN1KPgs=","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAABAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAatBZwAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACVKR48AFQS7YAAAADAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAatBZwAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACVKR48AFQS7YAAAAEAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAABAAAAAMBq0EQAAAAAAAAAAAYZGi2fxh64eL2mqypHiuz19nOfNTbzHz77U8gE7lc4gAAAAACYljUAatBDAAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBq0FnAAAAAAAAAAAYZGi2fxh64eL2mqypHiuz19nOfNTbzHz77U8gE7lc4gAAAAAIWDnUAatBDAAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAMBq0FnAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAJUpHjwAVBLtgAAAAQAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBq0FnAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAJOrpfwAVBLtgAAAAQAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMBqwJTAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAJUpHlUAVBLtgAAAAMAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBq0FnAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAJUpHjwAVBLtgAAAAMAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"none","signatures":["H1cG7Xs6W+vLtzwKosleq8rlyzLaveUaI/cfJHklyvIvxBCNK7Aav8sQUUohLkB+j+OH18LMbMnNlDgM3Uo+Cw=="],"valid_after":"1970-01-01T00:00:00Z","valid_before":"2020-01-30T21:46:32Z","preconditions":{"timebounds":{"min_time":"0","max_time":"1580420792"}}},{"_links":{"self":{"href":"https://horizon.stellar.org/transactions/329ae48814ae29ed6d9c0bb6e398932e6a178cac21623b63fbf5d8245261c041"},"account":{"href":"https://horizon.stellar.org/accounts/GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU"},"ledger":{"href":"https://horizon.stellar.org/ledgers/28000619"},"operations":{"href":"https://horizon.stellar.org/transactions/329ae48814ae29ed6d9c0bb6e398932e6a178cac21623b63fbf5d8245261c041/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/329ae48814ae29ed6d9c0bb6e398932e6a178cac21623b63fbf5d8245261c041/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=120261742872928256"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=120261742872928256"},"transaction":{"href":"https://horizon.stellar.org/transactions/329ae48814ae29ed6d9c0bb6e398932e6a178cac21623b63fbf5d8245261c041"}},"id":"329ae48814ae29ed6d9c0bb6e398932e6a178cac21623b63fbf5d8245261c041","paging_token":"120261742872928256","successful":true,"hash":"329ae48814ae29ed6d9c0bb6e398932e6a178cac21623b63fbf5d8245261c041","ledger":28000619,"created_at":"2020-01-30T21:45:29Z","source_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","source_account_sequence":"94658837230911493","fee_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAAGpZ5X06Hz48sKzzVFo//X67YFenBLxaxzuJcPuXebqxAAAAZAFQS7YAAAAFAAAAAQAAAAAAAAAAAAAAAF4zTtEAAAAAAAAAAQAAAAAAAAABAAAAABhkaLZ/GHrh4vaarKkeK7PX2c581NvMfPvtTyATuVziAAAAAAAAAAAO5rKAAAAAAAAAAAGXebqxAAAAQFaUIoWWXLurZRFty6iBHmm65K2w5EZjldQcMsB/KeQl1Rh0UkZ7Q44JCDCvntnIhWfkl1Qipr6jZk/I4c+pjw8=","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAABAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAatBawAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACTq6XjAFQS7YAAAAEAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAatBawAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACTq6XjAFQS7YAAAAFAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAABAAAAAMBq0FnAAAAAAAAAAAYZGi2fxh64eL2mqypHiuz19nOfNTbzHz77U8gE7lc4gAAAAAIWDnUAatBDAAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBq0FrAAAAAAAAAAAYZGi2fxh64eL2mqypHiuz19nOfNTbzHz77U8gE7lc4gAAAAAXPuxUAatBDAAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAMBq0FrAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAJOrpeMAVBLtgAAAAUAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBq0FrAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAI/x+UMAVBLtgAAAAUAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMBq0FnAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAJOrpfwAVBLtgAAAAQAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBq0FrAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAJOrpeMAVBLtgAAAAQAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"none","signatures":["VpQihZZcu6tlEW3LqIEeabrkrbDkRmOV1BwywH8p5CXVGHRSRntDjgkIMK+e2ciFZ+SXVCKmvqNmT8jhz6mPDw=="],"valid_after":"1970-01-01T00:00:00Z","valid_before":"2020-01-30T21:46:57Z","preconditions":{"timebounds":{"min_time":"0","max_time":"1580420817"}}},{"_links":{"self":{"href":"https://horizon.stellar.org/transactions/2b8a77c7e42997280b8454e39bd7c681c58ab5b7cc288ff836c1c4b6152dccfe"},"account":{"href":"https://horizon.stellar.org/accounts/GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU"},"ledger":{"href":"https://horizon.stellar.org/ledgers/28210091"},"operations":{"href":"https://horizon.stellar.org/transactions/2b8a77c7e42997280b8454e39bd7c681c58ab5b7cc288ff836c1c4b6152dccfe/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/2b8a77c7e42997280b8454e39bd7c681c58ab5b7cc288ff836c1c4b6152dccfe/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=121161418262413312"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=121161418262413312"},"transaction":{"href":"https://horizon.stellar.org/transactions/2b8a77c7e42997280b8454e39bd7c681c58ab5b7cc288ff836c1c4b6152dccfe"}},"id":"2b8a77c7e42997280b8454e39bd7c681c58ab5b7cc288ff836c1c4b6152dccfe","paging_token":"121161418262413312","successful":true,"hash":"2b8a77c7e42997280b8454e39bd7c681c58ab5b7cc288ff836c1c4b6152dccfe","ledger":28210091,"created_at":"2020-02-13T18:54:50Z","source_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","source_account_sequence":"94658837230911494","fee_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAAGpZ5X06Hz48sKzzVFo//X67YFenBLxaxzuJcPuXebqxAAAAZAFQS7YAAAAGAAAAAQAAAAAAAAAAAAAAAF5Fm9EAAAAAAAAAAQAAAAAAAAAAAAAAADKjrtXFaprjtdoV8mYex4557fEGVYkp83K0vfUwEyVnAAAAAAvrwgAAAAAAAAAAAZd5urEAAABAKCO0IAmQ8hUJVMMfIxu1Q/DgZebmn09dROCFCKSEUZGYuzqlfJPYMrcOJRtf41wwMFK8Wj1g70EAw+ZDhKhJDA==","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAa5zqwAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACP8fkqAFQS7YAAAAFAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAa5zqwAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACP8fkqAFQS7YAAAAGAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAAAwAAAAMBrnOrAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAI/x+SoAVBLtgAAAAYAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBrnOrAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAIz3CKoAVBLtgAAAAYAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAABrnOrAAAAAAAAAAAyo67VxWqa47XaFfJmHseOee3xBlWJKfNytL31MBMlZwAAAAAL68IAAa5zqwAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMBq0FrAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAI/x+UMAVBLtgAAAAUAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBrnOrAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAI/x+SoAVBLtgAAAAUAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"none","signatures":["KCO0IAmQ8hUJVMMfIxu1Q/DgZebmn09dROCFCKSEUZGYuzqlfJPYMrcOJRtf41wwMFK8Wj1g70EAw+ZDhKhJDA=="],"valid_after":"1970-01-01T00:00:00Z","valid_before":"2020-02-13T18:56:17Z","preconditions":{"timebounds":{"min_time":"0","max_time":"1581620177"}}},{"memo":"hello world","memo_bytes":"aGVsbG8gd29ybGQ=","_links":{"self":{"href":"https://horizon.stellar.org/transactions/729e441893075fe40b6a6db0acbe38dd39243417cc8717f968414934331a6260"},"account":{"href":"https://horizon.stellar.org/accounts/GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU"},"ledger":{"href":"https://horizon.stellar.org/ledgers/28211677"},"operations":{"href":"https://horizon.stellar.org/transactions/729e441893075fe40b6a6db0acbe38dd39243417cc8717f968414934331a6260/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/729e441893075fe40b6a6db0acbe38dd39243417cc8717f968414934331a6260/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=121168230080335872"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=121168230080335872"},"transaction":{"href":"https://horizon.stellar.org/transactions/729e441893075fe40b6a6db0acbe38dd39243417cc8717f968414934331a6260"}},"id":"729e441893075fe40b6a6db0acbe38dd39243417cc8717f968414934331a6260","paging_token":"121168230080335872","successful":true,"hash":"729e441893075fe40b6a6db0acbe38dd39243417cc8717f968414934331a6260","ledger":28211677,"created_at":"2020-02-13T21:21:01Z","source_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","source_account_sequence":"94658837230911495","fee_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAAGpZ5X06Hz48sKzzVFo//X67YFenBLxaxzuJcPuXebqxAAAAZAFQS7YAAAAHAAAAAQAAAAAAAAAAAAAAAF5Fvg4AAAABAAAAC2hlbGxvIHdvcmxkAAAAAAEAAAAAAAAAAAAAAAD7exWPWaCVKiygoj7vEoUox3IdGR0BGEwgrfvu7xj49gAAAAAL68IAAAAAAAAAAAGXebqxAAAAQPNJSRhqEmEaKqtigW3PTPmm0SPF2befw+hH+j7hhDW9L7xDA6FDZlEvFESKAQxWBMQeV9r3D/7Y8tx5uW2WwQk=","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAa553QAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACM9wiRAFQS7YAAAAGAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAa553QAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACM9wiRAFQS7YAAAAHAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAAAwAAAAMBrnndAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAIz3CJEAVBLtgAAAAcAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBrnndAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAIn8GBEAVBLtgAAAAcAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAABrnndAAAAAAAAAAD7exWPWaCVKiygoj7vEoUox3IdGR0BGEwgrfvu7xj49gAAAAAL68IAAa553QAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMBrnOrAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAIz3CKoAVBLtgAAAAYAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBrnndAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAIz3CJEAVBLtgAAAAYAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"text","signatures":["80lJGGoSYRoqq2KBbc9M+abRI8XZt5/D6Ef6PuGENb0vvEMDoUNmUS8URIoBDFYExB5X2vcP/tjy3Hm5bZbBCQ=="],"valid_after":"1970-01-01T00:00:00Z","valid_before":"2020-02-13T21:22:22Z","preconditions":{"timebounds":{"min_time":"0","max_time":"1581628942"}}},{"memo":"Airdrop invite✅xlmget.org","memo_bytes":"QWlyZHJvcCBpbnZpdGXinIV4bG1nZXQub3Jn","_links":{"self":{"href":"https://horizon.stellar.org/transactions/849fc553ad0a55e75a27ad5a80047a45baa54c321043686cb7f55fa9ef3f7d59"},"account":{"href":"https://horizon.stellar.org/accounts/GBRW5XFS5PANVBWVOHXTR6D6KZN3CEKA2JIROR5NRYQMHT5K67B3SYU7"},"ledger":{"href":"https://horizon.stellar.org/ledgers/28440958"},"operations":{"href":"https://horizon.stellar.org/transactions/849fc553ad0a55e75a27ad5a80047a45baa54c321043686cb7f55fa9ef3f7d59/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/849fc553ad0a55e75a27ad5a80047a45baa54c321043686cb7f55fa9ef3f7d59/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=122152984477229056"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=122152984477229056"},"transaction":{"href":"https://horizon.stellar.org/transactions/849fc553ad0a55e75a27ad5a80047a45baa54c321043686cb7f55fa9ef3f7d59"}},"id":"849fc553ad0a55e75a27ad5a80047a45baa54c321043686cb7f55fa9ef3f7d59","paging_token":"122152984477229056","successful":true,"hash":"849fc553ad0a55e75a27ad5a80047a45baa54c321043686cb7f55fa9ef3f7d59","ledger":28440958,"created_at":"2020-02-28T16:28:42Z","source_account":"GBRW5XFS5PANVBWVOHXTR6D6KZN3CEKA2JIROR5NRYQMHT5K67B3SYU7","source_account_sequence":"122138905574114388","fee_account":"GBRW5XFS5PANVBWVOHXTR6D6KZN3CEKA2JIROR5NRYQMHT5K67B3SYU7","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAAGNu3LLrwNqG1XHvOPh+VluxEUDSURdHrY4gw8+q98O5AAAAZAGx7LAAAARUAAAAAAAAAAEAAAAbQWlyZHJvcCBpbnZpdGXinIV4bG1nZXQub3JnAAAAAAEAAAAAAAAAAQAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAAAAAAAAAGGoAAAAAAAAAABqvfDuQAAAECzK8e8L+dHqGZWsoOwNLgTnFD+Omu3DcVJ4Gwb71ZKsokaH+2hPLf65I6GgIX4pcyz1SgRNuhi0Utg4tGkfGUA","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAABAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAbH5fgAAAAAAAAAAY27csuvA2obVce84+H5WW7ERQNJRF0etjiDDz6r3w7kAAAAAGGO7UAGx7LAAAARTAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAbH5fgAAAAAAAAAAY27csuvA2obVce84+H5WW7ERQNJRF0etjiDDz6r3w7kAAAAAGGO7UAGx7LAAAARUAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAABAAAAAMBrnndAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAIn8GBEAVBLtgAAAAcAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBsfl+AAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAIn8ebkAVBLtgAAAAcAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAMBsfl+AAAAAAAAAABjbtyy68DahtVx7zj4flZbsRFA0lEXR62OIMPPqvfDuQAAAAAYY7tQAbHssAAABFQAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBsfl+AAAAAAAAAABjbtyy68DahtVx7zj4flZbsRFA0lEXR62OIMPPqvfDuQAAAAAYYjSwAbHssAAABFQAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMBsfl8AAAAAAAAAABjbtyy68DahtVx7zj4flZbsRFA0lEXR62OIMPPqvfDuQAAAAAYY7u0AbHssAAABFMAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBsfl+AAAAAAAAAABjbtyy68DahtVx7zj4flZbsRFA0lEXR62OIMPPqvfDuQAAAAAYY7tQAbHssAAABFMAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"text","signatures":["syvHvC/nR6hmVrKDsDS4E5xQ/jprtw3FSeBsG+9WSrKJGh/toTy3+uSOhoCF+KXMs9UoETboYtFLYOLRpHxlAA=="]}]}}}}}}}},"method":"get","path":"/accounts/{account_id}/transactions","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve an Account's Transactions","description":{"content":"This endpoint represents successful transactions for a given account and can be used in streaming mode. Streaming mode allows you to listen for new transactions for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known transaction unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream transactions created since your request time.","type":"text/plain"},"url":{"path":["accounts",":account_id","transactions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Set to true to include failed operations in results. Options include true and false.","type":"text/plain"},"key":"include_failed","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) This account’s public key encoded in a base32 string representation.","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Accounts"],"description":"This endpoint represents successful transactions for a given account and can be used in streaming mode. Streaming mode allows you to listen for new transactions for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known transaction unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream transactions created since your request time.","operationId":"GetTransactionsByAccountId","parameters":[{"name":"account_id","in":"path","required":true,"description":"This account’s public key encoded in a base32 string representation.","schema":{"type":"string","example":"GDMQQNJM4UL7QIA66P7R2PZHMQINWZBM77BEBMHLFXD5JEUAHGJ7R4JZ"}},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}},{"name":"include_failed","in":"query","required":false,"description":"Set to true to include failed operations in results. Options include true and false.","schema":{"type":"boolean","enum":[true,false]}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"memo":{"type":"string"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"account":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"ledger":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"operations":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","account","ledger","operations","effects","precedes","succeeds","transaction"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"successful":{"type":"boolean"},"hash":{"type":"string"},"ledger":{"type":"integer","format":"int32"},"created_at":{"type":"string"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"account_muxed":{"type":"string"},"account_muxed_id":{"type":"string"},"source_account_sequence":{"type":"string"},"fee_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"fee_account_muxed":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"fee_account_muxed_id":{"type":"string"},"fee_charged":{"type":"string"},"max_fee":{"type":"string"},"operation_count":{"type":"integer","format":"int32"},"envelope_xdr":{"type":"string"},"result_xdr":{"type":"string"},"result_meta_xdr":{"type":"string"},"fee_meta_xdr":{"type":"string"},"memo_type":{"type":"string"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"},"valid_after":{"type":"string"},"valid_before":{"type":"string"},"preconditions":{"type":"object","properties":{"timebounds":{"type":"object","properties":{"min_time":{"type":"string"},"max_time":{"type":"string"}},"title":"TransactionPreconditionsTimebounds"},"ledgerbounds":{"type":"object","properties":{"min_ledger":{"type":"string"},"max_ledger":{"type":"string"}},"title":"TransactionPreconditionsLedgerbounds"},"min_account_sequence":{"type":"string"},"min_account_sequence_age":{"type":"string"},"min_account_sequence_ledger_gap":{"type":"integer","format":"uint32"},"extra_signers":{"type":"array","items":{"type":"string"}}},"title":"TransactionPreconditions"},"fee_bump_transaction":{"type":"object","properties":{"hash":{"type":"string","title":"hash"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"}},"title":"FeeBumpTransaction"},"inner_transaction":{"type":"object","properties":{"hash":{"type":"string","title":"hash"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"},"max_fee":{"type":"string"}},"title":"InnerTransaction"}},"required":["id","paging_token","successful","hash","ledger","created_at","source_account","source_account_sequence","fee_account","fee_charged","max_fee","operation_count","envelope_xdr","result_xdr","result_meta_xdr","memo_type","signatures"]}}}}},"title":"Transaction"}]},"examples":{"RetrieveAnAccountsTransactions":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/accounts/GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU/transactions?cursor=&limit=10&order=asc"},"next":{"href":"https://horizon.stellar.org/accounts/GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU/transactions?cursor=122152984477229056&limit=10&order=asc"},"prev":{"href":"https://horizon.stellar.org/accounts/GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU/transactions?cursor=94658837230923776&limit=10&order=desc"}},"_embedded":{"records":[{"memo":"","memo_bytes":"","_links":{"self":{"href":"https://horizon.stellar.org/transactions/4826a3d41a5a795bf795767d0fb5e39c4abbcf695cf888b3578aa126b5b257ee"},"account":{"href":"https://horizon.stellar.org/accounts/GBYSOAM7D42RMUN4LCKCFYNXZU3F7TJVKD2NMR672J4372BCH6DE4BKR"},"ledger":{"href":"https://horizon.stellar.org/ledgers/22039478"},"operations":{"href":"https://horizon.stellar.org/transactions/4826a3d41a5a795bf795767d0fb5e39c4abbcf695cf888b3578aa126b5b257ee/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/4826a3d41a5a795bf795767d0fb5e39c4abbcf695cf888b3578aa126b5b257ee/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=94658837230923776"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=94658837230923776"},"transaction":{"href":"https://horizon.stellar.org/transactions/4826a3d41a5a795bf795767d0fb5e39c4abbcf695cf888b3578aa126b5b257ee"}},"id":"4826a3d41a5a795bf795767d0fb5e39c4abbcf695cf888b3578aa126b5b257ee","paging_token":"94658837230923776","successful":true,"hash":"4826a3d41a5a795bf795767d0fb5e39c4abbcf695cf888b3578aa126b5b257ee","ledger":22039478,"created_at":"2019-01-18T14:40:47Z","source_account":"GBYSOAM7D42RMUN4LCKCFYNXZU3F7TJVKD2NMR672J4372BCH6DE4BKR","source_account_sequence":"90296735301107721","fee_account":"GBYSOAM7D42RMUN4LCKCFYNXZU3F7TJVKD2NMR672J4372BCH6DE4BKR","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAAHEnAZ8fNRZRvFiUIuG3zTZfzTVQ9NZH39J5v+giP4ZOAAAAZAFAzGcAAAAJAAAAAQAAAAAAAAAAAAAAAFxB5cMAAAABAAAAAAAAAAEAAAAAAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAAC+vCAAAAAAAAAAAEiP4ZOAAAAQO421wcb/JYfBpnYEJzHpMyQnrM8rHd4PUoyHXpPlvQAUGzARqwbX8hcLSM4tlk51AwbuZOaZfWCaFQfzFZJuAA=","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAVBLtgAAAAAAAAAAcScBnx81FlG8WJQi4bfNNl/NNVD01kff0nm/6CI/hk4AAAAAI9MEZAFAzGcAAAAIAAAAAAAAAAEAAAAA7Nxp7lmV7taqQfqoSP+tlqjOHWeANaQYFqhDkCQERZQAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAVBLtgAAAAAAAAAAcScBnx81FlG8WJQi4bfNNl/NNVD01kff0nm/6CI/hk4AAAAAI9MEZAFAzGcAAAAJAAAAAAAAAAEAAAAA7Nxp7lmV7taqQfqoSP+tlqjOHWeANaQYFqhDkCQERZQAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAAAwAAAAMBUEu2AAAAAAAAAABxJwGfHzUWUbxYlCLht802X801UPTWR9/Seb/oIj+GTgAAAAAj0wRkAUDMZwAAAAkAAAAAAAAAAQAAAADs3GnuWZXu1qpB+qhI/62WqM4dZ4A1pBgWqEOQJARFlAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBUEu2AAAAAAAAAABxJwGfHzUWUbxYlCLht802X801UPTWR9/Seb/oIj+GTgAAAAAg2BPkAUDMZwAAAAkAAAAAAAAAAQAAAADs3GnuWZXu1qpB+qhI/62WqM4dZ4A1pBgWqEOQJARFlAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAABUEu2AAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAAC+vCAAVBLtgAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMBUCemAAAAAAAAAABxJwGfHzUWUbxYlCLht802X801UPTWR9/Seb/oIj+GTgAAAAAj0wTIAUDMZwAAAAgAAAAAAAAAAQAAAADs3GnuWZXu1qpB+qhI/62WqM4dZ4A1pBgWqEOQJARFlAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBUEu2AAAAAAAAAABxJwGfHzUWUbxYlCLht802X801UPTWR9/Seb/oIj+GTgAAAAAj0wRkAUDMZwAAAAgAAAAAAAAAAQAAAADs3GnuWZXu1qpB+qhI/62WqM4dZ4A1pBgWqEOQJARFlAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"text","signatures":["7jbXBxv8lh8GmdgQnMekzJCeszysd3g9SjIdek+W9ABQbMBGrBtfyFwtIzi2WTnUDBu5k5pl9YJoVB/MVkm4AA=="],"valid_after":"1970-01-01T00:00:00Z","valid_before":"2019-01-18T14:42:11Z","preconditions":{"timebounds":{"min_time":"0","max_time":"1547822531"}}},{"_links":{"self":{"href":"https://horizon.stellar.org/transactions/ec8d5d6e64dc4df1bc8d8c200e048d6740d1e9f680612baeda0f78678c9ca666"},"account":{"href":"https://horizon.stellar.org/accounts/GAL62GEDMQFWRQLZXJKT4WFRFTIKPPTC2ALSD45VMK7ZUUZVBXWWXUAX"},"ledger":{"href":"https://horizon.stellar.org/ledgers/23895910"},"operations":{"href":"https://horizon.stellar.org/transactions/ec8d5d6e64dc4df1bc8d8c200e048d6740d1e9f680612baeda0f78678c9ca666/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/ec8d5d6e64dc4df1bc8d8c200e048d6740d1e9f680612baeda0f78678c9ca666/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=102632151958179840"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=102632151958179840"},"transaction":{"href":"https://horizon.stellar.org/transactions/ec8d5d6e64dc4df1bc8d8c200e048d6740d1e9f680612baeda0f78678c9ca666"}},"id":"ec8d5d6e64dc4df1bc8d8c200e048d6740d1e9f680612baeda0f78678c9ca666","paging_token":"102632151958179840","successful":true,"hash":"ec8d5d6e64dc4df1bc8d8c200e048d6740d1e9f680612baeda0f78678c9ca666","ledger":23895910,"created_at":"2019-05-17T14:43:53Z","source_account":"GAL62GEDMQFWRQLZXJKT4WFRFTIKPPTC2ALSD45VMK7ZUUZVBXWWXUAX","source_account_sequence":"93143259236270083","fee_account":"GAL62GEDMQFWRQLZXJKT4WFRFTIKPPTC2ALSD45VMK7ZUUZVBXWWXUAX","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAABftGINkC2jBebpVPlixLNCnvmLQFyHztWK/mlM1De1rAAAAZAFK6U0AAAADAAAAAQAAAAAAAAAAAAAAAFzeydEAAAAAAAAAAQAAAAAAAAABAAAAAGpZ5X06Hz48sKzzVFo//X67YFenBLxaxzuJcPuXebqxAAAAAAAAAALLQXgAAAAAAAAAAAE1De1rAAAAQLFFYK9rGA2Um2Vwguj4Ra3T6gaeturf4Qw/0LcG/qa/oXZeu6s7ZrB3wVVJu0m123Z7zirYoo576IS8agzLKQQ=","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAABAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAWyfZgAAAAAAAAAAF+0Yg2QLaMF5ulU+WLEs0Ke+YtAXIfO1Yr+aUzUN7WsAAAAC1fwL1AFK6U0AAAACAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAWyfZgAAAAAAAAAAF+0Yg2QLaMF5ulU+WLEs0Ke+YtAXIfO1Yr+aUzUN7WsAAAAC1fwL1AFK6U0AAAADAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAABAAAAAMBUEu2AAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAAC+vCAAVBLtgAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBbJ9mAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALOPGiAAVBLtgAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAMBbJ9mAAAAAAAAAAAX7RiDZAtowXm6VT5YsSzQp75i0Bch87Viv5pTNQ3tawAAAALV/AvUAUrpTQAAAAMAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBbJ9mAAAAAAAAAAAX7RiDZAtowXm6VT5YsSzQp75i0Bch87Viv5pTNQ3tawAAAAAKupPUAUrpTQAAAAMAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMBS+8PAAAAAAAAAAAX7RiDZAtowXm6VT5YsSzQp75i0Bch87Viv5pTNQ3tawAAAALV/Aw4AUrpTQAAAAIAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBbJ9mAAAAAAAAAAAX7RiDZAtowXm6VT5YsSzQp75i0Bch87Viv5pTNQ3tawAAAALV/AvUAUrpTQAAAAIAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"none","signatures":["sUVgr2sYDZSbZXCC6PhFrdPqBp626t/hDD/Qtwb+pr+hdl67qztmsHfBVUm7SbXbdnvOKtiijnvohLxqDMspBA=="],"valid_after":"1970-01-01T00:00:00Z","valid_before":"2019-05-17T14:48:49Z","preconditions":{"timebounds":{"min_time":"0","max_time":"1558104529"}}},{"_links":{"self":{"href":"https://horizon.stellar.org/transactions/5427d2719db9ca33706e9c06c04f91bd353e0e6f5185c6f47b517b338b8d81b2"},"account":{"href":"https://horizon.stellar.org/accounts/GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU"},"ledger":{"href":"https://horizon.stellar.org/ledgers/27114571"},"operations":{"href":"https://horizon.stellar.org/transactions/5427d2719db9ca33706e9c06c04f91bd353e0e6f5185c6f47b517b338b8d81b2/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/5427d2719db9ca33706e9c06c04f91bd353e0e6f5185c6f47b517b338b8d81b2/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=116456195690164224"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=116456195690164224"},"transaction":{"href":"https://horizon.stellar.org/transactions/5427d2719db9ca33706e9c06c04f91bd353e0e6f5185c6f47b517b338b8d81b2"}},"id":"5427d2719db9ca33706e9c06c04f91bd353e0e6f5185c6f47b517b338b8d81b2","paging_token":"116456195690164224","successful":true,"hash":"5427d2719db9ca33706e9c06c04f91bd353e0e6f5185c6f47b517b338b8d81b2","ledger":27114571,"created_at":"2019-12-04T22:03:41Z","source_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","source_account_sequence":"94658837230911489","fee_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAAGpZ5X06Hz48sKzzVFo//X67YFenBLxaxzuJcPuXebqxAAAAZAFQS7YAAAABAAAAAQAAAAAAAAAAAAAAAF3oLZMAAAAAAAAAAQAAAAAAAAABAAAAAARD8QZr6wa97ii5JeeuMJEXycVsEO1dBekjRTcI9AadAAAAAAAAAAABMS0AAAAAAAAAAAGXebqxAAAAQND+muz3883MoHmTtuhsDb4awF1U3EDJ2FQn8Ia2C9L+Rz62Z9EvH8rl81d3oPxrjUnedZmjOnptn6Agm5alHwc=","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAABAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAZ28SwAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACzjxoHAFQS7YAAAAAAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAZ28SwAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACzjxoHAFQS7YAAAABAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAABAAAAAMBnbwPAAAAAAAAAAAEQ/EGa+sGve4ouSXnrjCRF8nFbBDtXQXpI0U3CPQGnQAAAABxZQNiAZtraAAAABsAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBnbxLAAAAAAAAAAAEQ/EGa+sGve4ouSXnrjCRF8nFbBDtXQXpI0U3CPQGnQAAAAByljBiAZtraAAAABsAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAMBnbxLAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALOPGgcAVBLtgAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBnbxLAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALNCzscAVBLtgAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMBbJ9mAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALOPGiAAVBLtgAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBnbxLAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALOPGgcAVBLtgAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"none","signatures":["0P6a7PfzzcygeZO26GwNvhrAXVTcQMnYVCfwhrYL0v5HPrZn0S8fyuXzV3eg/GuNSd51maM6em2foCCblqUfBw=="],"valid_after":"1970-01-01T00:00:00Z","valid_before":"2019-12-04T22:05:07Z","preconditions":{"timebounds":{"min_time":"0","max_time":"1575497107"}}},{"memo":"hello universe","memo_bytes":"aGVsbG8gdW5pdmVyc2U=","_links":{"self":{"href":"https://horizon.stellar.org/transactions/ef0fe04ac3c7de7228ca2598886059868ad05c224a041e8b2d9ee2a8a9dd6894"},"account":{"href":"https://horizon.stellar.org/accounts/GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU"},"ledger":{"href":"https://horizon.stellar.org/ledgers/27984461"},"operations":{"href":"https://horizon.stellar.org/transactions/ef0fe04ac3c7de7228ca2598886059868ad05c224a041e8b2d9ee2a8a9dd6894/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/ef0fe04ac3c7de7228ca2598886059868ad05c224a041e8b2d9ee2a8a9dd6894/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=120192344791343104"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=120192344791343104"},"transaction":{"href":"https://horizon.stellar.org/transactions/ef0fe04ac3c7de7228ca2598886059868ad05c224a041e8b2d9ee2a8a9dd6894"}},"id":"ef0fe04ac3c7de7228ca2598886059868ad05c224a041e8b2d9ee2a8a9dd6894","paging_token":"120192344791343104","successful":true,"hash":"ef0fe04ac3c7de7228ca2598886059868ad05c224a041e8b2d9ee2a8a9dd6894","ledger":27984461,"created_at":"2020-01-29T19:43:59Z","source_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","source_account_sequence":"94658837230911490","fee_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAAGpZ5X06Hz48sKzzVFo//X67YFenBLxaxzuJcPuXebqxAAAAZAFQS7YAAAACAAAAAQAAAAAAAAAAAAAAAF4x4NYAAAABAAAADmhlbGxvIHVuaXZlcnNlAAAAAAABAAAAAAAAAAAAAAAAMOWtdEZJweWBDrIVGDQOVodinrlXbfzBfquR7AFtxW4AAAAAATEtAAAAAAAAAAABl3m6sQAAAEDwdDlpQv5IfweTkLjytpWIa+bpQv7BAHRFpMCHscM3g+WBKjXPVEnSP1BghLuy3uhvgv4LnCkI+gFEDZxwV/YF","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAasCTQAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACzQs6uAFQS7YAAAABAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAasCTQAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACzQs6uAFQS7YAAAACAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAAAwAAAAMBqwJNAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALNCzq4AVBLtgAAAAIAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBqwJNAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALL2g24AVBLtgAAAAIAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAABqwJNAAAAAAAAAAAw5a10RknB5YEOshUYNA5Wh2KeuVdt/MF+q5HsAW3FbgAAAAABMS0AAasCTQAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMBnbxLAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALNCzscAVBLtgAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBqwJNAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALNCzq4AVBLtgAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"text","signatures":["8HQ5aUL+SH8Hk5C48raViGvm6UL+wQB0RaTAh7HDN4PlgSo1z1RJ0j9QYIS7st7ob4L+C5wpCPoBRA2ccFf2BQ=="],"valid_after":"1970-01-01T00:00:00Z","valid_before":"2020-01-29T19:45:26Z","preconditions":{"timebounds":{"min_time":"0","max_time":"1580327126"}}},{"_links":{"self":{"href":"https://horizon.stellar.org/transactions/c1cb850f413e4038c4120bd9badc07bb8ef85a46649a4d5c9c16e578a2d30589"},"account":{"href":"https://horizon.stellar.org/accounts/GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU"},"ledger":{"href":"https://horizon.stellar.org/ledgers/27984467"},"operations":{"href":"https://horizon.stellar.org/transactions/c1cb850f413e4038c4120bd9badc07bb8ef85a46649a4d5c9c16e578a2d30589/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/c1cb850f413e4038c4120bd9badc07bb8ef85a46649a4d5c9c16e578a2d30589/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=120192370561220608"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=120192370561220608"},"transaction":{"href":"https://horizon.stellar.org/transactions/c1cb850f413e4038c4120bd9badc07bb8ef85a46649a4d5c9c16e578a2d30589"}},"id":"c1cb850f413e4038c4120bd9badc07bb8ef85a46649a4d5c9c16e578a2d30589","paging_token":"120192370561220608","successful":true,"hash":"c1cb850f413e4038c4120bd9badc07bb8ef85a46649a4d5c9c16e578a2d30589","ledger":27984467,"created_at":"2020-01-29T19:44:36Z","source_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","source_account_sequence":"94658837230911491","fee_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAAGpZ5X06Hz48sKzzVFo//X67YFenBLxaxzuJcPuXebqxAAAAZAFQS7YAAAADAAAAAQAAAAAAAAAAAAAAAF4x4PoAAAAAAAAAAQAAAAAAAAABAAAAADDlrXRGScHlgQ6yFRg0DlaHYp65V238wX6rkewBbcVuAAAAAAAAAAB3NZQAAAAAAAAAAAGXebqxAAAAQMzdIubro9XQUTkhf0YbDBNM5tqC/zS7fGb0BLFq+QxXT7VAS7dDMno9A2f1df4nnyeHqVl+CuKcpwwwS04JSgE=","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAABAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAasCUwAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACy9oNVAFQS7YAAAACAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAasCUwAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACy9oNVAFQS7YAAAADAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAABAAAAAMBqwJNAAAAAAAAAAAw5a10RknB5YEOshUYNA5Wh2KeuVdt/MF+q5HsAW3FbgAAAAABMS0AAasCTQAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBqwJTAAAAAAAAAAAw5a10RknB5YEOshUYNA5Wh2KeuVdt/MF+q5HsAW3FbgAAAAB4ZsEAAasCTQAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAMBqwJTAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALL2g1UAVBLtgAAAAMAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBqwJTAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAJUpHlUAVBLtgAAAAMAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMBqwJNAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALL2g24AVBLtgAAAAIAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBqwJTAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAALL2g1UAVBLtgAAAAIAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"none","signatures":["zN0i5uuj1dBROSF/RhsME0zm2oL/NLt8ZvQEsWr5DFdPtUBLt0Myej0DZ/V1/iefJ4epWX4K4pynDDBLTglKAQ=="],"valid_after":"1970-01-01T00:00:00Z","valid_before":"2020-01-29T19:46:02Z","preconditions":{"timebounds":{"min_time":"0","max_time":"1580327162"}}},{"_links":{"self":{"href":"https://horizon.stellar.org/transactions/e0f3d6e327a6de01223a8f0e2b88e97abeaf1f514f95f8e7c55f18b951f09dbe"},"account":{"href":"https://horizon.stellar.org/accounts/GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU"},"ledger":{"href":"https://horizon.stellar.org/ledgers/28000615"},"operations":{"href":"https://horizon.stellar.org/transactions/e0f3d6e327a6de01223a8f0e2b88e97abeaf1f514f95f8e7c55f18b951f09dbe/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/e0f3d6e327a6de01223a8f0e2b88e97abeaf1f514f95f8e7c55f18b951f09dbe/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=120261725693136896"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=120261725693136896"},"transaction":{"href":"https://horizon.stellar.org/transactions/e0f3d6e327a6de01223a8f0e2b88e97abeaf1f514f95f8e7c55f18b951f09dbe"}},"id":"e0f3d6e327a6de01223a8f0e2b88e97abeaf1f514f95f8e7c55f18b951f09dbe","paging_token":"120261725693136896","successful":true,"hash":"e0f3d6e327a6de01223a8f0e2b88e97abeaf1f514f95f8e7c55f18b951f09dbe","ledger":28000615,"created_at":"2020-01-30T21:45:07Z","source_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","source_account_sequence":"94658837230911492","fee_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAAGpZ5X06Hz48sKzzVFo//X67YFenBLxaxzuJcPuXebqxAAAAZAFQS7YAAAAEAAAAAQAAAAAAAAAAAAAAAF4zTrgAAAAAAAAAAQAAAAAAAAABAAAAABhkaLZ/GHrh4vaarKkeK7PX2c581NvMfPvtTyATuVziAAAAAAAAAAAF9eEAAAAAAAAAAAGXebqxAAAAQB9XBu17Olvry7c8CqLJXqvK5csy2r3lGiP3HyR5JcryL8QQjSuwGr/LEFFKIS5Afo/jh9fCzGzJzZQ4DN1KPgs=","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAABAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAatBZwAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACVKR48AFQS7YAAAADAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAatBZwAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACVKR48AFQS7YAAAAEAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAABAAAAAMBq0EQAAAAAAAAAAAYZGi2fxh64eL2mqypHiuz19nOfNTbzHz77U8gE7lc4gAAAAACYljUAatBDAAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBq0FnAAAAAAAAAAAYZGi2fxh64eL2mqypHiuz19nOfNTbzHz77U8gE7lc4gAAAAAIWDnUAatBDAAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAMBq0FnAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAJUpHjwAVBLtgAAAAQAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBq0FnAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAJOrpfwAVBLtgAAAAQAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMBqwJTAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAJUpHlUAVBLtgAAAAMAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBq0FnAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAJUpHjwAVBLtgAAAAMAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"none","signatures":["H1cG7Xs6W+vLtzwKosleq8rlyzLaveUaI/cfJHklyvIvxBCNK7Aav8sQUUohLkB+j+OH18LMbMnNlDgM3Uo+Cw=="],"valid_after":"1970-01-01T00:00:00Z","valid_before":"2020-01-30T21:46:32Z","preconditions":{"timebounds":{"min_time":"0","max_time":"1580420792"}}},{"_links":{"self":{"href":"https://horizon.stellar.org/transactions/329ae48814ae29ed6d9c0bb6e398932e6a178cac21623b63fbf5d8245261c041"},"account":{"href":"https://horizon.stellar.org/accounts/GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU"},"ledger":{"href":"https://horizon.stellar.org/ledgers/28000619"},"operations":{"href":"https://horizon.stellar.org/transactions/329ae48814ae29ed6d9c0bb6e398932e6a178cac21623b63fbf5d8245261c041/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/329ae48814ae29ed6d9c0bb6e398932e6a178cac21623b63fbf5d8245261c041/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=120261742872928256"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=120261742872928256"},"transaction":{"href":"https://horizon.stellar.org/transactions/329ae48814ae29ed6d9c0bb6e398932e6a178cac21623b63fbf5d8245261c041"}},"id":"329ae48814ae29ed6d9c0bb6e398932e6a178cac21623b63fbf5d8245261c041","paging_token":"120261742872928256","successful":true,"hash":"329ae48814ae29ed6d9c0bb6e398932e6a178cac21623b63fbf5d8245261c041","ledger":28000619,"created_at":"2020-01-30T21:45:29Z","source_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","source_account_sequence":"94658837230911493","fee_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAAGpZ5X06Hz48sKzzVFo//X67YFenBLxaxzuJcPuXebqxAAAAZAFQS7YAAAAFAAAAAQAAAAAAAAAAAAAAAF4zTtEAAAAAAAAAAQAAAAAAAAABAAAAABhkaLZ/GHrh4vaarKkeK7PX2c581NvMfPvtTyATuVziAAAAAAAAAAAO5rKAAAAAAAAAAAGXebqxAAAAQFaUIoWWXLurZRFty6iBHmm65K2w5EZjldQcMsB/KeQl1Rh0UkZ7Q44JCDCvntnIhWfkl1Qipr6jZk/I4c+pjw8=","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAABAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAatBawAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACTq6XjAFQS7YAAAAEAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAatBawAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACTq6XjAFQS7YAAAAFAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAABAAAAAMBq0FnAAAAAAAAAAAYZGi2fxh64eL2mqypHiuz19nOfNTbzHz77U8gE7lc4gAAAAAIWDnUAatBDAAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBq0FrAAAAAAAAAAAYZGi2fxh64eL2mqypHiuz19nOfNTbzHz77U8gE7lc4gAAAAAXPuxUAatBDAAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAMBq0FrAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAJOrpeMAVBLtgAAAAUAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBq0FrAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAI/x+UMAVBLtgAAAAUAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMBq0FnAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAJOrpfwAVBLtgAAAAQAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBq0FrAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAJOrpeMAVBLtgAAAAQAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"none","signatures":["VpQihZZcu6tlEW3LqIEeabrkrbDkRmOV1BwywH8p5CXVGHRSRntDjgkIMK+e2ciFZ+SXVCKmvqNmT8jhz6mPDw=="],"valid_after":"1970-01-01T00:00:00Z","valid_before":"2020-01-30T21:46:57Z","preconditions":{"timebounds":{"min_time":"0","max_time":"1580420817"}}},{"_links":{"self":{"href":"https://horizon.stellar.org/transactions/2b8a77c7e42997280b8454e39bd7c681c58ab5b7cc288ff836c1c4b6152dccfe"},"account":{"href":"https://horizon.stellar.org/accounts/GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU"},"ledger":{"href":"https://horizon.stellar.org/ledgers/28210091"},"operations":{"href":"https://horizon.stellar.org/transactions/2b8a77c7e42997280b8454e39bd7c681c58ab5b7cc288ff836c1c4b6152dccfe/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/2b8a77c7e42997280b8454e39bd7c681c58ab5b7cc288ff836c1c4b6152dccfe/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=121161418262413312"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=121161418262413312"},"transaction":{"href":"https://horizon.stellar.org/transactions/2b8a77c7e42997280b8454e39bd7c681c58ab5b7cc288ff836c1c4b6152dccfe"}},"id":"2b8a77c7e42997280b8454e39bd7c681c58ab5b7cc288ff836c1c4b6152dccfe","paging_token":"121161418262413312","successful":true,"hash":"2b8a77c7e42997280b8454e39bd7c681c58ab5b7cc288ff836c1c4b6152dccfe","ledger":28210091,"created_at":"2020-02-13T18:54:50Z","source_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","source_account_sequence":"94658837230911494","fee_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAAGpZ5X06Hz48sKzzVFo//X67YFenBLxaxzuJcPuXebqxAAAAZAFQS7YAAAAGAAAAAQAAAAAAAAAAAAAAAF5Fm9EAAAAAAAAAAQAAAAAAAAAAAAAAADKjrtXFaprjtdoV8mYex4557fEGVYkp83K0vfUwEyVnAAAAAAvrwgAAAAAAAAAAAZd5urEAAABAKCO0IAmQ8hUJVMMfIxu1Q/DgZebmn09dROCFCKSEUZGYuzqlfJPYMrcOJRtf41wwMFK8Wj1g70EAw+ZDhKhJDA==","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAa5zqwAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACP8fkqAFQS7YAAAAFAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAa5zqwAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACP8fkqAFQS7YAAAAGAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAAAwAAAAMBrnOrAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAI/x+SoAVBLtgAAAAYAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBrnOrAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAIz3CKoAVBLtgAAAAYAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAABrnOrAAAAAAAAAAAyo67VxWqa47XaFfJmHseOee3xBlWJKfNytL31MBMlZwAAAAAL68IAAa5zqwAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMBq0FrAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAI/x+UMAVBLtgAAAAUAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBrnOrAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAI/x+SoAVBLtgAAAAUAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"none","signatures":["KCO0IAmQ8hUJVMMfIxu1Q/DgZebmn09dROCFCKSEUZGYuzqlfJPYMrcOJRtf41wwMFK8Wj1g70EAw+ZDhKhJDA=="],"valid_after":"1970-01-01T00:00:00Z","valid_before":"2020-02-13T18:56:17Z","preconditions":{"timebounds":{"min_time":"0","max_time":"1581620177"}}},{"memo":"hello world","memo_bytes":"aGVsbG8gd29ybGQ=","_links":{"self":{"href":"https://horizon.stellar.org/transactions/729e441893075fe40b6a6db0acbe38dd39243417cc8717f968414934331a6260"},"account":{"href":"https://horizon.stellar.org/accounts/GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU"},"ledger":{"href":"https://horizon.stellar.org/ledgers/28211677"},"operations":{"href":"https://horizon.stellar.org/transactions/729e441893075fe40b6a6db0acbe38dd39243417cc8717f968414934331a6260/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/729e441893075fe40b6a6db0acbe38dd39243417cc8717f968414934331a6260/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=121168230080335872"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=121168230080335872"},"transaction":{"href":"https://horizon.stellar.org/transactions/729e441893075fe40b6a6db0acbe38dd39243417cc8717f968414934331a6260"}},"id":"729e441893075fe40b6a6db0acbe38dd39243417cc8717f968414934331a6260","paging_token":"121168230080335872","successful":true,"hash":"729e441893075fe40b6a6db0acbe38dd39243417cc8717f968414934331a6260","ledger":28211677,"created_at":"2020-02-13T21:21:01Z","source_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","source_account_sequence":"94658837230911495","fee_account":"GBVFTZL5HIPT4PFQVTZVIWR77V7LWYCXU4CLYWWHHOEXB64XPG5LDMTU","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAAGpZ5X06Hz48sKzzVFo//X67YFenBLxaxzuJcPuXebqxAAAAZAFQS7YAAAAHAAAAAQAAAAAAAAAAAAAAAF5Fvg4AAAABAAAAC2hlbGxvIHdvcmxkAAAAAAEAAAAAAAAAAAAAAAD7exWPWaCVKiygoj7vEoUox3IdGR0BGEwgrfvu7xj49gAAAAAL68IAAAAAAAAAAAGXebqxAAAAQPNJSRhqEmEaKqtigW3PTPmm0SPF2befw+hH+j7hhDW9L7xDA6FDZlEvFESKAQxWBMQeV9r3D/7Y8tx5uW2WwQk=","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAa553QAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACM9wiRAFQS7YAAAAGAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAa553QAAAAAAAAAAalnlfTofPjywrPNUWj/9frtgV6cEvFrHO4lw+5d5urEAAAACM9wiRAFQS7YAAAAHAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAAAwAAAAMBrnndAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAIz3CJEAVBLtgAAAAcAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBrnndAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAIn8GBEAVBLtgAAAAcAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAABrnndAAAAAAAAAAD7exWPWaCVKiygoj7vEoUox3IdGR0BGEwgrfvu7xj49gAAAAAL68IAAa553QAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMBrnOrAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAIz3CKoAVBLtgAAAAYAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBrnndAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAIz3CJEAVBLtgAAAAYAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"text","signatures":["80lJGGoSYRoqq2KBbc9M+abRI8XZt5/D6Ef6PuGENb0vvEMDoUNmUS8URIoBDFYExB5X2vcP/tjy3Hm5bZbBCQ=="],"valid_after":"1970-01-01T00:00:00Z","valid_before":"2020-02-13T21:22:22Z","preconditions":{"timebounds":{"min_time":"0","max_time":"1581628942"}}},{"memo":"Airdrop invite✅xlmget.org","memo_bytes":"QWlyZHJvcCBpbnZpdGXinIV4bG1nZXQub3Jn","_links":{"self":{"href":"https://horizon.stellar.org/transactions/849fc553ad0a55e75a27ad5a80047a45baa54c321043686cb7f55fa9ef3f7d59"},"account":{"href":"https://horizon.stellar.org/accounts/GBRW5XFS5PANVBWVOHXTR6D6KZN3CEKA2JIROR5NRYQMHT5K67B3SYU7"},"ledger":{"href":"https://horizon.stellar.org/ledgers/28440958"},"operations":{"href":"https://horizon.stellar.org/transactions/849fc553ad0a55e75a27ad5a80047a45baa54c321043686cb7f55fa9ef3f7d59/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/849fc553ad0a55e75a27ad5a80047a45baa54c321043686cb7f55fa9ef3f7d59/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=122152984477229056"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=122152984477229056"},"transaction":{"href":"https://horizon.stellar.org/transactions/849fc553ad0a55e75a27ad5a80047a45baa54c321043686cb7f55fa9ef3f7d59"}},"id":"849fc553ad0a55e75a27ad5a80047a45baa54c321043686cb7f55fa9ef3f7d59","paging_token":"122152984477229056","successful":true,"hash":"849fc553ad0a55e75a27ad5a80047a45baa54c321043686cb7f55fa9ef3f7d59","ledger":28440958,"created_at":"2020-02-28T16:28:42Z","source_account":"GBRW5XFS5PANVBWVOHXTR6D6KZN3CEKA2JIROR5NRYQMHT5K67B3SYU7","source_account_sequence":"122138905574114388","fee_account":"GBRW5XFS5PANVBWVOHXTR6D6KZN3CEKA2JIROR5NRYQMHT5K67B3SYU7","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAAGNu3LLrwNqG1XHvOPh+VluxEUDSURdHrY4gw8+q98O5AAAAZAGx7LAAAARUAAAAAAAAAAEAAAAbQWlyZHJvcCBpbnZpdGXinIV4bG1nZXQub3JnAAAAAAEAAAAAAAAAAQAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAAAAAAAAAGGoAAAAAAAAAABqvfDuQAAAECzK8e8L+dHqGZWsoOwNLgTnFD+Omu3DcVJ4Gwb71ZKsokaH+2hPLf65I6GgIX4pcyz1SgRNuhi0Utg4tGkfGUA","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAABAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAbH5fgAAAAAAAAAAY27csuvA2obVce84+H5WW7ERQNJRF0etjiDDz6r3w7kAAAAAGGO7UAGx7LAAAARTAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAbH5fgAAAAAAAAAAY27csuvA2obVce84+H5WW7ERQNJRF0etjiDDz6r3w7kAAAAAGGO7UAGx7LAAAARUAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAABAAAAAMBrnndAAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAIn8GBEAVBLtgAAAAcAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBsfl+AAAAAAAAAABqWeV9Oh8+PLCs81RaP/1+u2BXpwS8Wsc7iXD7l3m6sQAAAAIn8ebkAVBLtgAAAAcAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAMBsfl+AAAAAAAAAABjbtyy68DahtVx7zj4flZbsRFA0lEXR62OIMPPqvfDuQAAAAAYY7tQAbHssAAABFQAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBsfl+AAAAAAAAAABjbtyy68DahtVx7zj4flZbsRFA0lEXR62OIMPPqvfDuQAAAAAYYjSwAbHssAAABFQAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMBsfl8AAAAAAAAAABjbtyy68DahtVx7zj4flZbsRFA0lEXR62OIMPPqvfDuQAAAAAYY7u0AbHssAAABFMAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBsfl+AAAAAAAAAABjbtyy68DahtVx7zj4flZbsRFA0lEXR62OIMPPqvfDuQAAAAAYY7tQAbHssAAABFMAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"text","signatures":["syvHvC/nR6hmVrKDsDS4E5xQ/jprtw3FSeBsG+9WSrKJGh/toTy3+uSOhoCF+KXMs9UoETboYtFLYOLRpHxlAA=="]}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/accounts/{account_id}/transactions","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve an Account's Transactions","description":{"content":"This endpoint represents successful transactions for a given account and can be used in streaming mode. Streaming mode allows you to listen for new transactions for this account as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known transaction unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream transactions created since your request time.","type":"text/plain"},"url":{"path":["accounts",":account_id","transactions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Set to true to include failed operations in results. Options include true and false.","type":"text/plain"},"key":"include_failed","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) This account’s public key encoded in a base32 string representation.","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/list-all-accounts.api.mdx b/api/horizon/resources/list-all-accounts.api.mdx index 49bdca03d..e1a64bd14 100644 --- a/api/horizon/resources/list-all-accounts.api.mdx +++ b/api/horizon/resources/list-all-accounts.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint lists accounts by one of four filters : signer, asse sidebar_label: "List all Accounts" hide_title: true hide_table_of_contents: true -api: {"tags":["Accounts"],"description":"This endpoint lists accounts by one of four filters : signer, asset, liquidity pool or sponsor.","operationId":"ListAllAccounts","parameters":[{"name":"sponser","in":"query","required":false,"description":"Account ID of the sponsor. Every account in the response will either be sponsored by the given account ID or have a subentry (trustline, offer, or data entry) which is sponsored by the given account ID.","schema":{"type":"string","example":"GDMQQNJM4UL7QIA66P7R2PZHMQINWZBM77BEBMHLFXD5JEUAHGJ7R4JZ"}},{"name":"asset","in":"query","required":false,"description":"An issued asset represented as “Code:IssuerAccountID”. Every account in the response will have a trustline for the given asset."},{"name":"signer","in":"query","required":false,"description":"Account ID of the signer. Every account in the response will have the given account ID as a signer.","schema":{"type":"string","example":"GDMQQNJM4UL7QIA66P7R2PZHMQINWZBM77BEBMHLFXD5JEUAHGJ7R4JZ"}},{"name":"liqudity_pool","in":"query","required":false,"description":"With this parameter, the results will include only accounts which have trustlines to the specified liquidity pool."},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Returns accounts based on provided filter: signer , asset, sponser or liquidity pool","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transactions":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"operations":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"payments":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"offers":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"trades":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"data":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transactions","operations","payments","effects","offers","trades","data"]},"id":{"type":"string","title":"id"},"account_id":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"sequence":{"type":"string","pattern":"[0-9]+","title":"sequence"},"sequence_ledger":{"type":"integer","format":"uint32","title":"sequence_ledger"},"sequence_time":{"type":"string"},"subentry_count":{"type":"integer","format":"int32","title":"subentry_count"},"inflation_destination":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"home_domain":{"type":"string"},"last_modified_ledger":{"type":"integer","format":"uint32","title":"last_modified_ledger"},"last_modified_time":{"type":"string"},"thresholds":{"type":"object","properties":{"low_threshold":{"type":"integer"},"med_threshold":{"type":"integer"},"high_threshold":{"type":"integer"}},"title":"thresholds"},"flags":{"type":"object","properties":{"auth_required":{"type":"boolean"},"auth_revocable":{"type":"boolean"},"auth_immutable":{"type":"boolean"},"auth_clawback_enabled":{"type":"boolean"}},"title":"flags"},"balances":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"balance":{"type":"string","pattern":"[0-9]+\\.[0-9]{7}","title":"currency"},"liquidity_pool_id":{"type":"string"},"limit":{"type":"string","pattern":"[0-9]+\\.[0-9]{7}","title":"currency"},"buying_liabilites":{"type":"string","pattern":"[0-9]+\\.[0-9]{7}","title":"currency"},"selling_liabilites":{"type":"string","pattern":"[0-9]+\\.[0-9]{7}","title":"currency"},"sponser":{"type":"string"},"last_modified_ledger":{"type":"integer","format":"uint32","title":"last_modified_ledger"},"is_authorized":{"type":"boolean"},"is_authorized_to_maintain_liabilites":{"type":"boolean"},"is_clawback_enabled":{"type":"boolean"},"asset_type":{"type":"string","enum":["native"]}},"required":["balance","limit","asset_type","buying_liabilites","selling_liabilites","last_modified_ledger","is_authorized","is_authorized_to_maintain_liabilites","is_clawback_enabled"],"title":"BalanceLineNative"},{"type":"object","properties":{"balance":{"type":"string","pattern":"[0-9]+\\.[0-9]{7}","title":"currency"},"limit":{"type":"string","pattern":"[0-9]+\\.[0-9]{7}","title":"currency"},"buying_liabilites":{"type":"string","pattern":"[0-9]+\\.[0-9]{7}","title":"currency"},"selling_liabilites":{"type":"string","pattern":"[0-9]+\\.[0-9]{7}","title":"currency"},"sponser":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"last_modified_ledger":{"type":"integer","format":"uint32","title":"last_modified_ledger"},"is_authorized":{"type":"boolean"},"is_authorized_to_maintain_liabilites":{"type":"boolean"},"is_clawback_enabled":{"type":"boolean"},"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["balance","limit","asset_type","asset_code","asset_issuer","buying_liabilites","selling_liabilites","last_modified_ledger","is_authorized","is_authorized_to_maintain_liabilites","is_clawback_enabled"],"title":"BalanceLineAsset"},{"type":"object","properties":{"liquidity_pool_id":{"type":"string"},"asset_type":{"type":"string","enum":["liquidity_pool_shares"]},"balance":{"type":"string","pattern":"[0-9]+\\.[0-9]{7}","title":"currency"},"limit":{"type":"string","pattern":"[0-9]+\\.[0-9]{7}","title":"currency"},"last_modified_ledger":{"type":"integer","format":"uint32","title":"last_modified_ledger"},"sponser":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"is_authorized":{"type":"boolean"},"is_authorized_to_maintain_liabilites":{"type":"boolean"},"is_clawback_enabled":{"type":"boolean"}},"required":["liquidity_pool_id","balance","limit","asset_type","last_modified_ledger","is_authorized","is_authorized_to_maintain_liabilites","is_clawback_enabled"],"title":"BalanceLineLiquidityPool"}]}},"signers":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"weight":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["ed25519_public_key","sha256_hash","preauth_tx"]},"sponser":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["key","weight","type"],"title":"signers"}},"data":{"type":"object"},"num_sponsoring":{"type":"integer"},"num_sponsered":{"type":"integer"},"sponser":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"paging_token":{"type":"string"}},"required":["id","account_id","sequence","subentry_count","last_modified_ledger","last_modified_time","thresholds","flags","balances","signers","data","num_sponsoring","num_sponsered","paging_token"]}}}}},"title":"Account"}]},"examples":{"ListAllAccounts":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/accounts?cursor=&limit=10&order=asc&signer=GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U"},"next":{"href":"https://horizon.stellar.org/accounts?cursor=GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U&limit=10&order=asc&signer=GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U"},"prev":{"href":"https://horizon.stellar.org/accounts?cursor=GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U&limit=10&order=desc&signer=GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/accounts/GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U"},"transactions":{"href":"https://horizon.stellar.org/accounts/GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U/transactions{?cursor,limit,order}","templated":true},"operations":{"href":"https://horizon.stellar.org/accounts/GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U/operations{?cursor,limit,order}","templated":true},"payments":{"href":"https://horizon.stellar.org/accounts/GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U/payments{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/accounts/GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U/effects{?cursor,limit,order}","templated":true},"offers":{"href":"https://horizon.stellar.org/accounts/GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U/offers{?cursor,limit,order}","templated":true},"trades":{"href":"https://horizon.stellar.org/accounts/GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U/trades{?cursor,limit,order}","templated":true},"data":{"href":"https://horizon.stellar.org/accounts/GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U/data/{key}","templated":true}},"id":"GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U","account_id":"GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U","sequence":"24739097524306474","subentry_count":3,"inflation_destination":"GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U","home_domain":"tempo.eu.com","last_modified_ledger":40074676,"last_modified_time":"2022-03-17T23:13:54Z","thresholds":{"low_threshold":5,"med_threshold":0,"high_threshold":0},"flags":{"auth_required":false,"auth_revocable":true,"auth_immutable":false,"auth_clawback_enabled":false},"balances":[{"balance":"0.0000000","limit":"922337203685.4775807","buying_liabilities":"0.0000000","selling_liabilities":"0.0000000","last_modified_ledger":40074670,"is_authorized":true,"is_authorized_to_maintain_liabilities":true,"asset_type":"credit_alphanum4","asset_code":"EURT","asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"},{"balance":"0.0000000","limit":"922337203685.4775807","buying_liabilities":"0.0000000","selling_liabilities":"0.0000000","last_modified_ledger":20213845,"is_authorized":true,"is_authorized_to_maintain_liabilities":true,"asset_type":"credit_alphanum4","asset_code":"NGN","asset_issuer":"GCC4YLCR7DDWFCIPTROQM7EB2QMFD35XRWEQVIQYJQHVW6VE5MJZXIGW"},{"balance":"0.0000000","limit":"922337203685.4775807","buying_liabilities":"0.0000000","selling_liabilities":"0.0000000","last_modified_ledger":7877447,"is_authorized":false,"is_authorized_to_maintain_liabilities":false,"asset_type":"credit_alphanum4","asset_code":"PHP","asset_issuer":"GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP"},{"balance":"80.8944518","buying_liabilities":"0.0000000","selling_liabilities":"0.0000000","asset_type":"native"}],"signers":[{"weight":10,"key":"GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U","type":"ed25519_public_key"}],"data":{},"num_sponsoring":0,"num_sponsored":0,"paging_token":"GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U"}]}}}}}}}},"method":"get","path":"/accounts","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"List all Accounts","description":{"content":"This endpoint lists accounts by one of four filters : signer, asset, liquidity pool or sponsor.","type":"text/plain"},"url":{"path":["accounts"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Account ID of the sponsor. Every account in the response will either be sponsored by the given account ID or have a subentry (trustline, offer, or data entry) which is sponsored by the given account ID.","type":"text/plain"},"key":"sponser","value":""},{"description":{"content":"An issued asset represented as “Code:IssuerAccountID”. Every account in the response will have a trustline for the given asset.","type":"text/plain"},"key":"asset","value":""},{"disabled":false,"description":{"content":"Account ID of the signer. Every account in the response will have the given account ID as a signer.","type":"text/plain"},"key":"signer","value":""},{"description":{"content":"With this parameter, the results will include only accounts which have trustlines to the specified liquidity pool.","type":"text/plain"},"key":"liqudity_pool","value":""},{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Accounts"],"description":"This endpoint lists accounts by one of four filters : signer, asset, liquidity pool or sponsor.","operationId":"ListAllAccounts","parameters":[{"name":"sponser","in":"query","required":false,"description":"Account ID of the sponsor. Every account in the response will either be sponsored by the given account ID or have a subentry (trustline, offer, or data entry) which is sponsored by the given account ID.","schema":{"type":"string","example":"GDMQQNJM4UL7QIA66P7R2PZHMQINWZBM77BEBMHLFXD5JEUAHGJ7R4JZ"}},{"name":"asset","in":"query","required":false,"description":"An issued asset represented as “Code:IssuerAccountID”. Every account in the response will have a trustline for the given asset."},{"name":"signer","in":"query","required":false,"description":"Account ID of the signer. Every account in the response will have the given account ID as a signer.","schema":{"type":"string","example":"GDMQQNJM4UL7QIA66P7R2PZHMQINWZBM77BEBMHLFXD5JEUAHGJ7R4JZ"}},{"name":"liqudity_pool","in":"query","required":false,"description":"With this parameter, the results will include only accounts which have trustlines to the specified liquidity pool."},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Returns accounts based on provided filter: signer , asset, sponser or liquidity pool","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transactions":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"operations":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"payments":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"offers":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"trades":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"data":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transactions","operations","payments","effects","offers","trades","data"]},"id":{"type":"string","title":"id"},"account_id":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"sequence":{"type":"string","pattern":"[0-9]+","title":"sequence"},"sequence_ledger":{"type":"integer","format":"uint32","title":"sequence_ledger"},"sequence_time":{"type":"string"},"subentry_count":{"type":"integer","format":"int32","title":"subentry_count"},"inflation_destination":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"home_domain":{"type":"string"},"last_modified_ledger":{"type":"integer","format":"uint32","title":"last_modified_ledger"},"last_modified_time":{"type":"string"},"thresholds":{"type":"object","properties":{"low_threshold":{"type":"integer"},"med_threshold":{"type":"integer"},"high_threshold":{"type":"integer"}},"title":"thresholds"},"flags":{"type":"object","properties":{"auth_required":{"type":"boolean"},"auth_revocable":{"type":"boolean"},"auth_immutable":{"type":"boolean"},"auth_clawback_enabled":{"type":"boolean"}},"title":"flags"},"balances":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"balance":{"type":"string","pattern":"[0-9]+\\.[0-9]{7}","title":"currency"},"liquidity_pool_id":{"type":"string"},"limit":{"type":"string","pattern":"[0-9]+\\.[0-9]{7}","title":"currency"},"buying_liabilites":{"type":"string","pattern":"[0-9]+\\.[0-9]{7}","title":"currency"},"selling_liabilites":{"type":"string","pattern":"[0-9]+\\.[0-9]{7}","title":"currency"},"sponser":{"type":"string"},"last_modified_ledger":{"type":"integer","format":"uint32","title":"last_modified_ledger"},"is_authorized":{"type":"boolean"},"is_authorized_to_maintain_liabilites":{"type":"boolean"},"is_clawback_enabled":{"type":"boolean"},"asset_type":{"type":"string","enum":["native"]}},"required":["balance","limit","asset_type","buying_liabilites","selling_liabilites","last_modified_ledger","is_authorized","is_authorized_to_maintain_liabilites","is_clawback_enabled"],"title":"BalanceLineNative"},{"type":"object","properties":{"balance":{"type":"string","pattern":"[0-9]+\\.[0-9]{7}","title":"currency"},"limit":{"type":"string","pattern":"[0-9]+\\.[0-9]{7}","title":"currency"},"buying_liabilites":{"type":"string","pattern":"[0-9]+\\.[0-9]{7}","title":"currency"},"selling_liabilites":{"type":"string","pattern":"[0-9]+\\.[0-9]{7}","title":"currency"},"sponser":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"last_modified_ledger":{"type":"integer","format":"uint32","title":"last_modified_ledger"},"is_authorized":{"type":"boolean"},"is_authorized_to_maintain_liabilites":{"type":"boolean"},"is_clawback_enabled":{"type":"boolean"},"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["balance","limit","asset_type","asset_code","asset_issuer","buying_liabilites","selling_liabilites","last_modified_ledger","is_authorized","is_authorized_to_maintain_liabilites","is_clawback_enabled"],"title":"BalanceLineAsset"},{"type":"object","properties":{"liquidity_pool_id":{"type":"string"},"asset_type":{"type":"string","enum":["liquidity_pool_shares"]},"balance":{"type":"string","pattern":"[0-9]+\\.[0-9]{7}","title":"currency"},"limit":{"type":"string","pattern":"[0-9]+\\.[0-9]{7}","title":"currency"},"last_modified_ledger":{"type":"integer","format":"uint32","title":"last_modified_ledger"},"sponser":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"is_authorized":{"type":"boolean"},"is_authorized_to_maintain_liabilites":{"type":"boolean"},"is_clawback_enabled":{"type":"boolean"}},"required":["liquidity_pool_id","balance","limit","asset_type","last_modified_ledger","is_authorized","is_authorized_to_maintain_liabilites","is_clawback_enabled"],"title":"BalanceLineLiquidityPool"}]}},"signers":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"weight":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["ed25519_public_key","sha256_hash","preauth_tx"]},"sponser":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["key","weight","type"],"title":"signers"}},"data":{"type":"object"},"num_sponsoring":{"type":"integer"},"num_sponsered":{"type":"integer"},"sponser":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"paging_token":{"type":"string"}},"required":["id","account_id","sequence","subentry_count","last_modified_ledger","last_modified_time","thresholds","flags","balances","signers","data","num_sponsoring","num_sponsered","paging_token"]}}}}},"title":"Account"}]},"examples":{"ListAllAccounts":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/accounts?cursor=&limit=10&order=asc&signer=GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U"},"next":{"href":"https://horizon.stellar.org/accounts?cursor=GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U&limit=10&order=asc&signer=GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U"},"prev":{"href":"https://horizon.stellar.org/accounts?cursor=GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U&limit=10&order=desc&signer=GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/accounts/GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U"},"transactions":{"href":"https://horizon.stellar.org/accounts/GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U/transactions{?cursor,limit,order}","templated":true},"operations":{"href":"https://horizon.stellar.org/accounts/GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U/operations{?cursor,limit,order}","templated":true},"payments":{"href":"https://horizon.stellar.org/accounts/GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U/payments{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/accounts/GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U/effects{?cursor,limit,order}","templated":true},"offers":{"href":"https://horizon.stellar.org/accounts/GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U/offers{?cursor,limit,order}","templated":true},"trades":{"href":"https://horizon.stellar.org/accounts/GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U/trades{?cursor,limit,order}","templated":true},"data":{"href":"https://horizon.stellar.org/accounts/GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U/data/{key}","templated":true}},"id":"GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U","account_id":"GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U","sequence":"24739097524306474","subentry_count":3,"inflation_destination":"GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U","home_domain":"tempo.eu.com","last_modified_ledger":40074676,"last_modified_time":"2022-03-17T23:13:54Z","thresholds":{"low_threshold":5,"med_threshold":0,"high_threshold":0},"flags":{"auth_required":false,"auth_revocable":true,"auth_immutable":false,"auth_clawback_enabled":false},"balances":[{"balance":"0.0000000","limit":"922337203685.4775807","buying_liabilities":"0.0000000","selling_liabilities":"0.0000000","last_modified_ledger":40074670,"is_authorized":true,"is_authorized_to_maintain_liabilities":true,"asset_type":"credit_alphanum4","asset_code":"EURT","asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"},{"balance":"0.0000000","limit":"922337203685.4775807","buying_liabilities":"0.0000000","selling_liabilities":"0.0000000","last_modified_ledger":20213845,"is_authorized":true,"is_authorized_to_maintain_liabilities":true,"asset_type":"credit_alphanum4","asset_code":"NGN","asset_issuer":"GCC4YLCR7DDWFCIPTROQM7EB2QMFD35XRWEQVIQYJQHVW6VE5MJZXIGW"},{"balance":"0.0000000","limit":"922337203685.4775807","buying_liabilities":"0.0000000","selling_liabilities":"0.0000000","last_modified_ledger":7877447,"is_authorized":false,"is_authorized_to_maintain_liabilities":false,"asset_type":"credit_alphanum4","asset_code":"PHP","asset_issuer":"GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP"},{"balance":"80.8944518","buying_liabilities":"0.0000000","selling_liabilities":"0.0000000","asset_type":"native"}],"signers":[{"weight":10,"key":"GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U","type":"ed25519_public_key"}],"data":{},"num_sponsoring":0,"num_sponsored":0,"paging_token":"GDI73WJ4SX7LOG3XZDJC3KCK6ED6E5NBYK2JUBQSPBCNNWEG3ZN7T75U"}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/accounts","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"List all Accounts","description":{"content":"This endpoint lists accounts by one of four filters : signer, asset, liquidity pool or sponsor.","type":"text/plain"},"url":{"path":["accounts"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Account ID of the sponsor. Every account in the response will either be sponsored by the given account ID or have a subentry (trustline, offer, or data entry) which is sponsored by the given account ID.","type":"text/plain"},"key":"sponser","value":""},{"description":{"content":"An issued asset represented as “Code:IssuerAccountID”. Every account in the response will have a trustline for the given asset.","type":"text/plain"},"key":"asset","value":""},{"disabled":false,"description":{"content":"Account ID of the signer. Every account in the response will have the given account ID as a signer.","type":"text/plain"},"key":"signer","value":""},{"description":{"content":"With this parameter, the results will include only accounts which have trustlines to the specified liquidity pool.","type":"text/plain"},"key":"liqudity_pool","value":""},{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/list-all-assets.api.mdx b/api/horizon/resources/list-all-assets.api.mdx index 995464b97..73e8b83d9 100644 --- a/api/horizon/resources/list-all-assets.api.mdx +++ b/api/horizon/resources/list-all-assets.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint lists all assets." sidebar_label: "List all Assets" hide_title: true hide_table_of_contents: true -api: {"tags":["Assets"],"description":"This endpoint lists all assets.","operationId":"ListAllAssets","parameters":[{"name":"asset_code","in":"query","required":false,"description":"The code of the asset you would like to filter by."},{"name":"asset_issuer","in":"query","required":false,"description":"The Stellar address of the issuer for the asset you would like to filter by."},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"toml":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}},"asset_type":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"paging_token":{"type":"string"},"accounts":{"type":"object","properties":{"authorized":{"type":"integer"},"authorized_to_maintain_liabilities":{"type":"integer"},"unauthorized":{"type":"integer"}}},"num_claimable_balances":{"type":"integer"},"num_contracts":{"type":"integer"},"num_liquidity_pools":{"type":"integer"},"balances":{"type":"object","properties":{"authorized":{"type":"string"},"authorized_to_maintain_liabilities":{"type":"string"},"unauthorized":{"type":"string"}}},"claimable_balances_amount":{"type":"string"},"contracts_amount":{"type":"string"},"liquidity_pools_amount":{"type":"string"},"amount":{"type":"string"},"num_accounts":{"type":"integer"},"flags":{"type":"object","properties":{"auth_required":{"type":"boolean"},"auth_revocable":{"type":"boolean"},"auth_immutable":{"type":"boolean"}}}}}}}}},"title":"Asset"}]},"examples":{"ListAllAssets":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/assets?asset_code=CNY&cursor=&limit=3&order=asc"},"next":{"href":"https://horizon.stellar.org/assets?asset_code=CNY&cursor=CNY_GABGBJYLIC2OGATH3DVW22UEB66TFMWC3VKTAPFIOINVESRZLFKIHA4I_credit_alphanum4&limit=3&order=asc"},"prev":{"href":"https://horizon.stellar.org/assets?asset_code=CNY&cursor=CNY_GA6VXTS64XUOCQZSBAYHD24ZYJYPNB3KJ2CVKSYIE43P2DQQIX74UT2A_credit_alphanum4&limit=3&order=desc"}},"_embedded":{"records":[{"_links":{"toml":{"href":"https://swisscustodys.org/.well-known/stellar.toml"}},"asset_type":"credit_alphanum4","asset_code":"CNY","asset_issuer":"GA6VXTS64XUOCQZSBAYHD24ZYJYPNB3KJ2CVKSYIE43P2DQQIX74UT2A","paging_token":"CNY_GA6VXTS64XUOCQZSBAYHD24ZYJYPNB3KJ2CVKSYIE43P2DQQIX74UT2A_credit_alphanum4","num_accounts":10,"num_claimable_balances":0,"num_contracts":0,"num_liquidity_pools":0,"amount":"899996000000.0000000","accounts":{"authorized":10,"authorized_to_maintain_liabilities":0,"unauthorized":0},"claimable_balances_amount":"0.0000000","contracts_amount":"0.0000000","liquidity_pools_amount":"0.0000000","balances":{"authorized":"899996000000.0000000","authorized_to_maintain_liabilities":"0.0000000","unauthorized":"0.0000000"},"flags":{"auth_required":false,"auth_revocable":false,"auth_immutable":false,"auth_clawback_enabled":false}},{"_links":{"toml":{"href":"https://StellarAssets.org/fx/.well-known/stellar.toml"}},"asset_type":"credit_alphanum4","asset_code":"CNY","asset_issuer":"GAASPHILC6DCBPP2P4T66QNSYF6C6OGN6DK36NY4G5SBR7AWH75TJG7N","paging_token":"CNY_GAASPHILC6DCBPP2P4T66QNSYF6C6OGN6DK36NY4G5SBR7AWH75TJG7N_credit_alphanum4","num_accounts":43,"num_claimable_balances":0,"num_contracts":0,"num_liquidity_pools":0,"amount":"1.0000000","accounts":{"authorized":43,"authorized_to_maintain_liabilities":0,"unauthorized":0},"claimable_balances_amount":"0.0000000","contracts_amount":"0.0000000","liquidity_pools_amount":"0.0000000","balances":{"authorized":"1.0000000","authorized_to_maintain_liabilities":"0.0000000","unauthorized":"0.0000000"},"flags":{"auth_required":false,"auth_revocable":true,"auth_immutable":false,"auth_clawback_enabled":true}},{"_links":{"toml":{"href":"https://masterstellar.com/.well-known/stellar.toml"}},"asset_type":"credit_alphanum4","asset_code":"CNY","asset_issuer":"GABGBJYLIC2OGATH3DVW22UEB66TFMWC3VKTAPFIOINVESRZLFKIHA4I","paging_token":"CNY_GABGBJYLIC2OGATH3DVW22UEB66TFMWC3VKTAPFIOINVESRZLFKIHA4I_credit_alphanum4","num_accounts":1,"num_claimable_balances":0,"num_contracts":0,"num_liquidity_pools":0,"amount":"65000000000.0000000","accounts":{"authorized":1,"authorized_to_maintain_liabilities":0,"unauthorized":0},"claimable_balances_amount":"0.0000000","contracts_amount":"0.0000000","liquidity_pools_amount":"0.0000000","balances":{"authorized":"65000000000.0000000","authorized_to_maintain_liabilities":"0.0000000","unauthorized":"0.0000000"},"flags":{"auth_required":false,"auth_revocable":false,"auth_immutable":false,"auth_clawback_enabled":false}}]}}}}}}}},"method":"get","path":"/assets","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"List all Assets","description":{"content":"This endpoint lists all assets.","type":"text/plain"},"url":{"path":["assets"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"The code of the asset you would like to filter by.","type":"text/plain"},"key":"asset_code","value":""},{"description":{"content":"The Stellar address of the issuer for the asset you would like to filter by.","type":"text/plain"},"key":"asset_issuer","value":""},{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Assets"],"description":"This endpoint lists all assets.","operationId":"ListAllAssets","parameters":[{"name":"asset_code","in":"query","required":false,"description":"The code of the asset you would like to filter by."},{"name":"asset_issuer","in":"query","required":false,"description":"The Stellar address of the issuer for the asset you would like to filter by."},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"toml":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}},"asset_type":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"paging_token":{"type":"string"},"accounts":{"type":"object","properties":{"authorized":{"type":"integer"},"authorized_to_maintain_liabilities":{"type":"integer"},"unauthorized":{"type":"integer"}}},"num_claimable_balances":{"type":"integer"},"num_contracts":{"type":"integer"},"num_liquidity_pools":{"type":"integer"},"balances":{"type":"object","properties":{"authorized":{"type":"string"},"authorized_to_maintain_liabilities":{"type":"string"},"unauthorized":{"type":"string"}}},"claimable_balances_amount":{"type":"string"},"contracts_amount":{"type":"string"},"liquidity_pools_amount":{"type":"string"},"amount":{"type":"string"},"num_accounts":{"type":"integer"},"flags":{"type":"object","properties":{"auth_required":{"type":"boolean"},"auth_revocable":{"type":"boolean"},"auth_immutable":{"type":"boolean"}}}}}}}}},"title":"Asset"}]},"examples":{"ListAllAssets":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/assets?asset_code=CNY&cursor=&limit=3&order=asc"},"next":{"href":"https://horizon.stellar.org/assets?asset_code=CNY&cursor=CNY_GABGBJYLIC2OGATH3DVW22UEB66TFMWC3VKTAPFIOINVESRZLFKIHA4I_credit_alphanum4&limit=3&order=asc"},"prev":{"href":"https://horizon.stellar.org/assets?asset_code=CNY&cursor=CNY_GA6VXTS64XUOCQZSBAYHD24ZYJYPNB3KJ2CVKSYIE43P2DQQIX74UT2A_credit_alphanum4&limit=3&order=desc"}},"_embedded":{"records":[{"_links":{"toml":{"href":"https://swisscustodys.org/.well-known/stellar.toml"}},"asset_type":"credit_alphanum4","asset_code":"CNY","asset_issuer":"GA6VXTS64XUOCQZSBAYHD24ZYJYPNB3KJ2CVKSYIE43P2DQQIX74UT2A","paging_token":"CNY_GA6VXTS64XUOCQZSBAYHD24ZYJYPNB3KJ2CVKSYIE43P2DQQIX74UT2A_credit_alphanum4","num_accounts":10,"num_claimable_balances":0,"num_contracts":0,"num_liquidity_pools":0,"amount":"899996000000.0000000","accounts":{"authorized":10,"authorized_to_maintain_liabilities":0,"unauthorized":0},"claimable_balances_amount":"0.0000000","contracts_amount":"0.0000000","liquidity_pools_amount":"0.0000000","balances":{"authorized":"899996000000.0000000","authorized_to_maintain_liabilities":"0.0000000","unauthorized":"0.0000000"},"flags":{"auth_required":false,"auth_revocable":false,"auth_immutable":false,"auth_clawback_enabled":false}},{"_links":{"toml":{"href":"https://StellarAssets.org/fx/.well-known/stellar.toml"}},"asset_type":"credit_alphanum4","asset_code":"CNY","asset_issuer":"GAASPHILC6DCBPP2P4T66QNSYF6C6OGN6DK36NY4G5SBR7AWH75TJG7N","paging_token":"CNY_GAASPHILC6DCBPP2P4T66QNSYF6C6OGN6DK36NY4G5SBR7AWH75TJG7N_credit_alphanum4","num_accounts":43,"num_claimable_balances":0,"num_contracts":0,"num_liquidity_pools":0,"amount":"1.0000000","accounts":{"authorized":43,"authorized_to_maintain_liabilities":0,"unauthorized":0},"claimable_balances_amount":"0.0000000","contracts_amount":"0.0000000","liquidity_pools_amount":"0.0000000","balances":{"authorized":"1.0000000","authorized_to_maintain_liabilities":"0.0000000","unauthorized":"0.0000000"},"flags":{"auth_required":false,"auth_revocable":true,"auth_immutable":false,"auth_clawback_enabled":true}},{"_links":{"toml":{"href":"https://masterstellar.com/.well-known/stellar.toml"}},"asset_type":"credit_alphanum4","asset_code":"CNY","asset_issuer":"GABGBJYLIC2OGATH3DVW22UEB66TFMWC3VKTAPFIOINVESRZLFKIHA4I","paging_token":"CNY_GABGBJYLIC2OGATH3DVW22UEB66TFMWC3VKTAPFIOINVESRZLFKIHA4I_credit_alphanum4","num_accounts":1,"num_claimable_balances":0,"num_contracts":0,"num_liquidity_pools":0,"amount":"65000000000.0000000","accounts":{"authorized":1,"authorized_to_maintain_liabilities":0,"unauthorized":0},"claimable_balances_amount":"0.0000000","contracts_amount":"0.0000000","liquidity_pools_amount":"0.0000000","balances":{"authorized":"65000000000.0000000","authorized_to_maintain_liabilities":"0.0000000","unauthorized":"0.0000000"},"flags":{"auth_required":false,"auth_revocable":false,"auth_immutable":false,"auth_clawback_enabled":false}}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/assets","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"List all Assets","description":{"content":"This endpoint lists all assets.","type":"text/plain"},"url":{"path":["assets"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"The code of the asset you would like to filter by.","type":"text/plain"},"key":"asset_code","value":""},{"description":{"content":"The Stellar address of the issuer for the asset you would like to filter by.","type":"text/plain"},"key":"asset_issuer","value":""},{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/list-all-effects.api.mdx b/api/horizon/resources/list-all-effects.api.mdx index d78feff70..345968977 100644 --- a/api/horizon/resources/list-all-effects.api.mdx +++ b/api/horizon/resources/list-all-effects.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint lists all effects and can be used in streaming mode. sidebar_label: "List All Effects" hide_title: true hide_table_of_contents: true -api: {"tags":["Effects"],"description":"This endpoint lists all effects and can be used in streaming mode. Streaming mode allows you to listen for new effects as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known effect unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream effects created since your request time.","operationId":"ListAllEffects","parameters":[{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"operation":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}},"id":{"type":"string","title":"id"},"paging_token":{"type":"string","title":"paging_token"},"account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","enum":["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":{"type":"number","example":1},"created_at":{"type":"string"}}}}},"required":["id","paging_token","account","type","type_i","created_at"]}},"title":"Effect"}]},"examples":{"ListAllEffects":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/effects?cursor=&limit=10&order=asc"},"next":{"href":"https://horizon.stellar.org/effects?cursor=33676838572034-1&limit=10&order=asc"},"prev":{"href":"https://horizon.stellar.org/effects?cursor=12884905985-1&limit=10&order=desc"}},"_embedded":{"records":[{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/12884905985"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905985-1"},"precedes":{"href":"https://horizon.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.stellar.org/operations/12884905985"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905985-2"},"precedes":{"href":"https://horizon.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"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/12884905985"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905985-3"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=12884905985-3"}},"id":"0000000012884905985-0000000003","paging_token":"12884905985-3","account":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB","type":"signer_created","type_i":10,"created_at":"2015-09-30T17:15:54Z","weight":1,"public_key":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB","key":""},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/12884905986"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905986-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=12884905986-1"}},"id":"0000000012884905986-0000000001","paging_token":"12884905986-1","account":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB","type":"account_credited","type_i":2,"created_at":"2015-09-30T17:15:54Z","asset_type":"native","amount":"99999999959.9999700"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/12884905986"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905986-2"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=12884905986-2"}},"id":"0000000012884905986-0000000002","paging_token":"12884905986-2","account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"account_debited","type_i":3,"created_at":"2015-09-30T17:15:54Z","asset_type":"native","amount":"99999999959.9999700"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/12884905987"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905987-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=12884905987-1"}},"id":"0000000012884905987-0000000001","paging_token":"12884905987-1","account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"signer_removed","type_i":11,"created_at":"2015-09-30T17:15:54Z","weight":0,"public_key":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","key":""},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/33676838572033"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=33676838572033-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=33676838572033-1"}},"id":"0000033676838572033-0000000001","paging_token":"33676838572033-1","account":"GAP2KHWUMOHY7IO37UJY7SEBIITJIDZS5DRIIQRPEUT4VUKHZQGIRWS4","type":"account_created","type_i":0,"created_at":"2015-10-01T04:15:01Z","starting_balance":"20.0000000"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/33676838572033"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=33676838572033-2"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=33676838572033-2"}},"id":"0000033676838572033-0000000002","paging_token":"33676838572033-2","account":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB","type":"account_debited","type_i":3,"created_at":"2015-10-01T04:15:01Z","asset_type":"native","amount":"20.0000000"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/33676838572033"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=33676838572033-3"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=33676838572033-3"}},"id":"0000033676838572033-0000000003","paging_token":"33676838572033-3","account":"GAP2KHWUMOHY7IO37UJY7SEBIITJIDZS5DRIIQRPEUT4VUKHZQGIRWS4","type":"signer_created","type_i":10,"created_at":"2015-10-01T04:15:01Z","weight":1,"public_key":"GAP2KHWUMOHY7IO37UJY7SEBIITJIDZS5DRIIQRPEUT4VUKHZQGIRWS4","key":""},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/33676838572034"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=33676838572034-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=33676838572034-1"}},"id":"0000033676838572034-0000000001","paging_token":"33676838572034-1","account":"GCZTBYH66ISTZKUPVJWTMHWBH4S4JIJ7WNLQJXCTQJKWY3FIT34BWZCJ","type":"account_created","type_i":0,"created_at":"2015-10-01T04:15:01Z","starting_balance":"20.0000000"}]}}}}}}}},"method":"get","path":"/effects","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"List All Effects","description":{"content":"This endpoint lists all effects and can be used in streaming mode. Streaming mode allows you to listen for new effects as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known effect unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream effects created since your request time.","type":"text/plain"},"url":{"path":["effects"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Effects"],"description":"This endpoint lists all effects and can be used in streaming mode. Streaming mode allows you to listen for new effects as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known effect unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream effects created since your request time.","operationId":"ListAllEffects","parameters":[{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"operation":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}},"id":{"type":"string","title":"id"},"paging_token":{"type":"string","title":"paging_token"},"account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","enum":["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":{"type":"number","example":1},"created_at":{"type":"string"}}}}},"required":["id","paging_token","account","type","type_i","created_at"]}},"title":"Effect"}]},"examples":{"ListAllEffects":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/effects?cursor=&limit=10&order=asc"},"next":{"href":"https://horizon.stellar.org/effects?cursor=33676838572034-1&limit=10&order=asc"},"prev":{"href":"https://horizon.stellar.org/effects?cursor=12884905985-1&limit=10&order=desc"}},"_embedded":{"records":[{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/12884905985"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905985-1"},"precedes":{"href":"https://horizon.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.stellar.org/operations/12884905985"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905985-2"},"precedes":{"href":"https://horizon.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"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/12884905985"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905985-3"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=12884905985-3"}},"id":"0000000012884905985-0000000003","paging_token":"12884905985-3","account":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB","type":"signer_created","type_i":10,"created_at":"2015-09-30T17:15:54Z","weight":1,"public_key":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB","key":""},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/12884905986"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905986-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=12884905986-1"}},"id":"0000000012884905986-0000000001","paging_token":"12884905986-1","account":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB","type":"account_credited","type_i":2,"created_at":"2015-09-30T17:15:54Z","asset_type":"native","amount":"99999999959.9999700"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/12884905986"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905986-2"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=12884905986-2"}},"id":"0000000012884905986-0000000002","paging_token":"12884905986-2","account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"account_debited","type_i":3,"created_at":"2015-09-30T17:15:54Z","asset_type":"native","amount":"99999999959.9999700"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/12884905987"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905987-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=12884905987-1"}},"id":"0000000012884905987-0000000001","paging_token":"12884905987-1","account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"signer_removed","type_i":11,"created_at":"2015-09-30T17:15:54Z","weight":0,"public_key":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","key":""},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/33676838572033"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=33676838572033-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=33676838572033-1"}},"id":"0000033676838572033-0000000001","paging_token":"33676838572033-1","account":"GAP2KHWUMOHY7IO37UJY7SEBIITJIDZS5DRIIQRPEUT4VUKHZQGIRWS4","type":"account_created","type_i":0,"created_at":"2015-10-01T04:15:01Z","starting_balance":"20.0000000"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/33676838572033"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=33676838572033-2"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=33676838572033-2"}},"id":"0000033676838572033-0000000002","paging_token":"33676838572033-2","account":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB","type":"account_debited","type_i":3,"created_at":"2015-10-01T04:15:01Z","asset_type":"native","amount":"20.0000000"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/33676838572033"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=33676838572033-3"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=33676838572033-3"}},"id":"0000033676838572033-0000000003","paging_token":"33676838572033-3","account":"GAP2KHWUMOHY7IO37UJY7SEBIITJIDZS5DRIIQRPEUT4VUKHZQGIRWS4","type":"signer_created","type_i":10,"created_at":"2015-10-01T04:15:01Z","weight":1,"public_key":"GAP2KHWUMOHY7IO37UJY7SEBIITJIDZS5DRIIQRPEUT4VUKHZQGIRWS4","key":""},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/33676838572034"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=33676838572034-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=33676838572034-1"}},"id":"0000033676838572034-0000000001","paging_token":"33676838572034-1","account":"GCZTBYH66ISTZKUPVJWTMHWBH4S4JIJ7WNLQJXCTQJKWY3FIT34BWZCJ","type":"account_created","type_i":0,"created_at":"2015-10-01T04:15:01Z","starting_balance":"20.0000000"}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/effects","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"List All Effects","description":{"content":"This endpoint lists all effects and can be used in streaming mode. Streaming mode allows you to listen for new effects as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known effect unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream effects created since your request time.","type":"text/plain"},"url":{"path":["effects"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/list-all-ledgers.api.mdx b/api/horizon/resources/list-all-ledgers.api.mdx index 312183b21..9a70d460b 100644 --- a/api/horizon/resources/list-all-ledgers.api.mdx +++ b/api/horizon/resources/list-all-ledgers.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint lists all ledgers and can be used in streaming mode. sidebar_label: "List All Ledgers" hide_title: true hide_table_of_contents: true -api: {"tags":["Ledgers"],"description":"This endpoint lists all ledgers and can be used in streaming mode. Streaming mode allows you to listen for new ledgers as they close. If called in streaming mode, Horizon will start at the earliest known ledger unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream ledgers since your request time.","operationId":"ListAllLedgers","parameters":[{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transactions":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"operations":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"payments":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transactions","operations","effects"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string","title":"paging_token"},"hash":{"type":"string","title":"hash"},"pre_hash":{"type":"string","title":"hash"},"sequence":{"type":"integer","format":"int32"},"successful_transaction_count":{"type":"integer","format":"int32"},"failed_transaction_count":{"type":"integer","format":"int32"},"operation_count":{"type":"integer","format":"int32"},"tx_set_operation_count":{"type":"integer","format":"int32"},"closed_at":{"type":"string"},"total_coins":{"type":"string"},"fee_pool":{"type":"string"},"base_fee_in_stroops":{"type":"integer","format":"int32"},"base_reserve_in_stroops":{"type":"integer","format":"int32"},"max_tx_set_size":{"type":"integer","format":"int32"},"protocol_version":{"type":"integer","format":"int32"},"header_xdr":{"type":"string"}}}}},"required":["id","paging_token","hash","sequence","successful_transaction_count","failed_transaction_count","operation_count","tx_set_operation_count","closed_at","total_coins","fee_pool","base_fee_in_stroops","base_reserve_in_stroops","max_tx_set_size","protocol_version","header_xdr"]}},"title":"Ledger"},"examples":{"ListAllLedgers":{"value":{"_embedded":{"records":[{"_links":{"effects":{"href":"/ledgers/1/effects/{?cursor,limit,order}","templated":true},"operations":{"href":"/ledgers/1/operations/{?cursor,limit,order}","templated":true},"self":{"href":"/ledgers/1"},"transactions":{"href":"/ledgers/1/transactions/{?cursor,limit,order}","templated":true}},"id":"e8e10918f9c000c73119abe54cf089f59f9015cc93c49ccf00b5e8b9afb6e6b1","paging_token":"4294967296","hash":"e8e10918f9c000c73119abe54cf089f59f9015cc93c49ccf00b5e8b9afb6e6b1","sequence":1,"transaction_count":0,"successful_transaction_count":0,"failed_transaction_count":0,"operation_count":0,"tx_set_operation_count":0,"closed_at":"1970-01-01T00:00:00Z","total_coins":"100000000000.0000000","fee_pool":"0.0000000","base_fee_in_stroops":100,"base_reserve_in_stroops":100000000,"max_tx_set_size":50},{"_links":{"effects":{"href":"/ledgers/2/effects/{?cursor,limit,order}","templated":true},"operations":{"href":"/ledgers/2/operations/{?cursor,limit,order}","templated":true},"self":{"href":"/ledgers/2"},"transactions":{"href":"/ledgers/2/transactions/{?cursor,limit,order}","templated":true}},"id":"e12e5809ab8c59d8256e691cb48a024dd43960bc15902d9661cd627962b2bc71","paging_token":"8589934592","hash":"e12e5809ab8c59d8256e691cb48a024dd43960bc15902d9661cd627962b2bc71","prev_hash":"e8e10918f9c000c73119abe54cf089f59f9015cc93c49ccf00b5e8b9afb6e6b1","sequence":2,"transaction_count":0,"successful_transaction_count":0,"failed_transaction_count":0,"operation_count":0,"closed_at":"2015-07-16T23:49:00Z","total_coins":"100000000000.0000000","fee_pool":"0.0000000","base_fee_in_stroops":100,"base_reserve_in_stroops":100000000,"max_tx_set_size":100}]},"_links":{"next":{"href":"/ledgers?order=asc&limit=2&cursor=8589934592"},"prev":{"href":"/ledgers?order=desc&limit=2&cursor=4294967296"},"self":{"href":"/ledgers?order=asc&limit=2&cursor="}}}}}}}}},"method":"get","path":"/ledgers","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"List All Ledgers","description":{"content":"This endpoint lists all ledgers and can be used in streaming mode. Streaming mode allows you to listen for new ledgers as they close. If called in streaming mode, Horizon will start at the earliest known ledger unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream ledgers since your request time.","type":"text/plain"},"url":{"path":["ledgers"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Ledgers"],"description":"This endpoint lists all ledgers and can be used in streaming mode. Streaming mode allows you to listen for new ledgers as they close. If called in streaming mode, Horizon will start at the earliest known ledger unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream ledgers since your request time.","operationId":"ListAllLedgers","parameters":[{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transactions":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"operations":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"payments":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transactions","operations","effects"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string","title":"paging_token"},"hash":{"type":"string","title":"hash"},"pre_hash":{"type":"string","title":"hash"},"sequence":{"type":"integer","format":"int32"},"successful_transaction_count":{"type":"integer","format":"int32"},"failed_transaction_count":{"type":"integer","format":"int32"},"operation_count":{"type":"integer","format":"int32"},"tx_set_operation_count":{"type":"integer","format":"int32"},"closed_at":{"type":"string"},"total_coins":{"type":"string"},"fee_pool":{"type":"string"},"base_fee_in_stroops":{"type":"integer","format":"int32"},"base_reserve_in_stroops":{"type":"integer","format":"int32"},"max_tx_set_size":{"type":"integer","format":"int32"},"protocol_version":{"type":"integer","format":"int32"},"header_xdr":{"type":"string"}}}}},"required":["id","paging_token","hash","sequence","successful_transaction_count","failed_transaction_count","operation_count","tx_set_operation_count","closed_at","total_coins","fee_pool","base_fee_in_stroops","base_reserve_in_stroops","max_tx_set_size","protocol_version","header_xdr"]}},"title":"Ledger"},"examples":{"ListAllLedgers":{"value":{"_embedded":{"records":[{"_links":{"effects":{"href":"/ledgers/1/effects/{?cursor,limit,order}","templated":true},"operations":{"href":"/ledgers/1/operations/{?cursor,limit,order}","templated":true},"self":{"href":"/ledgers/1"},"transactions":{"href":"/ledgers/1/transactions/{?cursor,limit,order}","templated":true}},"id":"e8e10918f9c000c73119abe54cf089f59f9015cc93c49ccf00b5e8b9afb6e6b1","paging_token":"4294967296","hash":"e8e10918f9c000c73119abe54cf089f59f9015cc93c49ccf00b5e8b9afb6e6b1","sequence":1,"transaction_count":0,"successful_transaction_count":0,"failed_transaction_count":0,"operation_count":0,"tx_set_operation_count":0,"closed_at":"1970-01-01T00:00:00Z","total_coins":"100000000000.0000000","fee_pool":"0.0000000","base_fee_in_stroops":100,"base_reserve_in_stroops":100000000,"max_tx_set_size":50},{"_links":{"effects":{"href":"/ledgers/2/effects/{?cursor,limit,order}","templated":true},"operations":{"href":"/ledgers/2/operations/{?cursor,limit,order}","templated":true},"self":{"href":"/ledgers/2"},"transactions":{"href":"/ledgers/2/transactions/{?cursor,limit,order}","templated":true}},"id":"e12e5809ab8c59d8256e691cb48a024dd43960bc15902d9661cd627962b2bc71","paging_token":"8589934592","hash":"e12e5809ab8c59d8256e691cb48a024dd43960bc15902d9661cd627962b2bc71","prev_hash":"e8e10918f9c000c73119abe54cf089f59f9015cc93c49ccf00b5e8b9afb6e6b1","sequence":2,"transaction_count":0,"successful_transaction_count":0,"failed_transaction_count":0,"operation_count":0,"closed_at":"2015-07-16T23:49:00Z","total_coins":"100000000000.0000000","fee_pool":"0.0000000","base_fee_in_stroops":100,"base_reserve_in_stroops":100000000,"max_tx_set_size":100}]},"_links":{"next":{"href":"/ledgers?order=asc&limit=2&cursor=8589934592"},"prev":{"href":"/ledgers?order=desc&limit=2&cursor=4294967296"},"self":{"href":"/ledgers?order=asc&limit=2&cursor="}}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/ledgers","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"List All Ledgers","description":{"content":"This endpoint lists all ledgers and can be used in streaming mode. Streaming mode allows you to listen for new ledgers as they close. If called in streaming mode, Horizon will start at the earliest known ledger unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream ledgers since your request time.","type":"text/plain"},"url":{"path":["ledgers"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/list-all-operations.api.mdx b/api/horizon/resources/list-all-operations.api.mdx index a2628b821..2d0bd1db2 100644 --- a/api/horizon/resources/list-all-operations.api.mdx +++ b/api/horizon/resources/list-all-operations.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint lists all Successful operations and can be used in s sidebar_label: "List All Operations" hide_title: true hide_table_of_contents: true -api: {"tags":["Operations"],"description":"This endpoint lists all Successful operations and can be used in streaming mode. Streaming mode allows you to listen for new operations as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known operation unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream operations created since your request time.","operationId":"ListAllOperations","parameters":[{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}},{"name":"include_failed","in":"query","required":false,"description":"Set to true to include failed operations in results. Options include true and false.","schema":{"type":"boolean","enum":[true,false]}},{"name":"join","in":"query","required":false,"description":"Set to transactions to include the transactions which created each of the operations in the response."}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_links":{"type":"object","properties":{"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}},"id":{"type":"string","title":"id"},"paging_token":{"type":"string","title":"paging_token"},"type_i":{"type":"number","example":0},"type":{"type":"string","example":"create_account"}},"title":"Operation"}]},"examples":{"ListAllOperations":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/operations?cursor=&limit=3&order=asc"},"next":{"href":"https://horizon.stellar.org/operations?cursor=12884905987&limit=3&order=asc"},"prev":{"href":"https://horizon.stellar.org/operations?cursor=12884905985&limit=3&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/operations/12884905985"},"transaction":{"href":"https://horizon.stellar.org/transactions/3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889"},"effects":{"href":"https://horizon.stellar.org/operations/12884905985/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905985"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=12884905985"}},"id":"12884905985","paging_token":"12884905985","transaction_successful":true,"source_account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"create_account","type_i":0,"created_at":"2015-09-30T17:15:54Z","transaction_hash":"3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889","starting_balance":"20.0000000","funder":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","account":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/12884905986"},"transaction":{"href":"https://horizon.stellar.org/transactions/3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889"},"effects":{"href":"https://horizon.stellar.org/operations/12884905986/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905986"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=12884905986"}},"id":"12884905986","paging_token":"12884905986","transaction_successful":true,"source_account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"payment","type_i":1,"created_at":"2015-09-30T17:15:54Z","transaction_hash":"3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889","asset_type":"native","from":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","to":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB","amount":"99999999959.9999700"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/12884905987"},"transaction":{"href":"https://horizon.stellar.org/transactions/3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889"},"effects":{"href":"https://horizon.stellar.org/operations/12884905987/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905987"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=12884905987"}},"id":"12884905987","paging_token":"12884905987","transaction_successful":true,"source_account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"set_options","type_i":5,"created_at":"2015-09-30T17:15:54Z","transaction_hash":"3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889","master_key_weight":0}]}}}}}}}},"method":"get","path":"/operations","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"List All Operations","description":{"content":"This endpoint lists all Successful operations and can be used in streaming mode. Streaming mode allows you to listen for new operations as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known operation unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream operations created since your request time.","type":"text/plain"},"url":{"path":["operations"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Set to true to include failed operations in results. Options include true and false.","type":"text/plain"},"key":"include_failed","value":""},{"description":{"content":"Set to transactions to include the transactions which created each of the operations in the response.","type":"text/plain"},"key":"join","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Operations"],"description":"This endpoint lists all Successful operations and can be used in streaming mode. Streaming mode allows you to listen for new operations as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known operation unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream operations created since your request time.","operationId":"ListAllOperations","parameters":[{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}},{"name":"include_failed","in":"query","required":false,"description":"Set to true to include failed operations in results. Options include true and false.","schema":{"type":"boolean","enum":[true,false]}},{"name":"join","in":"query","required":false,"description":"Set to transactions to include the transactions which created each of the operations in the response."}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_links":{"type":"object","properties":{"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}},"id":{"type":"string","title":"id"},"paging_token":{"type":"string","title":"paging_token"},"type_i":{"type":"number","example":0},"type":{"type":"string","example":"create_account"}},"title":"Operation"}]},"examples":{"ListAllOperations":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/operations?cursor=&limit=3&order=asc"},"next":{"href":"https://horizon.stellar.org/operations?cursor=12884905987&limit=3&order=asc"},"prev":{"href":"https://horizon.stellar.org/operations?cursor=12884905985&limit=3&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/operations/12884905985"},"transaction":{"href":"https://horizon.stellar.org/transactions/3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889"},"effects":{"href":"https://horizon.stellar.org/operations/12884905985/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905985"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=12884905985"}},"id":"12884905985","paging_token":"12884905985","transaction_successful":true,"source_account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"create_account","type_i":0,"created_at":"2015-09-30T17:15:54Z","transaction_hash":"3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889","starting_balance":"20.0000000","funder":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","account":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/12884905986"},"transaction":{"href":"https://horizon.stellar.org/transactions/3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889"},"effects":{"href":"https://horizon.stellar.org/operations/12884905986/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905986"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=12884905986"}},"id":"12884905986","paging_token":"12884905986","transaction_successful":true,"source_account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"payment","type_i":1,"created_at":"2015-09-30T17:15:54Z","transaction_hash":"3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889","asset_type":"native","from":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","to":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB","amount":"99999999959.9999700"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/12884905987"},"transaction":{"href":"https://horizon.stellar.org/transactions/3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889"},"effects":{"href":"https://horizon.stellar.org/operations/12884905987/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905987"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=12884905987"}},"id":"12884905987","paging_token":"12884905987","transaction_successful":true,"source_account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"set_options","type_i":5,"created_at":"2015-09-30T17:15:54Z","transaction_hash":"3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889","master_key_weight":0}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/operations","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"List All Operations","description":{"content":"This endpoint lists all Successful operations and can be used in streaming mode. Streaming mode allows you to listen for new operations as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known operation unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream operations created since your request time.","type":"text/plain"},"url":{"path":["operations"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Set to true to include failed operations in results. Options include true and false.","type":"text/plain"},"key":"include_failed","value":""},{"description":{"content":"Set to transactions to include the transactions which created each of the operations in the response.","type":"text/plain"},"key":"join","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/list-all-payments.api.mdx b/api/horizon/resources/list-all-payments.api.mdx index 6a0597a1f..dd5b6566c 100644 --- a/api/horizon/resources/list-all-payments.api.mdx +++ b/api/horizon/resources/list-all-payments.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint lists all Successful payment-related operations and sidebar_label: "List All Payments" hide_title: true hide_table_of_contents: true -api: {"tags":["Operations"],"description":"This endpoint lists all Successful payment-related operations and can be used in streaming mode. Streaming mode allows you to listen for new payments as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known payment unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream payments created since your request time. Operations that can be returned by this endpoint include: create_account, payment, path_payment_strict_recieve, path_payment_strict_send, and account_merge .","operationId":"ListAllPayments","parameters":[{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}},{"name":"include_failed","in":"query","required":false,"description":"Set to true to include failed operations in results. Options include true and false.","schema":{"type":"boolean","enum":[true,false]}},{"name":"join","in":"query","required":false,"description":"Set to transactions to include the transactions which created each of the operations in the response."}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"oneOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"create_account"},"type_i":{"type":"number","example":0},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"starting_balance":{"type":"string"},"funder":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","starting_balance","funder","account"],"title":"CreateAccount"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"payment"},"type_i":{"type":"string"},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string"},"asset_code":{"enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","asset_type","from","to","amount"]}}}}},"title":"Payment"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"path_payment_strict_receive"},"type_i":{"type":"number","example":2},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"},"path":{"type":"array","items":{"type":"object","properties":{"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}}}},"source_amount":{"type":"string"},"destination_min":{"type":"string"},"source_asset_type":{"type":"string"},"source_asset_code":{"type":"string"},"source_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","from","to","amount","path","source_amount","destination_min"],"title":"PathPaymentStrictReceive"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"path_payment_strict_send"},"type_i":{"type":"number","example":13},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"},"path":{"type":"array","items":{"type":"object","properties":{"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}}}},"source_amount":{"type":"string"},"source_max":{"type":"string"},"source_asset_type":{"type":"string"},"source_asset_code":{"type":"string"},"source_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","from","to","amount","path","source_amount","source_asset_type"],"title":"PathPaymentStrictSend"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"account_merge"},"type_i":{"type":"number","example":8},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"into":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","account","into"],"title":"AccountMerge"}]}]},"examples":{"ListAllPayments":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/payments?cursor=&limit=3&order=asc"},"next":{"href":"https://horizon.stellar.org/payments?cursor=33676838572033&limit=3&order=asc"},"prev":{"href":"https://horizon.stellar.org/payments?cursor=12884905985&limit=3&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/operations/12884905985"},"transaction":{"href":"https://horizon.stellar.org/transactions/3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889"},"effects":{"href":"https://horizon.stellar.org/operations/12884905985/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905985"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=12884905985"}},"id":"12884905985","paging_token":"12884905985","transaction_successful":true,"source_account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"create_account","type_i":0,"created_at":"2015-09-30T17:15:54Z","transaction_hash":"3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889","starting_balance":"20.0000000","funder":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","account":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/12884905986"},"transaction":{"href":"https://horizon.stellar.org/transactions/3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889"},"effects":{"href":"https://horizon.stellar.org/operations/12884905986/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905986"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=12884905986"}},"id":"12884905986","paging_token":"12884905986","transaction_successful":true,"source_account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"payment","type_i":1,"created_at":"2015-09-30T17:15:54Z","transaction_hash":"3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889","asset_type":"native","from":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","to":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB","amount":"99999999959.9999700"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/33676838572033"},"transaction":{"href":"https://horizon.stellar.org/transactions/2db4b22ca018119c5027a80578813ffcf582cda4aa9e31cd92b43cf1bda4fc5a"},"effects":{"href":"https://horizon.stellar.org/operations/33676838572033/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=33676838572033"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=33676838572033"}},"id":"33676838572033","paging_token":"33676838572033","transaction_successful":true,"source_account":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB","type":"create_account","type_i":0,"created_at":"2015-10-01T04:15:01Z","transaction_hash":"2db4b22ca018119c5027a80578813ffcf582cda4aa9e31cd92b43cf1bda4fc5a","starting_balance":"20.0000000","funder":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB","account":"GAP2KHWUMOHY7IO37UJY7SEBIITJIDZS5DRIIQRPEUT4VUKHZQGIRWS4"}]}}}}}}}},"method":"get","path":"/payments","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"List All Payments","description":{"content":"This endpoint lists all Successful payment-related operations and can be used in streaming mode. Streaming mode allows you to listen for new payments as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known payment unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream payments created since your request time. Operations that can be returned by this endpoint include: create_account, payment, path_payment_strict_recieve, path_payment_strict_send, and account_merge .","type":"text/plain"},"url":{"path":["payments"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Set to true to include failed operations in results. Options include true and false.","type":"text/plain"},"key":"include_failed","value":""},{"description":{"content":"Set to transactions to include the transactions which created each of the operations in the response.","type":"text/plain"},"key":"join","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Operations"],"description":"This endpoint lists all Successful payment-related operations and can be used in streaming mode. Streaming mode allows you to listen for new payments as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known payment unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream payments created since your request time. Operations that can be returned by this endpoint include: create_account, payment, path_payment_strict_recieve, path_payment_strict_send, and account_merge .","operationId":"ListAllPayments","parameters":[{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}},{"name":"include_failed","in":"query","required":false,"description":"Set to true to include failed operations in results. Options include true and false.","schema":{"type":"boolean","enum":[true,false]}},{"name":"join","in":"query","required":false,"description":"Set to transactions to include the transactions which created each of the operations in the response."}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"oneOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"create_account"},"type_i":{"type":"number","example":0},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"starting_balance":{"type":"string"},"funder":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","starting_balance","funder","account"],"title":"CreateAccount"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"payment"},"type_i":{"type":"string"},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string"},"asset_code":{"enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","asset_type","from","to","amount"]}}}}},"title":"Payment"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"path_payment_strict_receive"},"type_i":{"type":"number","example":2},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"},"path":{"type":"array","items":{"type":"object","properties":{"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}}}},"source_amount":{"type":"string"},"destination_min":{"type":"string"},"source_asset_type":{"type":"string"},"source_asset_code":{"type":"string"},"source_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","from","to","amount","path","source_amount","destination_min"],"title":"PathPaymentStrictReceive"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"path_payment_strict_send"},"type_i":{"type":"number","example":13},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"from":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"to":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"amount":{"type":"string"},"path":{"type":"array","items":{"type":"object","properties":{"asset_type":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}}}},"source_amount":{"type":"string"},"source_max":{"type":"string"},"source_asset_type":{"type":"string"},"source_asset_code":{"type":"string"},"source_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","from","to","amount","path","source_amount","source_asset_type"],"title":"PathPaymentStrictSend"},{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","transaction","effects","succeeds","precedes"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"transaction_successful":{"type":"boolean"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","example":"account_merge"},"type_i":{"type":"number","example":8},"created_at":{"type":"string"},"transaction_hash":{"type":"string"},"account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"into":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["id","paging_token","transaction_successful","source_account","type","type_i","created_at","transaction_hash","account","into"],"title":"AccountMerge"}]}]},"examples":{"ListAllPayments":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/payments?cursor=&limit=3&order=asc"},"next":{"href":"https://horizon.stellar.org/payments?cursor=33676838572033&limit=3&order=asc"},"prev":{"href":"https://horizon.stellar.org/payments?cursor=12884905985&limit=3&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/operations/12884905985"},"transaction":{"href":"https://horizon.stellar.org/transactions/3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889"},"effects":{"href":"https://horizon.stellar.org/operations/12884905985/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905985"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=12884905985"}},"id":"12884905985","paging_token":"12884905985","transaction_successful":true,"source_account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"create_account","type_i":0,"created_at":"2015-09-30T17:15:54Z","transaction_hash":"3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889","starting_balance":"20.0000000","funder":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","account":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/12884905986"},"transaction":{"href":"https://horizon.stellar.org/transactions/3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889"},"effects":{"href":"https://horizon.stellar.org/operations/12884905986/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=12884905986"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=12884905986"}},"id":"12884905986","paging_token":"12884905986","transaction_successful":true,"source_account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"payment","type_i":1,"created_at":"2015-09-30T17:15:54Z","transaction_hash":"3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889","asset_type":"native","from":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","to":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB","amount":"99999999959.9999700"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/33676838572033"},"transaction":{"href":"https://horizon.stellar.org/transactions/2db4b22ca018119c5027a80578813ffcf582cda4aa9e31cd92b43cf1bda4fc5a"},"effects":{"href":"https://horizon.stellar.org/operations/33676838572033/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=33676838572033"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=33676838572033"}},"id":"33676838572033","paging_token":"33676838572033","transaction_successful":true,"source_account":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB","type":"create_account","type_i":0,"created_at":"2015-10-01T04:15:01Z","transaction_hash":"2db4b22ca018119c5027a80578813ffcf582cda4aa9e31cd92b43cf1bda4fc5a","starting_balance":"20.0000000","funder":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB","account":"GAP2KHWUMOHY7IO37UJY7SEBIITJIDZS5DRIIQRPEUT4VUKHZQGIRWS4"}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/payments","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"List All Payments","description":{"content":"This endpoint lists all Successful payment-related operations and can be used in streaming mode. Streaming mode allows you to listen for new payments as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known payment unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream payments created since your request time. Operations that can be returned by this endpoint include: create_account, payment, path_payment_strict_recieve, path_payment_strict_send, and account_merge .","type":"text/plain"},"url":{"path":["payments"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Set to true to include failed operations in results. Options include true and false.","type":"text/plain"},"key":"include_failed","value":""},{"description":{"content":"Set to transactions to include the transactions which created each of the operations in the response.","type":"text/plain"},"key":"join","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/list-all-transactions.api.mdx b/api/horizon/resources/list-all-transactions.api.mdx index b819572d3..c1409cb72 100644 --- a/api/horizon/resources/list-all-transactions.api.mdx +++ b/api/horizon/resources/list-all-transactions.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint lists all Successful transactions and can be used in sidebar_label: "List All Transactions" hide_title: true hide_table_of_contents: true -api: {"tags":["Transactions"],"description":"This endpoint lists all Successful transactions and can be used in streaming mode. Streaming mode allows you to listen for new transactions as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known transaction unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream transactions created since your request time.","operationId":"ListAllTransactions","parameters":[{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}},{"name":"include_failed","in":"query","required":false,"description":"Set to true to include failed operations in results. Options include true and false.","schema":{"type":"boolean","enum":[true,false]}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"memo":{"type":"string"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"account":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"ledger":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"operations":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","account","ledger","operations","effects","precedes","succeeds","transaction"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"successful":{"type":"boolean"},"hash":{"type":"string"},"ledger":{"type":"integer","format":"int32"},"created_at":{"type":"string"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"account_muxed":{"type":"string"},"account_muxed_id":{"type":"string"},"source_account_sequence":{"type":"string"},"fee_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"fee_account_muxed":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"fee_account_muxed_id":{"type":"string"},"fee_charged":{"type":"string"},"max_fee":{"type":"string"},"operation_count":{"type":"integer","format":"int32"},"envelope_xdr":{"type":"string"},"result_xdr":{"type":"string"},"result_meta_xdr":{"type":"string"},"fee_meta_xdr":{"type":"string"},"memo_type":{"type":"string"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"},"valid_after":{"type":"string"},"valid_before":{"type":"string"},"preconditions":{"type":"object","properties":{"timebounds":{"type":"object","properties":{"min_time":{"type":"string"},"max_time":{"type":"string"}},"title":"TransactionPreconditionsTimebounds"},"ledgerbounds":{"type":"object","properties":{"min_ledger":{"type":"string"},"max_ledger":{"type":"string"}},"title":"TransactionPreconditionsLedgerbounds"},"min_account_sequence":{"type":"string"},"min_account_sequence_age":{"type":"string"},"min_account_sequence_ledger_gap":{"type":"integer","format":"uint32"},"extra_signers":{"type":"array","items":{"type":"string"}}},"title":"TransactionPreconditions"},"fee_bump_transaction":{"type":"object","properties":{"hash":{"type":"string","title":"hash"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"}},"title":"FeeBumpTransaction"},"inner_transaction":{"type":"object","properties":{"hash":{"type":"string","title":"hash"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"},"max_fee":{"type":"string"}},"title":"InnerTransaction"}},"required":["id","paging_token","successful","hash","ledger","created_at","source_account","source_account_sequence","fee_account","fee_charged","max_fee","operation_count","envelope_xdr","result_xdr","result_meta_xdr","memo_type","signatures"]}}}}},"title":"Transaction"}]},"examples":{"ListAllTransactions":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/transactions?cursor=&limit=3&order=asc"},"next":{"href":"https://horizon.stellar.org/transactions?cursor=33736968114176&limit=3&order=asc"},"prev":{"href":"https://horizon.stellar.org/transactions?cursor=12884905984&limit=3&order=desc"}},"_embedded":{"records":[{"memo":"hello world","_links":{"self":{"href":"https://horizon.stellar.org/transactions/3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889"},"account":{"href":"https://horizon.stellar.org/accounts/GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7"},"ledger":{"href":"https://horizon.stellar.org/ledgers/3"},"operations":{"href":"https://horizon.stellar.org/transactions/3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=12884905984"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=12884905984"}},"id":"3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889","paging_token":"12884905984","successful":true,"hash":"3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889","ledger":3,"created_at":"2015-09-30T17:15:54Z","source_account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","source_account_sequence":"1","fee_charged":300,"max_fee":300,"operation_count":3,"envelope_xdr":"AAAAAAGUcmKO5465JxTSLQOQljwk2SfqAJmZSG6JH6wtqpwhAAABLAAAAAAAAAABAAAAAAAAAAEAAAALaGVsbG8gd29ybGQAAAAAAwAAAAAAAAAAAAAAABbxCy3mLg3hiTqX4VUEEp60pFOrJNxYM1JtxXTwXhY2AAAAAAvrwgAAAAAAAAAAAQAAAAAW8Qst5i4N4Yk6l+FVBBKetKRTqyTcWDNSbcV08F4WNgAAAAAN4Lazj4x61AAAAAAAAAAFAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABLaqcIQAAAEBKwqWy3TaOxoGnfm9eUjfTRBvPf34dvDA0Nf+B8z4zBob90UXtuCqmQqwMCyH+okOI3c05br3khkH0yP4kCwcE","result_xdr":"AAAAAAAAASwAAAAAAAAAAwAAAAAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAAFAAAAAAAAAAA=","result_meta_xdr":"AAAAAAAAAAMAAAACAAAAAAAAAAMAAAAAAAAAABbxCy3mLg3hiTqX4VUEEp60pFOrJNxYM1JtxXTwXhY2AAAAAAvrwgAAAAADAAAAAAAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAMAAAAAAAAAAAGUcmKO5465JxTSLQOQljwk2SfqAJmZSG6JH6wtqpwhDeC2s5t4PNQAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAwAAAAEAAAADAAAAAAAAAAABlHJijueOuScU0i0DkJY8JNkn6gCZmUhuiR+sLaqcIQAAAAAL68IAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAMAAAADAAAAAAAAAAAW8Qst5i4N4Yk6l+FVBBKetKRTqyTcWDNSbcV08F4WNgAAAAAL68IAAAAAAwAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAAADAAAAAAAAAAAW8Qst5i4N4Yk6l+FVBBKetKRTqyTcWDNSbcV08F4WNg3gtrObeDzUAAAAAwAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAAABAAAAAwAAAAAAAAAAAZRyYo7njrknFNItA5CWPCTZJ+oAmZlIbokfrC2qnCEAAAAAC+vCAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMAAAABAAAAAAAAAAABlHJijueOuScU0i0DkJY8JNkn6gCZmUhuiR+sLaqcIQ3gtrOnZAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAAADAAAAAAAAAAABlHJijueOuScU0i0DkJY8JNkn6gCZmUhuiR+sLaqcIQ3gtrOnY/7UAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"text","signatures":["SsKlst02jsaBp35vXlI300Qbz39+HbwwNDX/gfM+MwaG/dFF7bgqpkKsDAsh/qJDiN3NOW695IZB9Mj+JAsHBA=="]},{"memo":"testpool,faucet,sdf","_links":{"self":{"href":"https://horizon.stellar.org/transactions/2db4b22ca018119c5027a80578813ffcf582cda4aa9e31cd92b43cf1bda4fc5a"},"account":{"href":"https://horizon.stellar.org/accounts/GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB"},"ledger":{"href":"https://horizon.stellar.org/ledgers/7841"},"operations":{"href":"https://horizon.stellar.org/transactions/2db4b22ca018119c5027a80578813ffcf582cda4aa9e31cd92b43cf1bda4fc5a/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/2db4b22ca018119c5027a80578813ffcf582cda4aa9e31cd92b43cf1bda4fc5a/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=33676838572032"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=33676838572032"}},"id":"2db4b22ca018119c5027a80578813ffcf582cda4aa9e31cd92b43cf1bda4fc5a","paging_token":"33676838572032","successful":true,"hash":"2db4b22ca018119c5027a80578813ffcf582cda4aa9e31cd92b43cf1bda4fc5a","ledger":7841,"created_at":"2015-10-01T04:15:01Z","source_account":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB","source_account_sequence":"12884901890","fee_charged":300,"max_fee":300,"operation_count":3,"envelope_xdr":"AAAAABbxCy3mLg3hiTqX4VUEEp60pFOrJNxYM1JtxXTwXhY2AAABLAAAAAMAAAACAAAAAAAAAAEAAAATdGVzdHBvb2wsZmF1Y2V0LHNkZgAAAAADAAAAAAAAAAAAAAAAH6Ue1GOPj6Hb/ROPyIFCJpQPMujihEIvJSfK0UfMDIgAAAAAC+vCAAAAAAAAAAAAAAAAALMw4P7yJTyqj6ptNh7BPyXEoT+zVwTcU4JVbGyonvgbAAAAAAvrwgAAAAAAAAAAAAAAAABJlwu05Op/5x1uyrweYsyR6pTTos33hRNZe5IF6blnzwAAAAAL68IAAAAAAAAAAAHwXhY2AAAAQDSBB5eNEKkWIoQbZ1YQabJuE5mW/AKhrHTxw9H3m/sai90YcaZlsAe3ueO9jExjSZF289ZcR4vc0wFw1p/WyAc=","result_xdr":"AAAAAAAAASwAAAAAAAAAAwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=","result_meta_xdr":"AAAAAAAAAAMAAAACAAAAAAAAHqEAAAAAAAAAAB+lHtRjj4+h2/0Tj8iBQiaUDzLo4oRCLyUnytFHzAyIAAAAAAvrwgAAAB6hAAAAAAAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAQAAHqEAAAAAAAAAABbxCy3mLg3hiTqX4VUEEp60pFOrJNxYM1JtxXTwXhY2DeC2s4+MeHwAAAADAAAAAgAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAgAAAAAAAB6hAAAAAAAAAACzMOD+8iU8qo+qbTYewT8lxKE/s1cE3FOCVWxsqJ74GwAAAAAL68IAAAAeoQAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAB6hAAAAAAAAAAAW8Qst5i4N4Yk6l+FVBBKetKRTqyTcWDNSbcV08F4WNg3gtrODoLZ8AAAAAwAAAAIAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAIAAAAAAAAeoQAAAAAAAAAASZcLtOTqf+cdbsq8HmLMkeqU06LN94UTWXuSBem5Z88AAAAAC+vCAAAAHqEAAAAAAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAeoQAAAAAAAAAAFvELLeYuDeGJOpfhVQQSnrSkU6sk3FgzUm3FdPBeFjYN4Lazd7T0fAAAAAMAAAACAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMAAB55AAAAAAAAAAAW8Qst5i4N4Yk6l+FVBBKetKRTqyTcWDNSbcV08F4WNg3gtrObeDuoAAAAAwAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAB6hAAAAAAAAAAAW8Qst5i4N4Yk6l+FVBBKetKRTqyTcWDNSbcV08F4WNg3gtrObeDp8AAAAAwAAAAIAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"text","signatures":["NIEHl40QqRYihBtnVhBpsm4TmZb8AqGsdPHD0feb+xqL3RhxpmWwB7e5472MTGNJkXbz1lxHi9zTAXDWn9bIBw=="]},{"memo":"","_links":{"self":{"href":"https://horizon.stellar.org/transactions/3ce2aca2fed36da2faea31352c76c5e412348887a4c119b1e90de8d1b937396a"},"account":{"href":"https://horizon.stellar.org/accounts/GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB"},"ledger":{"href":"https://horizon.stellar.org/ledgers/7855"},"operations":{"href":"https://horizon.stellar.org/transactions/3ce2aca2fed36da2faea31352c76c5e412348887a4c119b1e90de8d1b937396a/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/3ce2aca2fed36da2faea31352c76c5e412348887a4c119b1e90de8d1b937396a/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=33736968114176"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=33736968114176"}},"id":"3ce2aca2fed36da2faea31352c76c5e412348887a4c119b1e90de8d1b937396a","paging_token":"33736968114176","successful":true,"hash":"3ce2aca2fed36da2faea31352c76c5e412348887a4c119b1e90de8d1b937396a","ledger":7855,"created_at":"2015-10-01T04:16:11Z","source_account":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB","source_account_sequence":"12884901891","fee_charged":100,"max_fee":100,"operation_count":1,"envelope_xdr":"AAAAABbxCy3mLg3hiTqX4VUEEp60pFOrJNxYM1JtxXTwXhY2AAAAZAAAAAMAAAADAAAAAAAAAAEAAAAAAAAAAQAAAAAAAAAFAAAAAQAAAAAfpR7UY4+Podv9E4/IgUImlA8y6OKEQi8lJ8rRR8wMiAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAHwXhY2AAAAQNbDcWsR3s3z8Qzqatcdc/k2L4LXWJMA6eXac8dbXkAdc4ppH25isGC5OwvG06Vwvc3Ce3/r2rYcBP3vxhx18A8=","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAAFAAAAAAAAAAA=","result_meta_xdr":"AAAAAAAAAAEAAAABAAAAAQAAHq8AAAAAAAAAABbxCy3mLg3hiTqX4VUEEp60pFOrJNxYM1JtxXTwXhY2DeC2s3e09BgAAAADAAAAAwAAAAAAAAABAAAAAB+lHtRjj4+h2/0Tj8iBQiaUDzLo4oRCLyUnytFHzAyIAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAA","fee_meta_xdr":"AAAAAgAAAAMAAB6hAAAAAAAAAAAW8Qst5i4N4Yk6l+FVBBKetKRTqyTcWDNSbcV08F4WNg3gtrN3tPR8AAAAAwAAAAIAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAB6vAAAAAAAAAAAW8Qst5i4N4Yk6l+FVBBKetKRTqyTcWDNSbcV08F4WNg3gtrN3tPQYAAAAAwAAAAMAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"text","signatures":["1sNxaxHezfPxDOpq1x1z+TYvgtdYkwDp5dpzx1teQB1zimkfbmKwYLk7C8bTpXC9zcJ7f+vathwE/e/GHHXwDw=="]}]}}}}}}}},"method":"get","path":"/transactions","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"List All Transactions","description":{"content":"This endpoint lists all Successful transactions and can be used in streaming mode. Streaming mode allows you to listen for new transactions as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known transaction unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream transactions created since your request time.","type":"text/plain"},"url":{"path":["transactions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Set to true to include failed operations in results. Options include true and false.","type":"text/plain"},"key":"include_failed","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Transactions"],"description":"This endpoint lists all Successful transactions and can be used in streaming mode. Streaming mode allows you to listen for new transactions as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known transaction unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream transactions created since your request time.","operationId":"ListAllTransactions","parameters":[{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}},{"name":"include_failed","in":"query","required":false,"description":"Set to true to include failed operations in results. Options include true and false.","schema":{"type":"boolean","enum":[true,false]}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"memo":{"type":"string"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"account":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"ledger":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"operations":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","account","ledger","operations","effects","precedes","succeeds","transaction"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"successful":{"type":"boolean"},"hash":{"type":"string"},"ledger":{"type":"integer","format":"int32"},"created_at":{"type":"string"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"account_muxed":{"type":"string"},"account_muxed_id":{"type":"string"},"source_account_sequence":{"type":"string"},"fee_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"fee_account_muxed":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"fee_account_muxed_id":{"type":"string"},"fee_charged":{"type":"string"},"max_fee":{"type":"string"},"operation_count":{"type":"integer","format":"int32"},"envelope_xdr":{"type":"string"},"result_xdr":{"type":"string"},"result_meta_xdr":{"type":"string"},"fee_meta_xdr":{"type":"string"},"memo_type":{"type":"string"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"},"valid_after":{"type":"string"},"valid_before":{"type":"string"},"preconditions":{"type":"object","properties":{"timebounds":{"type":"object","properties":{"min_time":{"type":"string"},"max_time":{"type":"string"}},"title":"TransactionPreconditionsTimebounds"},"ledgerbounds":{"type":"object","properties":{"min_ledger":{"type":"string"},"max_ledger":{"type":"string"}},"title":"TransactionPreconditionsLedgerbounds"},"min_account_sequence":{"type":"string"},"min_account_sequence_age":{"type":"string"},"min_account_sequence_ledger_gap":{"type":"integer","format":"uint32"},"extra_signers":{"type":"array","items":{"type":"string"}}},"title":"TransactionPreconditions"},"fee_bump_transaction":{"type":"object","properties":{"hash":{"type":"string","title":"hash"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"}},"title":"FeeBumpTransaction"},"inner_transaction":{"type":"object","properties":{"hash":{"type":"string","title":"hash"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"},"max_fee":{"type":"string"}},"title":"InnerTransaction"}},"required":["id","paging_token","successful","hash","ledger","created_at","source_account","source_account_sequence","fee_account","fee_charged","max_fee","operation_count","envelope_xdr","result_xdr","result_meta_xdr","memo_type","signatures"]}}}}},"title":"Transaction"}]},"examples":{"ListAllTransactions":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/transactions?cursor=&limit=3&order=asc"},"next":{"href":"https://horizon.stellar.org/transactions?cursor=33736968114176&limit=3&order=asc"},"prev":{"href":"https://horizon.stellar.org/transactions?cursor=12884905984&limit=3&order=desc"}},"_embedded":{"records":[{"memo":"hello world","_links":{"self":{"href":"https://horizon.stellar.org/transactions/3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889"},"account":{"href":"https://horizon.stellar.org/accounts/GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7"},"ledger":{"href":"https://horizon.stellar.org/ledgers/3"},"operations":{"href":"https://horizon.stellar.org/transactions/3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=12884905984"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=12884905984"}},"id":"3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889","paging_token":"12884905984","successful":true,"hash":"3389e9f0f1a65f19736cacf544c2e825313e8447f569233bb8db39aa607c8889","ledger":3,"created_at":"2015-09-30T17:15:54Z","source_account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","source_account_sequence":"1","fee_charged":300,"max_fee":300,"operation_count":3,"envelope_xdr":"AAAAAAGUcmKO5465JxTSLQOQljwk2SfqAJmZSG6JH6wtqpwhAAABLAAAAAAAAAABAAAAAAAAAAEAAAALaGVsbG8gd29ybGQAAAAAAwAAAAAAAAAAAAAAABbxCy3mLg3hiTqX4VUEEp60pFOrJNxYM1JtxXTwXhY2AAAAAAvrwgAAAAAAAAAAAQAAAAAW8Qst5i4N4Yk6l+FVBBKetKRTqyTcWDNSbcV08F4WNgAAAAAN4Lazj4x61AAAAAAAAAAFAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABLaqcIQAAAEBKwqWy3TaOxoGnfm9eUjfTRBvPf34dvDA0Nf+B8z4zBob90UXtuCqmQqwMCyH+okOI3c05br3khkH0yP4kCwcE","result_xdr":"AAAAAAAAASwAAAAAAAAAAwAAAAAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAAFAAAAAAAAAAA=","result_meta_xdr":"AAAAAAAAAAMAAAACAAAAAAAAAAMAAAAAAAAAABbxCy3mLg3hiTqX4VUEEp60pFOrJNxYM1JtxXTwXhY2AAAAAAvrwgAAAAADAAAAAAAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAMAAAAAAAAAAAGUcmKO5465JxTSLQOQljwk2SfqAJmZSG6JH6wtqpwhDeC2s5t4PNQAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAwAAAAEAAAADAAAAAAAAAAABlHJijueOuScU0i0DkJY8JNkn6gCZmUhuiR+sLaqcIQAAAAAL68IAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAMAAAADAAAAAAAAAAAW8Qst5i4N4Yk6l+FVBBKetKRTqyTcWDNSbcV08F4WNgAAAAAL68IAAAAAAwAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAAADAAAAAAAAAAAW8Qst5i4N4Yk6l+FVBBKetKRTqyTcWDNSbcV08F4WNg3gtrObeDzUAAAAAwAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAAABAAAAAwAAAAAAAAAAAZRyYo7njrknFNItA5CWPCTZJ+oAmZlIbokfrC2qnCEAAAAAC+vCAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMAAAABAAAAAAAAAAABlHJijueOuScU0i0DkJY8JNkn6gCZmUhuiR+sLaqcIQ3gtrOnZAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAAADAAAAAAAAAAABlHJijueOuScU0i0DkJY8JNkn6gCZmUhuiR+sLaqcIQ3gtrOnY/7UAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"text","signatures":["SsKlst02jsaBp35vXlI300Qbz39+HbwwNDX/gfM+MwaG/dFF7bgqpkKsDAsh/qJDiN3NOW695IZB9Mj+JAsHBA=="]},{"memo":"testpool,faucet,sdf","_links":{"self":{"href":"https://horizon.stellar.org/transactions/2db4b22ca018119c5027a80578813ffcf582cda4aa9e31cd92b43cf1bda4fc5a"},"account":{"href":"https://horizon.stellar.org/accounts/GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB"},"ledger":{"href":"https://horizon.stellar.org/ledgers/7841"},"operations":{"href":"https://horizon.stellar.org/transactions/2db4b22ca018119c5027a80578813ffcf582cda4aa9e31cd92b43cf1bda4fc5a/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/2db4b22ca018119c5027a80578813ffcf582cda4aa9e31cd92b43cf1bda4fc5a/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=33676838572032"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=33676838572032"}},"id":"2db4b22ca018119c5027a80578813ffcf582cda4aa9e31cd92b43cf1bda4fc5a","paging_token":"33676838572032","successful":true,"hash":"2db4b22ca018119c5027a80578813ffcf582cda4aa9e31cd92b43cf1bda4fc5a","ledger":7841,"created_at":"2015-10-01T04:15:01Z","source_account":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB","source_account_sequence":"12884901890","fee_charged":300,"max_fee":300,"operation_count":3,"envelope_xdr":"AAAAABbxCy3mLg3hiTqX4VUEEp60pFOrJNxYM1JtxXTwXhY2AAABLAAAAAMAAAACAAAAAAAAAAEAAAATdGVzdHBvb2wsZmF1Y2V0LHNkZgAAAAADAAAAAAAAAAAAAAAAH6Ue1GOPj6Hb/ROPyIFCJpQPMujihEIvJSfK0UfMDIgAAAAAC+vCAAAAAAAAAAAAAAAAALMw4P7yJTyqj6ptNh7BPyXEoT+zVwTcU4JVbGyonvgbAAAAAAvrwgAAAAAAAAAAAAAAAABJlwu05Op/5x1uyrweYsyR6pTTos33hRNZe5IF6blnzwAAAAAL68IAAAAAAAAAAAHwXhY2AAAAQDSBB5eNEKkWIoQbZ1YQabJuE5mW/AKhrHTxw9H3m/sai90YcaZlsAe3ueO9jExjSZF289ZcR4vc0wFw1p/WyAc=","result_xdr":"AAAAAAAAASwAAAAAAAAAAwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=","result_meta_xdr":"AAAAAAAAAAMAAAACAAAAAAAAHqEAAAAAAAAAAB+lHtRjj4+h2/0Tj8iBQiaUDzLo4oRCLyUnytFHzAyIAAAAAAvrwgAAAB6hAAAAAAAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAQAAHqEAAAAAAAAAABbxCy3mLg3hiTqX4VUEEp60pFOrJNxYM1JtxXTwXhY2DeC2s4+MeHwAAAADAAAAAgAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAgAAAAAAAB6hAAAAAAAAAACzMOD+8iU8qo+qbTYewT8lxKE/s1cE3FOCVWxsqJ74GwAAAAAL68IAAAAeoQAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAB6hAAAAAAAAAAAW8Qst5i4N4Yk6l+FVBBKetKRTqyTcWDNSbcV08F4WNg3gtrODoLZ8AAAAAwAAAAIAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAIAAAAAAAAeoQAAAAAAAAAASZcLtOTqf+cdbsq8HmLMkeqU06LN94UTWXuSBem5Z88AAAAAC+vCAAAAHqEAAAAAAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAeoQAAAAAAAAAAFvELLeYuDeGJOpfhVQQSnrSkU6sk3FgzUm3FdPBeFjYN4Lazd7T0fAAAAAMAAAACAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMAAB55AAAAAAAAAAAW8Qst5i4N4Yk6l+FVBBKetKRTqyTcWDNSbcV08F4WNg3gtrObeDuoAAAAAwAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAB6hAAAAAAAAAAAW8Qst5i4N4Yk6l+FVBBKetKRTqyTcWDNSbcV08F4WNg3gtrObeDp8AAAAAwAAAAIAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"text","signatures":["NIEHl40QqRYihBtnVhBpsm4TmZb8AqGsdPHD0feb+xqL3RhxpmWwB7e5472MTGNJkXbz1lxHi9zTAXDWn9bIBw=="]},{"memo":"","_links":{"self":{"href":"https://horizon.stellar.org/transactions/3ce2aca2fed36da2faea31352c76c5e412348887a4c119b1e90de8d1b937396a"},"account":{"href":"https://horizon.stellar.org/accounts/GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB"},"ledger":{"href":"https://horizon.stellar.org/ledgers/7855"},"operations":{"href":"https://horizon.stellar.org/transactions/3ce2aca2fed36da2faea31352c76c5e412348887a4c119b1e90de8d1b937396a/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/3ce2aca2fed36da2faea31352c76c5e412348887a4c119b1e90de8d1b937396a/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=33736968114176"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=33736968114176"}},"id":"3ce2aca2fed36da2faea31352c76c5e412348887a4c119b1e90de8d1b937396a","paging_token":"33736968114176","successful":true,"hash":"3ce2aca2fed36da2faea31352c76c5e412348887a4c119b1e90de8d1b937396a","ledger":7855,"created_at":"2015-10-01T04:16:11Z","source_account":"GALPCCZN4YXA3YMJHKL6CVIECKPLJJCTVMSNYWBTKJW4K5HQLYLDMZTB","source_account_sequence":"12884901891","fee_charged":100,"max_fee":100,"operation_count":1,"envelope_xdr":"AAAAABbxCy3mLg3hiTqX4VUEEp60pFOrJNxYM1JtxXTwXhY2AAAAZAAAAAMAAAADAAAAAAAAAAEAAAAAAAAAAQAAAAAAAAAFAAAAAQAAAAAfpR7UY4+Podv9E4/IgUImlA8y6OKEQi8lJ8rRR8wMiAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAHwXhY2AAAAQNbDcWsR3s3z8Qzqatcdc/k2L4LXWJMA6eXac8dbXkAdc4ppH25isGC5OwvG06Vwvc3Ce3/r2rYcBP3vxhx18A8=","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAAFAAAAAAAAAAA=","result_meta_xdr":"AAAAAAAAAAEAAAABAAAAAQAAHq8AAAAAAAAAABbxCy3mLg3hiTqX4VUEEp60pFOrJNxYM1JtxXTwXhY2DeC2s3e09BgAAAADAAAAAwAAAAAAAAABAAAAAB+lHtRjj4+h2/0Tj8iBQiaUDzLo4oRCLyUnytFHzAyIAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAA","fee_meta_xdr":"AAAAAgAAAAMAAB6hAAAAAAAAAAAW8Qst5i4N4Yk6l+FVBBKetKRTqyTcWDNSbcV08F4WNg3gtrN3tPR8AAAAAwAAAAIAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAB6vAAAAAAAAAAAW8Qst5i4N4Yk6l+FVBBKetKRTqyTcWDNSbcV08F4WNg3gtrN3tPQYAAAAAwAAAAMAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"text","signatures":["1sNxaxHezfPxDOpq1x1z+TYvgtdYkwDp5dpzx1teQB1zimkfbmKwYLk7C8bTpXC9zcJ7f+vathwE/e/GHHXwDw=="]}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/transactions","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"List All Transactions","description":{"content":"This endpoint lists all Successful transactions and can be used in streaming mode. Streaming mode allows you to listen for new transactions as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known transaction unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream transactions created since your request time.","type":"text/plain"},"url":{"path":["transactions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Set to true to include failed operations in results. Options include true and false.","type":"text/plain"},"key":"include_failed","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/list-strict-receive-payment-paths.api.mdx b/api/horizon/resources/list-strict-receive-payment-paths.api.mdx index c04e1d63e..f2faa9856 100644 --- a/api/horizon/resources/list-strict-receive-payment-paths.api.mdx +++ b/api/horizon/resources/list-strict-receive-payment-paths.api.mdx @@ -5,7 +5,7 @@ description: "The strict receive payment path endpoint lists the paths a payment sidebar_label: "List Strict Receive Payment Paths" hide_title: true hide_table_of_contents: true -api: {"tags":["Paths"],"description":"The strict receive payment path endpoint lists the paths a payment can take based on the amount of an asset you want the recipient to receive. The destination asset amount stays constant, and the type and amount of an asset sent varies based on offers in the order books. For this search, Horizon loads a list of assets available to the sender (based on source_account or source_assets) and displays the possible paths from the different source assets to the destination asset. Only paths that satisfy the destination_amount are returned.","operationId":"ListStrictReceivePaymentPaths","parameters":[{"name":"source_account","in":"query","required":false,"description":"The Stellar address of the sender. Any returned path must start with an asset that the sender holds. Using either source_account or source_assets as an argument is required for strict receive path payments."},{"name":"source_assets","in":"query","required":false,"description":"A comma-separated list of assets available to the sender. Any returned path must start with an asset in this list. Each asset is formatted as CODE:ISSUER_ACCOUNT. For example: USD:GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX. Using either source_account or source_assets as an argument is required for strict receive path payments.","schema":{"type":"string","example":"CNY:GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX"}},{"name":"destination_asset_type","in":"path","required":true,"description":"The type for the destination asset. Either native, credit_alphanum4, or credit_alphanum12.","schema":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]}},{"name":"destination_asset_issuer","in":"query","required":false,"description":"The Stellar address of the issuer of the destination asset. Required if the destination_asset_type is not native."},{"name":"destination_asset_code","in":"query","required":false,"description":"The code for the destination asset. Required if the destination_asset_type is not native."},{"name":"destination_amount","in":"path","required":true,"description":"The amount of the destination asset that should be received."}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"source_asset_type":{"type":"string"},"source_asset_code":{"type":"string"},"source_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"source_amount":{"type":"string"},"destination_asset_type":{"type":"string"},"destination_asset_code":{"type":"string"},"destination_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"destination_amount":{"type":"string"},"path":{"type":"array","items":{"type":"object","properties":{"asset_type":{"type":"string"},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["asset_type"],"title":"schemas-Asset"}}}},"required":["source_asset_type","source_amount","destination_asset_type","destination_amount","path"]}}}},"title":"Path"},"examples":{"ListStrictRecievePaymentPaths":{"value":{"_embedded":{"records":[{"source_asset_type":"credit_alphanum4","source_asset_code":"CNY","source_asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","source_amount":"28.9871131","destination_asset_type":"credit_alphanum4","destination_asset_code":"BB1","destination_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","destination_amount":"5.0000000","path":[{"asset_type":"credit_alphanum4","asset_code":"XCN","asset_issuer":"GCNY5OXYSY4FKHOPT2SPOQZAOEIGXB5LBYW3HVU3OWSTQITS65M5RCNY"},{"asset_type":"native"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"CNY","source_asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","source_amount":"29.0722784","destination_asset_type":"credit_alphanum4","destination_asset_code":"BB1","destination_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","destination_amount":"5.0000000","path":[{"asset_type":"credit_alphanum4","asset_code":"ULT","asset_issuer":"GC76RMFNNXBFDSJRBXCABWLHXDK4ITVQSMI56DC2ZJVC3YOLLPCKKULT"},{"asset_type":"native"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"CNY","source_asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","source_amount":"29.4000002","destination_asset_type":"credit_alphanum4","destination_asset_code":"BB1","destination_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","destination_amount":"5.0000000","path":[{"asset_type":"native"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"CNY","source_asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","source_amount":"31.8955888","destination_asset_type":"credit_alphanum4","destination_asset_code":"BB1","destination_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","destination_amount":"5.0000000","path":[{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GBUYUAI75XXWDZEKLY66CFYKQPET5JR4EENXZBUZ3YXZ7DS56Z4OKOFU"},{"asset_type":"native"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"CNY","source_asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","source_amount":"34.7086084","destination_asset_type":"credit_alphanum4","destination_asset_code":"BB1","destination_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","destination_amount":"5.0000000","path":[{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"},{"asset_type":"native"}]}]}}}}}}}},"method":"get","path":"/paths/strict-receive{destination_asset_type}{destination_amount}","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"}} +api: {"tags":["Paths"],"description":"The strict receive payment path endpoint lists the paths a payment can take based on the amount of an asset you want the recipient to receive. The destination asset amount stays constant, and the type and amount of an asset sent varies based on offers in the order books. For this search, Horizon loads a list of assets available to the sender (based on source_account or source_assets) and displays the possible paths from the different source assets to the destination asset. Only paths that satisfy the destination_amount are returned.","operationId":"ListStrictReceivePaymentPaths","parameters":[{"name":"source_account","in":"query","required":false,"description":"The Stellar address of the sender. Any returned path must start with an asset that the sender holds. Using either source_account or source_assets as an argument is required for strict receive path payments."},{"name":"source_assets","in":"query","required":false,"description":"A comma-separated list of assets available to the sender. Any returned path must start with an asset in this list. Each asset is formatted as CODE:ISSUER_ACCOUNT. For example: USD:GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX. Using either source_account or source_assets as an argument is required for strict receive path payments.","schema":{"type":"string","example":"CNY:GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX"}},{"name":"destination_asset_type","in":"path","required":true,"description":"The type for the destination asset. Either native, credit_alphanum4, or credit_alphanum12.","schema":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]}},{"name":"destination_asset_issuer","in":"query","required":false,"description":"The Stellar address of the issuer of the destination asset. Required if the destination_asset_type is not native."},{"name":"destination_asset_code","in":"query","required":false,"description":"The code for the destination asset. Required if the destination_asset_type is not native."},{"name":"destination_amount","in":"path","required":true,"description":"The amount of the destination asset that should be received."}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"source_asset_type":{"type":"string"},"source_asset_code":{"type":"string"},"source_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"source_amount":{"type":"string"},"destination_asset_type":{"type":"string"},"destination_asset_code":{"type":"string"},"destination_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"destination_amount":{"type":"string"},"path":{"type":"array","items":{"type":"object","properties":{"asset_type":{"type":"string"},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["asset_type"],"title":"schemas-Asset"}}}},"required":["source_asset_type","source_amount","destination_asset_type","destination_amount","path"]}}}},"title":"Path"},"examples":{"ListStrictRecievePaymentPaths":{"value":{"_embedded":{"records":[{"source_asset_type":"credit_alphanum4","source_asset_code":"CNY","source_asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","source_amount":"28.9871131","destination_asset_type":"credit_alphanum4","destination_asset_code":"BB1","destination_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","destination_amount":"5.0000000","path":[{"asset_type":"credit_alphanum4","asset_code":"XCN","asset_issuer":"GCNY5OXYSY4FKHOPT2SPOQZAOEIGXB5LBYW3HVU3OWSTQITS65M5RCNY"},{"asset_type":"native"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"CNY","source_asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","source_amount":"29.0722784","destination_asset_type":"credit_alphanum4","destination_asset_code":"BB1","destination_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","destination_amount":"5.0000000","path":[{"asset_type":"credit_alphanum4","asset_code":"ULT","asset_issuer":"GC76RMFNNXBFDSJRBXCABWLHXDK4ITVQSMI56DC2ZJVC3YOLLPCKKULT"},{"asset_type":"native"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"CNY","source_asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","source_amount":"29.4000002","destination_asset_type":"credit_alphanum4","destination_asset_code":"BB1","destination_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","destination_amount":"5.0000000","path":[{"asset_type":"native"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"CNY","source_asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","source_amount":"31.8955888","destination_asset_type":"credit_alphanum4","destination_asset_code":"BB1","destination_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","destination_amount":"5.0000000","path":[{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GBUYUAI75XXWDZEKLY66CFYKQPET5JR4EENXZBUZ3YXZ7DS56Z4OKOFU"},{"asset_type":"native"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"CNY","source_asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","source_amount":"34.7086084","destination_asset_type":"credit_alphanum4","destination_asset_code":"BB1","destination_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","destination_amount":"5.0000000","path":[{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"},{"asset_type":"native"}]}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/paths/strict-receive{destination_asset_type}{destination_amount}","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/list-strict-send-payment-paths.api.mdx b/api/horizon/resources/list-strict-send-payment-paths.api.mdx index e7b9ce1f0..06a02a78f 100644 --- a/api/horizon/resources/list-strict-send-payment-paths.api.mdx +++ b/api/horizon/resources/list-strict-send-payment-paths.api.mdx @@ -5,7 +5,7 @@ description: "The strict send payment path endpoint lists the paths a payment ca sidebar_label: "List Strict Send Payment Paths" hide_title: true hide_table_of_contents: true -api: {"tags":["Paths"],"description":"The strict send payment path endpoint lists the paths a payment can take based on the amount of an asset you want to send. The source asset amount stays constant, and the type and amount of an asset received varies based on offers in the order books. For this search, Horizon loads a list of assets that the recipient can recieve (based on destination_account or destination_assets) and displays the possible paths from the different source assets to the destination asset. Only paths that satisfy the source_amount are returned.","operationId":"ListStrictSendPaymentPaths","parameters":[{"name":"source_account","in":"query","required":false,"description":"The Stellar address of the sender. Any returned path must start with an asset that the sender holds. Using either source_account or source_assets as an argument is required for strict receive path payments."},{"name":"source_assets","in":"query","required":false,"description":"A comma-separated list of assets available to the sender. Any returned path must start with an asset in this list. Each asset is formatted as CODE:ISSUER_ACCOUNT. For example: USD:GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX. Using either source_account or source_assets as an argument is required for strict receive path payments.","schema":{"type":"string","example":"CNY:GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX"}},{"name":"source_asset_type","in":"path","required":true,"description":"The type for the source asset. Either native, credit_alphanum4, or credit_alphanum12.","schema":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]}},{"name":"source_asset_issuer","in":"query","required":false,"description":"The Stellar address of the issuer of the source asset. Required if the source_asset_type is not native."},{"name":"source_asset_code","in":"query","required":false,"description":"The code for the source asset. Required if the source_asset_type is not native."},{"name":"source_amount","in":"path","required":true,"description":"The amount of the source asset that should be sent."},{"name":"destination_account","in":"query","required":false,"description":"The Stellar address of the reciever. Any returned path must end with an asset that the recipient can receive. Using either source_account or source_assets as an argument is required for strict send path payments."},{"name":"destination_assets","in":"query","required":false,"description":"A comma-separated list of assets that the recipient can receive. Any returned path must end with an asset in this list. Each asset is formatted as CODE:ISSUER_ACCOUNT. For example: USD:GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX. Using either source_account or source_assets as an argument is required for strict send path payments.","schema":{"type":"array","items":{"type":"string"}}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"source_asset_type":{"type":"string"},"source_asset_code":{"type":"string"},"source_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"source_amount":{"type":"string"},"destination_asset_type":{"type":"string"},"destination_asset_code":{"type":"string"},"destination_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"destination_amount":{"type":"string"},"path":{"type":"array","items":{"type":"object","properties":{"asset_type":{"type":"string"},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["asset_type"],"title":"schemas-Asset"}}}},"required":["source_asset_type","source_amount","destination_asset_type","destination_amount","path"]}}}},"title":"Path"},"examples":{"ListStrictSendPaymentPaths":{"value":{"_embedded":{"records":[{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"BB1","destination_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","destination_amount":"87.6373649","path":[{"asset_type":"native"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"BB1","destination_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","destination_amount":"36.0841597","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"EURT","asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"BB1","destination_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","destination_amount":"16.2264000","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"BTC","asset_issuer":"GBVOL67TMUQBGL4TZYNMY3ZQ5WGQYFPFD5VJRWXR72VA33VFNL225PL5"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"BB1","destination_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","destination_amount":"13.9424750","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"CNY","destination_asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","destination_amount":"499.8384123","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"ULT","asset_issuer":"GC76RMFNNXBFDSJRBXCABWLHXDK4ITVQSMI56DC2ZJVC3YOLLPCKKULT"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"CNY","destination_asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","destination_amount":"498.1069097","path":[{"asset_type":"native"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"CNY","destination_asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","destination_amount":"494.5886542","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"XCN","asset_issuer":"GCNY5OXYSY4FKHOPT2SPOQZAOEIGXB5LBYW3HVU3OWSTQITS65M5RCNY"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"CNY","destination_asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","destination_amount":"490.0780598","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"CNY","destination_asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","destination_amount":"280.2909824","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GBUYUAI75XXWDZEKLY66CFYKQPET5JR4EENXZBUZ3YXZ7DS56Z4OKOFU"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"EURT","destination_asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","destination_amount":"63.1883029","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"EURT","destination_asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","destination_amount":"63.1472796","path":[{"asset_type":"native"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"EURT","destination_asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","destination_amount":"62.9386895","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"NGNT","asset_issuer":"GAWODAROMJ33V5YDFY3NPYTHVYQG7MJXVJ2ND3AOGIHYRWINES6ACCPD"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"EURT","destination_asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","destination_amount":"6.7649849","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"WSD","asset_issuer":"GDSVWEA7XV6M5XNLODVTPCGMAJTNBLZBXOFNQD3BNPNYALEYBNT6CE2V"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"EURT","destination_asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","destination_amount":"0.0498106","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"CNY","asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"NGNT","destination_asset_issuer":"GAWODAROMJ33V5YDFY3NPYTHVYQG7MJXVJ2ND3AOGIHYRWINES6ACCPD","destination_amount":"25155.3452034","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"NGNT","destination_asset_issuer":"GAWODAROMJ33V5YDFY3NPYTHVYQG7MJXVJ2ND3AOGIHYRWINES6ACCPD","destination_amount":"25146.7108397","path":[{"asset_type":"native"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"NGNT","destination_asset_issuer":"GAWODAROMJ33V5YDFY3NPYTHVYQG7MJXVJ2ND3AOGIHYRWINES6ACCPD","destination_amount":"24986.8616583","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"BTC","asset_issuer":"GAUTUYY2THLF7SGITDFMXJVYH3LHDSMGEAKSBU267M2K7A3W543CKUEF"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"NGNT","destination_asset_issuer":"GAWODAROMJ33V5YDFY3NPYTHVYQG7MJXVJ2ND3AOGIHYRWINES6ACCPD","destination_amount":"24948.9784843","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"XCN","asset_issuer":"GCNY5OXYSY4FKHOPT2SPOQZAOEIGXB5LBYW3HVU3OWSTQITS65M5RCNY"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"NGNT","destination_asset_issuer":"GAWODAROMJ33V5YDFY3NPYTHVYQG7MJXVJ2ND3AOGIHYRWINES6ACCPD","destination_amount":"24930.7854717","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"EURT","asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"USD","destination_asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","destination_amount":"69.7123752","path":[{"asset_type":"native"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"USD","destination_asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","destination_amount":"68.9785993","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"EURT","asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"USD","destination_asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","destination_amount":"68.6731854","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"NGNT","asset_issuer":"GAWODAROMJ33V5YDFY3NPYTHVYQG7MJXVJ2ND3AOGIHYRWINES6ACCPD"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"USD","destination_asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","destination_amount":"63.5394120","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GBUYUAI75XXWDZEKLY66CFYKQPET5JR4EENXZBUZ3YXZ7DS56Z4OKOFU"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"USD","destination_asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","destination_amount":"39.6691360","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"HEX","asset_issuer":"GCGBSZ3DSSH6PRHCOD4JXFNNZXCTKBDFRT4JR2HIAC6FQZU4YK7GPHEX"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"native","destination_amount":"1226.9231099","path":[]}]}}}}}}}},"method":"get","path":"/paths/strict-send{source_asset_type}{source_amount}","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"}} +api: {"tags":["Paths"],"description":"The strict send payment path endpoint lists the paths a payment can take based on the amount of an asset you want to send. The source asset amount stays constant, and the type and amount of an asset received varies based on offers in the order books. For this search, Horizon loads a list of assets that the recipient can recieve (based on destination_account or destination_assets) and displays the possible paths from the different source assets to the destination asset. Only paths that satisfy the source_amount are returned.","operationId":"ListStrictSendPaymentPaths","parameters":[{"name":"source_account","in":"query","required":false,"description":"The Stellar address of the sender. Any returned path must start with an asset that the sender holds. Using either source_account or source_assets as an argument is required for strict receive path payments."},{"name":"source_assets","in":"query","required":false,"description":"A comma-separated list of assets available to the sender. Any returned path must start with an asset in this list. Each asset is formatted as CODE:ISSUER_ACCOUNT. For example: USD:GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX. Using either source_account or source_assets as an argument is required for strict receive path payments.","schema":{"type":"string","example":"CNY:GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX"}},{"name":"source_asset_type","in":"path","required":true,"description":"The type for the source asset. Either native, credit_alphanum4, or credit_alphanum12.","schema":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]}},{"name":"source_asset_issuer","in":"query","required":false,"description":"The Stellar address of the issuer of the source asset. Required if the source_asset_type is not native."},{"name":"source_asset_code","in":"query","required":false,"description":"The code for the source asset. Required if the source_asset_type is not native."},{"name":"source_amount","in":"path","required":true,"description":"The amount of the source asset that should be sent."},{"name":"destination_account","in":"query","required":false,"description":"The Stellar address of the reciever. Any returned path must end with an asset that the recipient can receive. Using either source_account or source_assets as an argument is required for strict send path payments."},{"name":"destination_assets","in":"query","required":false,"description":"A comma-separated list of assets that the recipient can receive. Any returned path must end with an asset in this list. Each asset is formatted as CODE:ISSUER_ACCOUNT. For example: USD:GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX. Using either source_account or source_assets as an argument is required for strict send path payments.","schema":{"type":"array","items":{"type":"string"}}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"source_asset_type":{"type":"string"},"source_asset_code":{"type":"string"},"source_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"source_amount":{"type":"string"},"destination_asset_type":{"type":"string"},"destination_asset_code":{"type":"string"},"destination_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"destination_amount":{"type":"string"},"path":{"type":"array","items":{"type":"object","properties":{"asset_type":{"type":"string"},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}},"required":["asset_type"],"title":"schemas-Asset"}}}},"required":["source_asset_type","source_amount","destination_asset_type","destination_amount","path"]}}}},"title":"Path"},"examples":{"ListStrictSendPaymentPaths":{"value":{"_embedded":{"records":[{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"BB1","destination_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","destination_amount":"87.6373649","path":[{"asset_type":"native"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"BB1","destination_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","destination_amount":"36.0841597","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"EURT","asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"BB1","destination_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","destination_amount":"16.2264000","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"BTC","asset_issuer":"GBVOL67TMUQBGL4TZYNMY3ZQ5WGQYFPFD5VJRWXR72VA33VFNL225PL5"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"BB1","destination_asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN","destination_amount":"13.9424750","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"CNY","destination_asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","destination_amount":"499.8384123","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"ULT","asset_issuer":"GC76RMFNNXBFDSJRBXCABWLHXDK4ITVQSMI56DC2ZJVC3YOLLPCKKULT"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"CNY","destination_asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","destination_amount":"498.1069097","path":[{"asset_type":"native"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"CNY","destination_asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","destination_amount":"494.5886542","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"XCN","asset_issuer":"GCNY5OXYSY4FKHOPT2SPOQZAOEIGXB5LBYW3HVU3OWSTQITS65M5RCNY"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"CNY","destination_asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","destination_amount":"490.0780598","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"CNY","destination_asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX","destination_amount":"280.2909824","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GBUYUAI75XXWDZEKLY66CFYKQPET5JR4EENXZBUZ3YXZ7DS56Z4OKOFU"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"EURT","destination_asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","destination_amount":"63.1883029","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"EURT","destination_asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","destination_amount":"63.1472796","path":[{"asset_type":"native"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"EURT","destination_asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","destination_amount":"62.9386895","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"NGNT","asset_issuer":"GAWODAROMJ33V5YDFY3NPYTHVYQG7MJXVJ2ND3AOGIHYRWINES6ACCPD"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"EURT","destination_asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","destination_amount":"6.7649849","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"WSD","asset_issuer":"GDSVWEA7XV6M5XNLODVTPCGMAJTNBLZBXOFNQD3BNPNYALEYBNT6CE2V"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"EURT","destination_asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","destination_amount":"0.0498106","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"CNY","asset_issuer":"GAREELUB43IRHWEASCFBLKHURCGMHE5IF6XSE7EXDLACYHGRHM43RFOX"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"NGNT","destination_asset_issuer":"GAWODAROMJ33V5YDFY3NPYTHVYQG7MJXVJ2ND3AOGIHYRWINES6ACCPD","destination_amount":"25155.3452034","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"NGNT","destination_asset_issuer":"GAWODAROMJ33V5YDFY3NPYTHVYQG7MJXVJ2ND3AOGIHYRWINES6ACCPD","destination_amount":"25146.7108397","path":[{"asset_type":"native"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"NGNT","destination_asset_issuer":"GAWODAROMJ33V5YDFY3NPYTHVYQG7MJXVJ2ND3AOGIHYRWINES6ACCPD","destination_amount":"24986.8616583","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"BTC","asset_issuer":"GAUTUYY2THLF7SGITDFMXJVYH3LHDSMGEAKSBU267M2K7A3W543CKUEF"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"NGNT","destination_asset_issuer":"GAWODAROMJ33V5YDFY3NPYTHVYQG7MJXVJ2ND3AOGIHYRWINES6ACCPD","destination_amount":"24948.9784843","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"XCN","asset_issuer":"GCNY5OXYSY4FKHOPT2SPOQZAOEIGXB5LBYW3HVU3OWSTQITS65M5RCNY"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"NGNT","destination_asset_issuer":"GAWODAROMJ33V5YDFY3NPYTHVYQG7MJXVJ2ND3AOGIHYRWINES6ACCPD","destination_amount":"24930.7854717","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"EURT","asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"USD","destination_asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","destination_amount":"69.7123752","path":[{"asset_type":"native"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"USD","destination_asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","destination_amount":"68.9785993","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"EURT","asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"USD","destination_asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","destination_amount":"68.6731854","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"NGNT","asset_issuer":"GAWODAROMJ33V5YDFY3NPYTHVYQG7MJXVJ2ND3AOGIHYRWINES6ACCPD"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"USD","destination_asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","destination_amount":"63.5394120","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GBUYUAI75XXWDZEKLY66CFYKQPET5JR4EENXZBUZ3YXZ7DS56Z4OKOFU"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"credit_alphanum4","destination_asset_code":"USD","destination_asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","destination_amount":"39.6691360","path":[{"asset_type":"native"},{"asset_type":"credit_alphanum4","asset_code":"HEX","asset_issuer":"GCGBSZ3DSSH6PRHCOD4JXFNNZXCTKBDFRT4JR2HIAC6FQZU4YK7GPHEX"}]},{"source_asset_type":"credit_alphanum4","source_asset_code":"BRL","source_asset_issuer":"GDVKY2GU2DRXWTBEYJJWSFXIGBZV6AZNBVVSUHEPZI54LIS6BA7DVVSP","source_amount":"400.0000000","destination_asset_type":"native","destination_amount":"1226.9231099","path":[]}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/paths/strict-send{source_asset_type}{source_amount}","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/lp-retrieve-related-operations.api.mdx b/api/horizon/resources/lp-retrieve-related-operations.api.mdx index e87f639f3..8469bafae 100644 --- a/api/horizon/resources/lp-retrieve-related-operations.api.mdx +++ b/api/horizon/resources/lp-retrieve-related-operations.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint represents successful operations referencing a given sidebar_label: "Retrieve Related Operations" hide_title: true hide_table_of_contents: true -api: {"tags":["Liquidity Pools"],"description":"This endpoint represents successful operations referencing a given liquidity pool and can be used in streaming mode. Streaming mode allows you to listen for new operations referencing this liquidity pool as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known operation unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream operations created since your request time.","operationId":"LPRetrieveRelatedOperations","parameters":[{"name":"liquidity_pool_id","in":"path","required":true,"description":"A unique identifier for this liquidity pool."},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}},{"name":"include_failed","in":"query","required":false,"description":"Set to true to include failed operations in results. Options include true and false.","schema":{"type":"boolean","enum":[true,false]}},{"name":"join","in":"query","required":false,"description":"Set to transactions to include the transactions which created each of the operations in the response."}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_links":{"type":"object","properties":{"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}},"id":{"type":"string","title":"id"},"paging_token":{"type":"string","title":"paging_token"},"type_i":{"type":"number","example":0},"type":{"type":"string","example":"create_account"}},"title":"Operation"}]},"examples":{"LPRetrieveRelatedOperations":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/liquidity_pools/67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9/operations?cursor=&limit=3&order=asc"},"next":{"href":"https://horizon.stellar.org/liquidity_pools/67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9/operations?cursor=120192452165550081&limit=3&order=asc"},"prev":{"href":"https://horizon.stellar.org/liquidity_pools/67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9/operations?cursor=120192344791343105&limit=3&order=desc"}},"_embedded":{"records":[{"id":"3697472920621057","paging_token":"3697472920621057","transaction_successful":true,"source_account":"GBB4JST32UWKOLGYYSCEYBHBCOFL2TGBHDVOMZP462ET4ZRD4ULA7S2L","type":"liquidity_pool_withdraw","type_i":23,"created_at":"2021-11-18T03:47:47Z","transaction_hash":"43ed5ce19190822ec080b67c3ccbab36a56bc34102b1a21d3ee690ed3bc23378","liquidity_pool_id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9","reserves_min":[{"asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","min":"1000.0000005"},{"asset":"PHP:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","min":"3000.0000005"}],"shares":"200","reserves_received":[{"asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","amount":"993.0000005"},{"asset":"PHP:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","amount":"2478.0000005"}]},{"id":"157639717969326081","paging_token":"157639717969326081","transaction_successful":true,"source_account":"GBBWI7TEVQBPEUXKYNGI3GBAH7EHFEREONKK3UK56ZSLJIDIYHQJCVSG","type":"change_trust","type_i":6,"created_at":"2021-08-04T20:01:24Z","transaction_hash":"941f2fa2101d1265696a3c7d35e7688cd210324114e96b64a386ab55f65e488f","asset_type":"liquidity_pool_shares","liquidity_pool_id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9","limit":"1000","trustor":"GBBWI7TEVQBPEUXKYNGI3GBAH7EHFEREONKK3UK56ZSLJIDIYHQJCVSG"}]}}}}}}}},"method":"get","path":"/liquidity_pools/{liquidity_pool_id}/operations","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve Related Operations","description":{"content":"This endpoint represents successful operations referencing a given liquidity pool and can be used in streaming mode. Streaming mode allows you to listen for new operations referencing this liquidity pool as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known operation unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream operations created since your request time.","type":"text/plain"},"url":{"path":["liquidity_pools",":liquidity_pool_id","operations"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Set to true to include failed operations in results. Options include true and false.","type":"text/plain"},"key":"include_failed","value":""},{"description":{"content":"Set to transactions to include the transactions which created each of the operations in the response.","type":"text/plain"},"key":"join","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) A unique identifier for this liquidity pool.","type":"text/plain"},"type":"any","value":"","key":"liquidity_pool_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Liquidity Pools"],"description":"This endpoint represents successful operations referencing a given liquidity pool and can be used in streaming mode. Streaming mode allows you to listen for new operations referencing this liquidity pool as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known operation unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream operations created since your request time.","operationId":"LPRetrieveRelatedOperations","parameters":[{"name":"liquidity_pool_id","in":"path","required":true,"description":"A unique identifier for this liquidity pool."},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}},{"name":"include_failed","in":"query","required":false,"description":"Set to true to include failed operations in results. Options include true and false.","schema":{"type":"boolean","enum":[true,false]}},{"name":"join","in":"query","required":false,"description":"Set to transactions to include the transactions which created each of the operations in the response."}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_links":{"type":"object","properties":{"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}},"id":{"type":"string","title":"id"},"paging_token":{"type":"string","title":"paging_token"},"type_i":{"type":"number","example":0},"type":{"type":"string","example":"create_account"}},"title":"Operation"}]},"examples":{"LPRetrieveRelatedOperations":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/liquidity_pools/67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9/operations?cursor=&limit=3&order=asc"},"next":{"href":"https://horizon.stellar.org/liquidity_pools/67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9/operations?cursor=120192452165550081&limit=3&order=asc"},"prev":{"href":"https://horizon.stellar.org/liquidity_pools/67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9/operations?cursor=120192344791343105&limit=3&order=desc"}},"_embedded":{"records":[{"id":"3697472920621057","paging_token":"3697472920621057","transaction_successful":true,"source_account":"GBB4JST32UWKOLGYYSCEYBHBCOFL2TGBHDVOMZP462ET4ZRD4ULA7S2L","type":"liquidity_pool_withdraw","type_i":23,"created_at":"2021-11-18T03:47:47Z","transaction_hash":"43ed5ce19190822ec080b67c3ccbab36a56bc34102b1a21d3ee690ed3bc23378","liquidity_pool_id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9","reserves_min":[{"asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","min":"1000.0000005"},{"asset":"PHP:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","min":"3000.0000005"}],"shares":"200","reserves_received":[{"asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","amount":"993.0000005"},{"asset":"PHP:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","amount":"2478.0000005"}]},{"id":"157639717969326081","paging_token":"157639717969326081","transaction_successful":true,"source_account":"GBBWI7TEVQBPEUXKYNGI3GBAH7EHFEREONKK3UK56ZSLJIDIYHQJCVSG","type":"change_trust","type_i":6,"created_at":"2021-08-04T20:01:24Z","transaction_hash":"941f2fa2101d1265696a3c7d35e7688cd210324114e96b64a386ab55f65e488f","asset_type":"liquidity_pool_shares","liquidity_pool_id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9","limit":"1000","trustor":"GBBWI7TEVQBPEUXKYNGI3GBAH7EHFEREONKK3UK56ZSLJIDIYHQJCVSG"}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/liquidity_pools/{liquidity_pool_id}/operations","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve Related Operations","description":{"content":"This endpoint represents successful operations referencing a given liquidity pool and can be used in streaming mode. Streaming mode allows you to listen for new operations referencing this liquidity pool as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known operation unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream operations created since your request time.","type":"text/plain"},"url":{"path":["liquidity_pools",":liquidity_pool_id","operations"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Set to true to include failed operations in results. Options include true and false.","type":"text/plain"},"key":"include_failed","value":""},{"description":{"content":"Set to transactions to include the transactions which created each of the operations in the response.","type":"text/plain"},"key":"join","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) A unique identifier for this liquidity pool.","type":"text/plain"},"type":"any","value":"","key":"liquidity_pool_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/lp-retrieve-related-transactions.api.mdx b/api/horizon/resources/lp-retrieve-related-transactions.api.mdx index a45ec122a..16ae6a509 100644 --- a/api/horizon/resources/lp-retrieve-related-transactions.api.mdx +++ b/api/horizon/resources/lp-retrieve-related-transactions.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint represents successful transactions referencing a giv sidebar_label: "Retrieve Related Transactions" hide_title: true hide_table_of_contents: true -api: {"tags":["Liquidity Pools"],"description":"This endpoint represents successful transactions referencing a given liquidity pool and can be used in streaming mode. Streaming mode allows you to listen for new transactions referencing this liquidity pool as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known transaction unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream transactions created since your request time.","operationId":"LPRetrieveRelatedTransactions","parameters":[{"name":"liquidity_pool_id","in":"path","required":true,"description":"A unique identifier for this liquidity pool."},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}},{"name":"include_failed","in":"query","required":false,"description":"Set to true to include failed operations in results. Options include true and false.","schema":{"type":"boolean","enum":[true,false]}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"memo":{"type":"string"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"account":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"ledger":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"operations":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","account","ledger","operations","effects","precedes","succeeds","transaction"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"successful":{"type":"boolean"},"hash":{"type":"string"},"ledger":{"type":"integer","format":"int32"},"created_at":{"type":"string"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"account_muxed":{"type":"string"},"account_muxed_id":{"type":"string"},"source_account_sequence":{"type":"string"},"fee_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"fee_account_muxed":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"fee_account_muxed_id":{"type":"string"},"fee_charged":{"type":"string"},"max_fee":{"type":"string"},"operation_count":{"type":"integer","format":"int32"},"envelope_xdr":{"type":"string"},"result_xdr":{"type":"string"},"result_meta_xdr":{"type":"string"},"fee_meta_xdr":{"type":"string"},"memo_type":{"type":"string"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"},"valid_after":{"type":"string"},"valid_before":{"type":"string"},"preconditions":{"type":"object","properties":{"timebounds":{"type":"object","properties":{"min_time":{"type":"string"},"max_time":{"type":"string"}},"title":"TransactionPreconditionsTimebounds"},"ledgerbounds":{"type":"object","properties":{"min_ledger":{"type":"string"},"max_ledger":{"type":"string"}},"title":"TransactionPreconditionsLedgerbounds"},"min_account_sequence":{"type":"string"},"min_account_sequence_age":{"type":"string"},"min_account_sequence_ledger_gap":{"type":"integer","format":"uint32"},"extra_signers":{"type":"array","items":{"type":"string"}}},"title":"TransactionPreconditions"},"fee_bump_transaction":{"type":"object","properties":{"hash":{"type":"string","title":"hash"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"}},"title":"FeeBumpTransaction"},"inner_transaction":{"type":"object","properties":{"hash":{"type":"string","title":"hash"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"},"max_fee":{"type":"string"}},"title":"InnerTransaction"}},"required":["id","paging_token","successful","hash","ledger","created_at","source_account","source_account_sequence","fee_account","fee_charged","max_fee","operation_count","envelope_xdr","result_xdr","result_meta_xdr","memo_type","signatures"]}}}}},"title":"Transaction"}]},"examples":{"LPRetrieveRelatedTransactions":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/liquidity_pools/3b476aff8a406a6ec3b61d5c038009cef85f2ddfaf616822dc4fec92845149b4/transactions?cursor=&limit=2&order=asc"},"next":{"href":"https://horizon.stellar.org/liquidity_pools/3b476aff8a406a6ec3b61d5c038009cef85f2ddfaf616822dc4fec92845149b4/transactions?cursor=120192370561220608&limit=2&order=asc"},"prev":{"href":"https://horizon.stellar.org/liquidity_pools/3b476aff8a406a6ec3b61d5c038009cef85f2ddfaf616822dc4fec92845149b4/transactions?cursor=120192344791343104&limit=2&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/transactions/2ff47e1bafe68639276b2a8df0a73597ee0c062fbcc72d121af314fe7851c908"},"account":{"href":"https://horizon.stellar.org/accounts/GAHQN6YNYD6ZT7TLAVE4R36MSZWQJZ22XB3WD4RLSHURMXHW4VHJIDF7"},"ledger":{"href":"https://horizon.stellar.org/ledgers/895788"},"operations":{"href":"https://horizon.stellar.org/transactions/2ff47e1bafe68639276b2a8df0a73597ee0c062fbcc72d121af314fe7851c908/operations","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/2ff47e1bafe68639276b2a8df0a73597ee0c062fbcc72d121af314fe7851c908/effects","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=3847380164161536"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=3847380164161536"},"transaction":{"href":"https://horizon.stellar.org/transactions/2ff47e1bafe68639276b2a8df0a73597ee0c062fbcc72d121af314fe7851c908"}},"id":"2ff47e1bafe68639276b2a8df0a73597ee0c062fbcc72d121af314fe7851c908","paging_token":"3847380164161536","successful":true,"hash":"2ff47e1bafe68639276b2a8df0a73597ee0c062fbcc72d121af314fe7851c908","ledger":895788,"created_at":"2021-08-09T20:53:11Z","source_account":"GAHQN6YNYD6ZT7TLAVE4R36MSZWQJZ22XB3WD4RLSHURMXHW4VHJIDF7","source_account_sequence":"3847371574214658","fee_account":"GAHQN6YNYD6ZT7TLAVE4R36MSZWQJZ22XB3WD4RLSHURMXHW4VHJIDF7","fee_charged":"10000","max_fee":"10001","operation_count":1,"envelope_xdr":"AAAAAgAAAAAPBvsNwP2Z/msFScjvzJZtBOdauHdh8iuR6RZc9uVOlAAAJxEADasqAAAAAgAAAAAAAAAAAAAAAQAAAAEAAAAADwb7DcD9mf5rBUnI78yWbQTnWrh3YfIrkekWXPblTpQAAAAGAAAAAVNFQwAAAAAAm6XFaVsf8OSuS9C9gMplyTjagE9jAnnqwxSDJ6fin6IAsaK8LsUAAAAAAAAAAAAB9uVOlAAAAECXmRsoXmRiJjUrtbkDZYRnzac5s1CVV4g2RlIgBIuQty21npz3A1VhUcSmAx+GmsyGxVFvIrcdstTawJlmy9kF","result_xdr":"AAAAAAAAJxAAAAAAAAAAAQAAAAAAAAAGAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAA2rLAAAAAAAAAAADwb7DcD9mf5rBUnI78yWbQTnWrh3YfIrkekWXPblTpQAAAAAGtJNDAANqyoAAAABAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAA2rLAAAAAAAAAAADwb7DcD9mf5rBUnI78yWbQTnWrh3YfIrkekWXPblTpQAAAAAGtJNDAANqyoAAAACAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAAAwAAAAMADassAAAAAAAAAAAPBvsNwP2Z/msFScjvzJZtBOdauHdh8iuR6RZc9uVOlAAAAAAa0k0MAA2rKgAAAAIAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEADassAAAAAAAAAAAPBvsNwP2Z/msFScjvzJZtBOdauHdh8iuR6RZc9uVOlAAAAAAa0k0MAA2rKgAAAAIAAAABAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAADassAAAAAQAAAAAPBvsNwP2Z/msFScjvzJZtBOdauHdh8iuR6RZc9uVOlAAAAAFTRUMAAAAAAJulxWlbH/DkrkvQvYDKZck42oBPYwJ56sMUgyen4p+iAAAAAAAAAAAAsaK8LsUAAAAAAAEAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMADasrAAAAAAAAAAAPBvsNwP2Z/msFScjvzJZtBOdauHdh8iuR6RZc9uVOlAAAAAAa0nQcAA2rKgAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEADassAAAAAAAAAAAPBvsNwP2Z/msFScjvzJZtBOdauHdh8iuR6RZc9uVOlAAAAAAa0k0MAA2rKgAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"none","signatures":["l5kbKF5kYiY1K7W5A2WEZ82nObNQlVeINkZSIASLkLcttZ6c9wNVYVHEpgMfhprMhsVRbyK3HbLU2sCZZsvZBQ=="]}]}}}}}}}},"method":"get","path":"/liquidity_pools/{liquidity_pool_id}/transactions","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve Related Transactions","description":{"content":"This endpoint represents successful transactions referencing a given liquidity pool and can be used in streaming mode. Streaming mode allows you to listen for new transactions referencing this liquidity pool as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known transaction unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream transactions created since your request time.","type":"text/plain"},"url":{"path":["liquidity_pools",":liquidity_pool_id","transactions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Set to true to include failed operations in results. Options include true and false.","type":"text/plain"},"key":"include_failed","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) A unique identifier for this liquidity pool.","type":"text/plain"},"type":"any","value":"","key":"liquidity_pool_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Liquidity Pools"],"description":"This endpoint represents successful transactions referencing a given liquidity pool and can be used in streaming mode. Streaming mode allows you to listen for new transactions referencing this liquidity pool as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known transaction unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream transactions created since your request time.","operationId":"LPRetrieveRelatedTransactions","parameters":[{"name":"liquidity_pool_id","in":"path","required":true,"description":"A unique identifier for this liquidity pool."},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}},{"name":"include_failed","in":"query","required":false,"description":"Set to true to include failed operations in results. Options include true and false.","schema":{"type":"boolean","enum":[true,false]}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"memo":{"type":"string"},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"account":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"ledger":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"operations":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"effects":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"transaction":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","account","ledger","operations","effects","precedes","succeeds","transaction"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"successful":{"type":"boolean"},"hash":{"type":"string"},"ledger":{"type":"integer","format":"int32"},"created_at":{"type":"string"},"source_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"account_muxed":{"type":"string"},"account_muxed_id":{"type":"string"},"source_account_sequence":{"type":"string"},"fee_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"fee_account_muxed":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"fee_account_muxed_id":{"type":"string"},"fee_charged":{"type":"string"},"max_fee":{"type":"string"},"operation_count":{"type":"integer","format":"int32"},"envelope_xdr":{"type":"string"},"result_xdr":{"type":"string"},"result_meta_xdr":{"type":"string"},"fee_meta_xdr":{"type":"string"},"memo_type":{"type":"string"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"},"valid_after":{"type":"string"},"valid_before":{"type":"string"},"preconditions":{"type":"object","properties":{"timebounds":{"type":"object","properties":{"min_time":{"type":"string"},"max_time":{"type":"string"}},"title":"TransactionPreconditionsTimebounds"},"ledgerbounds":{"type":"object","properties":{"min_ledger":{"type":"string"},"max_ledger":{"type":"string"}},"title":"TransactionPreconditionsLedgerbounds"},"min_account_sequence":{"type":"string"},"min_account_sequence_age":{"type":"string"},"min_account_sequence_ledger_gap":{"type":"integer","format":"uint32"},"extra_signers":{"type":"array","items":{"type":"string"}}},"title":"TransactionPreconditions"},"fee_bump_transaction":{"type":"object","properties":{"hash":{"type":"string","title":"hash"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"}},"title":"FeeBumpTransaction"},"inner_transaction":{"type":"object","properties":{"hash":{"type":"string","title":"hash"},"signatures":{"type":"array","items":{"type":"string","pattern":"G[A-Z0-9]{55}"},"title":"signatures"},"max_fee":{"type":"string"}},"title":"InnerTransaction"}},"required":["id","paging_token","successful","hash","ledger","created_at","source_account","source_account_sequence","fee_account","fee_charged","max_fee","operation_count","envelope_xdr","result_xdr","result_meta_xdr","memo_type","signatures"]}}}}},"title":"Transaction"}]},"examples":{"LPRetrieveRelatedTransactions":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/liquidity_pools/3b476aff8a406a6ec3b61d5c038009cef85f2ddfaf616822dc4fec92845149b4/transactions?cursor=&limit=2&order=asc"},"next":{"href":"https://horizon.stellar.org/liquidity_pools/3b476aff8a406a6ec3b61d5c038009cef85f2ddfaf616822dc4fec92845149b4/transactions?cursor=120192370561220608&limit=2&order=asc"},"prev":{"href":"https://horizon.stellar.org/liquidity_pools/3b476aff8a406a6ec3b61d5c038009cef85f2ddfaf616822dc4fec92845149b4/transactions?cursor=120192344791343104&limit=2&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/transactions/2ff47e1bafe68639276b2a8df0a73597ee0c062fbcc72d121af314fe7851c908"},"account":{"href":"https://horizon.stellar.org/accounts/GAHQN6YNYD6ZT7TLAVE4R36MSZWQJZ22XB3WD4RLSHURMXHW4VHJIDF7"},"ledger":{"href":"https://horizon.stellar.org/ledgers/895788"},"operations":{"href":"https://horizon.stellar.org/transactions/2ff47e1bafe68639276b2a8df0a73597ee0c062fbcc72d121af314fe7851c908/operations","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/2ff47e1bafe68639276b2a8df0a73597ee0c062fbcc72d121af314fe7851c908/effects","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=3847380164161536"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=3847380164161536"},"transaction":{"href":"https://horizon.stellar.org/transactions/2ff47e1bafe68639276b2a8df0a73597ee0c062fbcc72d121af314fe7851c908"}},"id":"2ff47e1bafe68639276b2a8df0a73597ee0c062fbcc72d121af314fe7851c908","paging_token":"3847380164161536","successful":true,"hash":"2ff47e1bafe68639276b2a8df0a73597ee0c062fbcc72d121af314fe7851c908","ledger":895788,"created_at":"2021-08-09T20:53:11Z","source_account":"GAHQN6YNYD6ZT7TLAVE4R36MSZWQJZ22XB3WD4RLSHURMXHW4VHJIDF7","source_account_sequence":"3847371574214658","fee_account":"GAHQN6YNYD6ZT7TLAVE4R36MSZWQJZ22XB3WD4RLSHURMXHW4VHJIDF7","fee_charged":"10000","max_fee":"10001","operation_count":1,"envelope_xdr":"AAAAAgAAAAAPBvsNwP2Z/msFScjvzJZtBOdauHdh8iuR6RZc9uVOlAAAJxEADasqAAAAAgAAAAAAAAAAAAAAAQAAAAEAAAAADwb7DcD9mf5rBUnI78yWbQTnWrh3YfIrkekWXPblTpQAAAAGAAAAAVNFQwAAAAAAm6XFaVsf8OSuS9C9gMplyTjagE9jAnnqwxSDJ6fin6IAsaK8LsUAAAAAAAAAAAAB9uVOlAAAAECXmRsoXmRiJjUrtbkDZYRnzac5s1CVV4g2RlIgBIuQty21npz3A1VhUcSmAx+GmsyGxVFvIrcdstTawJlmy9kF","result_xdr":"AAAAAAAAJxAAAAAAAAAAAQAAAAAAAAAGAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAA2rLAAAAAAAAAAADwb7DcD9mf5rBUnI78yWbQTnWrh3YfIrkekWXPblTpQAAAAAGtJNDAANqyoAAAABAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAA2rLAAAAAAAAAAADwb7DcD9mf5rBUnI78yWbQTnWrh3YfIrkekWXPblTpQAAAAAGtJNDAANqyoAAAACAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAAAwAAAAMADassAAAAAAAAAAAPBvsNwP2Z/msFScjvzJZtBOdauHdh8iuR6RZc9uVOlAAAAAAa0k0MAA2rKgAAAAIAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEADassAAAAAAAAAAAPBvsNwP2Z/msFScjvzJZtBOdauHdh8iuR6RZc9uVOlAAAAAAa0k0MAA2rKgAAAAIAAAABAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAADassAAAAAQAAAAAPBvsNwP2Z/msFScjvzJZtBOdauHdh8iuR6RZc9uVOlAAAAAFTRUMAAAAAAJulxWlbH/DkrkvQvYDKZck42oBPYwJ56sMUgyen4p+iAAAAAAAAAAAAsaK8LsUAAAAAAAEAAAAAAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMADasrAAAAAAAAAAAPBvsNwP2Z/msFScjvzJZtBOdauHdh8iuR6RZc9uVOlAAAAAAa0nQcAA2rKgAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEADassAAAAAAAAAAAPBvsNwP2Z/msFScjvzJZtBOdauHdh8iuR6RZc9uVOlAAAAAAa0k0MAA2rKgAAAAEAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"none","signatures":["l5kbKF5kYiY1K7W5A2WEZ82nObNQlVeINkZSIASLkLcttZ6c9wNVYVHEpgMfhprMhsVRbyK3HbLU2sCZZsvZBQ=="]}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/liquidity_pools/{liquidity_pool_id}/transactions","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve Related Transactions","description":{"content":"This endpoint represents successful transactions referencing a given liquidity pool and can be used in streaming mode. Streaming mode allows you to listen for new transactions referencing this liquidity pool as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known transaction unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream transactions created since your request time.","type":"text/plain"},"url":{"path":["liquidity_pools",":liquidity_pool_id","transactions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Set to true to include failed operations in results. Options include true and false.","type":"text/plain"},"key":"include_failed","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) A unique identifier for this liquidity pool.","type":"text/plain"},"type":"any","value":"","key":"liquidity_pool_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/retrieve-an-order-book.api.mdx b/api/horizon/resources/retrieve-an-order-book.api.mdx index b3f9cf6e8..6228b3dd8 100644 --- a/api/horizon/resources/retrieve-an-order-book.api.mdx +++ b/api/horizon/resources/retrieve-an-order-book.api.mdx @@ -5,7 +5,7 @@ description: "The order book endpoint provides an order book’s bids and asks a sidebar_label: "Retrieve an Order Book" hide_title: true hide_table_of_contents: true -api: {"tags":["Order Books"],"description":"The order book endpoint provides an order book’s bids and asks and can be used in streaming mode. When filtering for a specific order book, you must use use all six of these arguments: base_asset_type, base_asset_issuer, base_asset_code, counter_asset_type, counter_asset_issuer, and counter_asset_code. If the base or counter asset is XLM, you only need to indicate the asset type as native and do not need to designate the code or the issuer.","operationId":"RetrieveAnOrderBook","parameters":[{"name":"selling_asset_type","in":"path","required":true,"description":"The type for the selling asset. Either native, credit_alphanum4, or credit_alphanum12.","schema":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]}},{"name":"selling_asset_issuer","in":"query","required":false,"description":"The Stellar address of the selling asset’s issuer."},{"name":"selling_asset_code","in":"query","required":false,"description":"The code for the selling asset."},{"name":"buying_asset_type","in":"query","required":false,"description":"The type for the buying asset. Either native, credit_alphanum4, or credit_alphanum12.","schema":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]}},{"name":"buying_asset_issuer","in":"query","required":false,"description":"The Stellar address of the buying asset’s issuer."},{"name":"buying_asset_code","in":"query","required":false,"description":"The code for the buying asset."},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"bids":{"type":"array","items":{"type":"object","properties":{"price_r":{"type":"object","properties":{"n":{"type":"integer"},"d":{"type":"integer"}}},"price":{"type":"string"},"amount":{"type":"string"}}}},"asks":{"type":"array","items":{"type":"object","properties":{"price_r":{"type":"object","properties":{"n":{"type":"integer"},"d":{"type":"integer"}}},"price":{"type":"string"},"amount":{"type":"string"}}}},"base":{"type":"object","properties":{"asset_type":{"type":"string"}}},"counter":{"type":"object","properties":{"asset_type":{"type":"string"},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}}}},"title":"OrderBook"},"examples":{"RetrieveAnOrderBook":{"value":{"bids":[{"price_r":{"n":10000000,"d":139999999},"price":"0.0714286","amount":"24.9999990"},{"price_r":{"n":1,"d":14},"price":"0.0714286","amount":"188.0000000"},{"price_r":{"n":1,"d":15},"price":"0.0666667","amount":"230.3200000"},{"price_r":{"n":1,"d":16},"price":"0.0625000","amount":"50.0000000"}],"asks":[{"price_r":{"n":5000000,"d":62500001},"price":"0.0800000","amount":"4.9400001"},{"price_r":{"n":10000000,"d":125000001},"price":"0.0800000","amount":"2516.5154327"},{"price_r":{"n":2,"d":25},"price":"0.0800000","amount":"3125.0000000"},{"price_r":{"n":4,"d":49},"price":"0.0816327","amount":"4593.7500000"}],"base":{"asset_type":"native"},"counter":{"asset_type":"credit_alphanum4","asset_code":"BB1","asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN"}}}}}}}},"method":"get","path":"/order_books{selling_asset_type}","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"}} +api: {"tags":["Order Books"],"description":"The order book endpoint provides an order book’s bids and asks and can be used in streaming mode. When filtering for a specific order book, you must use use all six of these arguments: base_asset_type, base_asset_issuer, base_asset_code, counter_asset_type, counter_asset_issuer, and counter_asset_code. If the base or counter asset is XLM, you only need to indicate the asset type as native and do not need to designate the code or the issuer.","operationId":"RetrieveAnOrderBook","parameters":[{"name":"selling_asset_type","in":"path","required":true,"description":"The type for the selling asset. Either native, credit_alphanum4, or credit_alphanum12.","schema":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]}},{"name":"selling_asset_issuer","in":"query","required":false,"description":"The Stellar address of the selling asset’s issuer."},{"name":"selling_asset_code","in":"query","required":false,"description":"The code for the selling asset."},{"name":"buying_asset_type","in":"query","required":false,"description":"The type for the buying asset. Either native, credit_alphanum4, or credit_alphanum12.","schema":{"type":"string","enum":["native","credit_alphanum4","credit_alphanum12"]}},{"name":"buying_asset_issuer","in":"query","required":false,"description":"The Stellar address of the buying asset’s issuer."},{"name":"buying_asset_code","in":"query","required":false,"description":"The code for the buying asset."},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"bids":{"type":"array","items":{"type":"object","properties":{"price_r":{"type":"object","properties":{"n":{"type":"integer"},"d":{"type":"integer"}}},"price":{"type":"string"},"amount":{"type":"string"}}}},"asks":{"type":"array","items":{"type":"object","properties":{"price_r":{"type":"object","properties":{"n":{"type":"integer"},"d":{"type":"integer"}}},"price":{"type":"string"},"amount":{"type":"string"}}}},"base":{"type":"object","properties":{"asset_type":{"type":"string"}}},"counter":{"type":"object","properties":{"asset_type":{"type":"string"},"asset_code":{"type":"string"},"asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"}}}},"title":"OrderBook"},"examples":{"RetrieveAnOrderBook":{"value":{"bids":[{"price_r":{"n":10000000,"d":139999999},"price":"0.0714286","amount":"24.9999990"},{"price_r":{"n":1,"d":14},"price":"0.0714286","amount":"188.0000000"},{"price_r":{"n":1,"d":15},"price":"0.0666667","amount":"230.3200000"},{"price_r":{"n":1,"d":16},"price":"0.0625000","amount":"50.0000000"}],"asks":[{"price_r":{"n":5000000,"d":62500001},"price":"0.0800000","amount":"4.9400001"},{"price_r":{"n":10000000,"d":125000001},"price":"0.0800000","amount":"2516.5154327"},{"price_r":{"n":2,"d":25},"price":"0.0800000","amount":"3125.0000000"},{"price_r":{"n":4,"d":49},"price":"0.0816327","amount":"4593.7500000"}],"base":{"asset_type":"native"},"counter":{"asset_type":"credit_alphanum4","asset_code":"BB1","asset_issuer":"GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN"}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/order_books{selling_asset_type}","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/retrieve-related-effects.api.mdx b/api/horizon/resources/retrieve-related-effects.api.mdx index c6f5c0b42..f0257f5cf 100644 --- a/api/horizon/resources/retrieve-related-effects.api.mdx +++ b/api/horizon/resources/retrieve-related-effects.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint represents effects referencing a given liquidity poo sidebar_label: "Retrieve Related Effects" hide_title: true hide_table_of_contents: true -api: {"tags":["Liquidity Pools"],"description":"This endpoint represents effects referencing a given liquidity pool and can be used in streaming mode. Streaming mode allows you to listen for new effects referencing this liquidity pool as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known effect unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream effects created since your request time.","operationId":"RetrieveRelatedEffects","parameters":[{"name":"liquidity_pool_id","in":"path","required":true,"description":"A unique identifier for this liquidity pool."},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"operation":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}},"id":{"type":"string","title":"id"},"paging_token":{"type":"string","title":"paging_token"},"account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","enum":["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":{"type":"number","example":1},"created_at":{"type":"string"}}}}},"required":["id","paging_token","account","type","type_i","created_at"]}},"title":"Effect"}]},"examples":{"RetrieveRelatedEffects":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/liquidity_pools/67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9/effects?cursor=&order=asc"},"next":{"href":"https://horizon.stellar.org/liquidity_pools/67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9/effects?cursor=120192370561220608&order=asc"},"prev":{"href":"https://horizon.stellar.org/liquidity_pools/67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9/effects?cursor=120192344791343104&order=desc"}},"_embedded":{"records":[{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/3849085266190337"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=3849085266190337-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=3849085266190337-1"}},"id":"0000000012884905986-0000000001","paging_token":"12884905986-2","account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"liquidity_pool_deposited","type_i":81,"created_at":"2021-11-18T03:15:54Z","liquidity_pool":{"id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9","fee_bp":30,"type":"constant_product","total_trustlines":"300","total_shares":"5000","reserves":[{"amount":"1000.0000005","asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"},{"amount":"2000.0000000","asset":"PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP"}]},"reserves_deposited":[{"asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","amount":"2378.0000005"},{"asset":"PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP","amount":"983.0000005"}],"shares_received":"1000"},{"id":"0000000012884905986-0000000002","paging_token":"12884905986-2","account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"liquidity_pool_withdrew","type_i":82,"created_at":"2021-11-18T03:15:54Z","liquidity_pool":{"id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9","fee_bp":30,"type":"constant_product","total_trustlines":"299","total_shares":"4000","reserves":[{"amount":"7.0000005","asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"},{"amount":"1.0000000","asset":"PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP"}]},"reserves_received":[{"asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","amount":"2478.0000005"},{"asset":"PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP","amount":"993.0000005"}],"shares_redeemed":"1000"},{"id":"0000000012884905986-0000000003","paging_token":"12884905986-2","account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"liquidity_pool_trade","type_i":83,"created_at":"2021-11-18T03:15:54Z","liquidity_pool":{"id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9","fee_bp":30,"type":"constant_product","total_trustlines":"300","total_shares":"5000","reserves":[{"amount":"1000.0000005","asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"},{"amount":"2000.0000000","asset":"PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP"}]},"sold":{"asset":"PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP","amount":"983.0000005"},"bought":{"asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","amount":"2378.0000005"}},{"id":"0000000012884905986-0000000004","paging_token":"12884905986-2","account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"liquidity_pool_created","type_i":84,"created_at":"2021-11-18T03:15:54Z","liquidity_pool":{"id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9","fee_bp":30,"type":"constant_product","total_trustlines":"1","total_shares":"0","reserves":[{"amount":"0","asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"},{"amount":"0","asset":"PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP"}]}},{"id":"0000000012884905986-0000000005","paging_token":"12884905986-2","account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"liquidity_pool_removed","type_i":85,"created_at":"2021-11-18T03:15:54Z","liquidity_pool_id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9"},{"id":"0000000012884905986-0000000006","paging_token":"12884905986-2","account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"liquidity_pool_revoked","type_i":86,"created_at":"2021-11-18T03:15:54Z","liquidity_pool":{"id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9","fee_bp":30,"type":"constant_product","total_trustlines":"299","total_shares":"4000","reserves":[{"amount":"7.0000005","asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"},{"amount":"1.0000000","asset":"PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP"}]},"reserves_revoked":[{"asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","amount":"2478.0000005","claimable_balance_id":"idcbd1234"},{"asset":"PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP","amount":"993.0000005","claimable_balance_id":"cbid1235"}],"shares_revoked":"1000"},{"id":"0000000012884905986-0000000007","paging_token":"157639717969326081-1","account":"GBBWI7TEVQBPEUXKYNGI3GBAH7EHFEREONKK3UK56ZSLJIDIYHQJCVSG","type":"trustline_created","type_i":20,"created_at":"2021-08-04T20:01:24Z","asset_type":"liquidity_pool_shares","liquidity_pool_id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9","limit":"1000"},{"id":"0000000012884905986-0000000008","paging_token":"157639717969326081-1","account":"GBBWI7TEVQBPEUXKYNGI3GBAH7EHFEREONKK3UK56ZSLJIDIYHQJCVSG","type":"trustline_updated","type_i":22,"created_at":"2021-08-04T20:01:24Z","asset_type":"liquidity_pool_shares","liquidity_pool_id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9","limit":"2000"},{"id":"0000000012884905986-0000000009","paging_token":"157639717969326081-1","account":"GBBWI7TEVQBPEUXKYNGI3GBAH7EHFEREONKK3UK56ZSLJIDIYHQJCVSG","type":"trustline_removed","type_i":21,"created_at":"2021-08-04T20:01:24Z","asset_type":"liquidity_pool_shares","liquidity_pool_id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9","limit":"0.0000000"}]}}}}}}}},"method":"get","path":"/liquidity_pools/{liquidity_pool_id}/effects","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve Related Effects","description":{"content":"This endpoint represents effects referencing a given liquidity pool and can be used in streaming mode. Streaming mode allows you to listen for new effects referencing this liquidity pool as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known effect unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream effects created since your request time.","type":"text/plain"},"url":{"path":["liquidity_pools",":liquidity_pool_id","effects"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) A unique identifier for this liquidity pool.","type":"text/plain"},"type":"any","value":"","key":"liquidity_pool_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Liquidity Pools"],"description":"This endpoint represents effects referencing a given liquidity pool and can be used in streaming mode. Streaming mode allows you to listen for new effects referencing this liquidity pool as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known effect unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream effects created since your request time.","operationId":"RetrieveRelatedEffects","parameters":[{"name":"liquidity_pool_id","in":"path","required":true,"description":"A unique identifier for this liquidity pool."},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"operation":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"succeeds":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"precedes":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}},"id":{"type":"string","title":"id"},"paging_token":{"type":"string","title":"paging_token"},"account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"type":{"type":"string","enum":["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":{"type":"number","example":1},"created_at":{"type":"string"}}}}},"required":["id","paging_token","account","type","type_i","created_at"]}},"title":"Effect"}]},"examples":{"RetrieveRelatedEffects":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/liquidity_pools/67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9/effects?cursor=&order=asc"},"next":{"href":"https://horizon.stellar.org/liquidity_pools/67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9/effects?cursor=120192370561220608&order=asc"},"prev":{"href":"https://horizon.stellar.org/liquidity_pools/67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9/effects?cursor=120192344791343104&order=desc"}},"_embedded":{"records":[{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/3849085266190337"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=3849085266190337-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=3849085266190337-1"}},"id":"0000000012884905986-0000000001","paging_token":"12884905986-2","account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"liquidity_pool_deposited","type_i":81,"created_at":"2021-11-18T03:15:54Z","liquidity_pool":{"id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9","fee_bp":30,"type":"constant_product","total_trustlines":"300","total_shares":"5000","reserves":[{"amount":"1000.0000005","asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"},{"amount":"2000.0000000","asset":"PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP"}]},"reserves_deposited":[{"asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","amount":"2378.0000005"},{"asset":"PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP","amount":"983.0000005"}],"shares_received":"1000"},{"id":"0000000012884905986-0000000002","paging_token":"12884905986-2","account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"liquidity_pool_withdrew","type_i":82,"created_at":"2021-11-18T03:15:54Z","liquidity_pool":{"id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9","fee_bp":30,"type":"constant_product","total_trustlines":"299","total_shares":"4000","reserves":[{"amount":"7.0000005","asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"},{"amount":"1.0000000","asset":"PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP"}]},"reserves_received":[{"asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","amount":"2478.0000005"},{"asset":"PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP","amount":"993.0000005"}],"shares_redeemed":"1000"},{"id":"0000000012884905986-0000000003","paging_token":"12884905986-2","account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"liquidity_pool_trade","type_i":83,"created_at":"2021-11-18T03:15:54Z","liquidity_pool":{"id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9","fee_bp":30,"type":"constant_product","total_trustlines":"300","total_shares":"5000","reserves":[{"amount":"1000.0000005","asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"},{"amount":"2000.0000000","asset":"PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP"}]},"sold":{"asset":"PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP","amount":"983.0000005"},"bought":{"asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","amount":"2378.0000005"}},{"id":"0000000012884905986-0000000004","paging_token":"12884905986-2","account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"liquidity_pool_created","type_i":84,"created_at":"2021-11-18T03:15:54Z","liquidity_pool":{"id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9","fee_bp":30,"type":"constant_product","total_trustlines":"1","total_shares":"0","reserves":[{"amount":"0","asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"},{"amount":"0","asset":"PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP"}]}},{"id":"0000000012884905986-0000000005","paging_token":"12884905986-2","account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"liquidity_pool_removed","type_i":85,"created_at":"2021-11-18T03:15:54Z","liquidity_pool_id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9"},{"id":"0000000012884905986-0000000006","paging_token":"12884905986-2","account":"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN7","type":"liquidity_pool_revoked","type_i":86,"created_at":"2021-11-18T03:15:54Z","liquidity_pool":{"id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9","fee_bp":30,"type":"constant_product","total_trustlines":"299","total_shares":"4000","reserves":[{"amount":"7.0000005","asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"},{"amount":"1.0000000","asset":"PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP"}]},"reserves_revoked":[{"asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S","amount":"2478.0000005","claimable_balance_id":"idcbd1234"},{"asset":"PHP:GBUQWP3BOUZX34TOND2QV7QQ7K7VJTG6VSE7WMLBTMDJLLAW7YKGU6EP","amount":"993.0000005","claimable_balance_id":"cbid1235"}],"shares_revoked":"1000"},{"id":"0000000012884905986-0000000007","paging_token":"157639717969326081-1","account":"GBBWI7TEVQBPEUXKYNGI3GBAH7EHFEREONKK3UK56ZSLJIDIYHQJCVSG","type":"trustline_created","type_i":20,"created_at":"2021-08-04T20:01:24Z","asset_type":"liquidity_pool_shares","liquidity_pool_id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9","limit":"1000"},{"id":"0000000012884905986-0000000008","paging_token":"157639717969326081-1","account":"GBBWI7TEVQBPEUXKYNGI3GBAH7EHFEREONKK3UK56ZSLJIDIYHQJCVSG","type":"trustline_updated","type_i":22,"created_at":"2021-08-04T20:01:24Z","asset_type":"liquidity_pool_shares","liquidity_pool_id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9","limit":"2000"},{"id":"0000000012884905986-0000000009","paging_token":"157639717969326081-1","account":"GBBWI7TEVQBPEUXKYNGI3GBAH7EHFEREONKK3UK56ZSLJIDIYHQJCVSG","type":"trustline_removed","type_i":21,"created_at":"2021-08-04T20:01:24Z","asset_type":"liquidity_pool_shares","liquidity_pool_id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9","limit":"0.0000000"}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/liquidity_pools/{liquidity_pool_id}/effects","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve Related Effects","description":{"content":"This endpoint represents effects referencing a given liquidity pool and can be used in streaming mode. Streaming mode allows you to listen for new effects referencing this liquidity pool as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known effect unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream effects created since your request time.","type":"text/plain"},"url":{"path":["liquidity_pools",":liquidity_pool_id","effects"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) A unique identifier for this liquidity pool.","type":"text/plain"},"type":"any","value":"","key":"liquidity_pool_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/api/horizon/resources/retrieve-related-trades.api.mdx b/api/horizon/resources/retrieve-related-trades.api.mdx index 963a980ba..1c818b19a 100644 --- a/api/horizon/resources/retrieve-related-trades.api.mdx +++ b/api/horizon/resources/retrieve-related-trades.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint represents successful trades fulfilled by the given sidebar_label: "Retrieve Related Trades" hide_title: true hide_table_of_contents: true -api: {"tags":["Liquidity Pools"],"description":"This endpoint represents successful trades fulfilled by the given liquidity pool and can be used in streaming mode. Streaming mode allows you to listen for new trades referencing this liquidity pool 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 trade created since your request time. ","operationId":"RetrieveRelatedTrades","parameters":[{"name":"liquidity_pool_id","in":"path","required":true,"description":"A unique identifier for this liquidity pool."},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"base":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"counter":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"operation":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","base","counter","operation"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string","title":"paging_token"},"ledger_close_time":{"type":"string"},"offer_id":{"type":"string"},"trade_type":{"type":"string"},"liquidity_pool_fee_bp":{"type":"number","format":"uint32"},"base_liquidity_pool_id":{"type":"string"},"base_offer_id":{"type":"string"},"base_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"base_amount":{"type":"string"},"base_asset_type":{"type":"string"},"base_asset_code":{"type":"string"},"base_asset_issuer":{"type":"string"},"counter_liquidity_pool_id":{"type":"string"},"counter_offer_id":{"type":"string"},"counter_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"counter_amount":{"type":"string"},"counter_asset_type":{"type":"string"},"counter_asset_code":{"type":"string"},"counter_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"base_is_seller":{"type":"boolean"},"price":{"required":["id","paging_token","ledger_close_time","trade_type","base_amount","base_asset_type","counter_amount","counter_asset_type","base_is_seller"],"type":"object","properties":{"n":{"type":"string"},"d":{"type":"string"}},"title":"tradePrice"}}}}}}},"title":"Trade"}]},"examples":{"RetrieveRelatedTrades":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/liquidity_pools/3b476aff8a406a6ec3b61d5c038009cef85f2ddfaf616822dc4fec92845149b4/trades?cursor=&limit=2&order=asc"},"next":{"href":"https://horizon.stellar.org/liquidity_pools/3b476aff8a406a6ec3b61d5c038009cef85f2ddfaf616822dc4fec92845149b4/trades?cursor=120192370561220608&limit=2&order=asc"},"prev":{"href":"https://horizon.stellar.org/liquidity_pools/3b476aff8a406a6ec3b61d5c038009cef85f2ddfaf616822dc4fec92845149b4/trades?cursor=120192344791343104&limit=2&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":""},"base":{"href":"https://horizon.stellar.org/accounts/GAVH5JM5OKXGMQDS7YPRJ4MQCPXJUGH26LYQPQJ4SOMOJ4SXY472ZM7G"},"counter":{"href":"https://horizon.stellar.org/accounts/GBB4JST32UWKOLGYYSCEYBHBCOFL2TGBHDVOMZP462ET4ZRD4ULA7S2L"},"operation":{"href":"https://horizon.stellar.org/operations/3697472920621057"}},"id":"3697472920621057-0","paging_token":"3697472920621057-0","ledger_close_time":"2015-11-18T03:47:47Z","offer_id":"9","base_offer_id":"9","base_account":"GAVH5JM5OKXGMQDS7YPRJ4MQCPXJUGH26LYQPQJ4SOMOJ4SXY472ZM7G","base_amount":"10.0000000","base_asset_type":"native","counter_liquidity_pool":"3b476aff8a406a6ec3b61d5c038009cef85f2ddfaf616822dc4fec92845149b4","liquidity_pool_fee_bp":"30","counter_amount":"2.6700000","counter_asset_type":"credit_alphanum4","counter_asset_code":"JPY","counter_asset_issuer":"GBVAOIACNSB7OVUXJYC5UE2D4YK2F7A24T7EE5YOMN4CE6GCHUTOUQXM","base_is_seller":true,"price":{"n":"267","d":"1000"},"trade_type":"liquidity_pool"}]}}}}}}}},"method":"get","path":"/liquidity_pools/{liquidity_pool_id}/trades","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve Related Trades","description":{"content":"This endpoint represents successful trades fulfilled by the given liquidity pool and can be used in streaming mode. Streaming mode allows you to listen for new trades referencing this liquidity pool 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 trade created since your request time. ","type":"text/plain"},"url":{"path":["liquidity_pools",":liquidity_pool_id","trades"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) A unique identifier for this liquidity pool.","type":"text/plain"},"type":"any","value":"","key":"liquidity_pool_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"tags":["Liquidity Pools"],"description":"This endpoint represents successful trades fulfilled by the given liquidity pool and can be used in streaming mode. Streaming mode allows you to listen for new trades referencing this liquidity pool 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 trade created since your request time. ","operationId":"RetrieveRelatedTrades","parameters":[{"name":"liquidity_pool_id","in":"path","required":true,"description":"A unique identifier for this liquidity pool."},{"name":"cursor","in":"query","required":false,"description":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","schema":{"type":"integer","example":6606617478959105}},{"name":"order","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"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.","schema":{"type":"integer","example":10}}],"x-supports-streaming":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"next":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"prev":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}}}},"title":"Links"},{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"base":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"counter":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"},"operation":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","base","counter","operation"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string","title":"paging_token"},"ledger_close_time":{"type":"string"},"offer_id":{"type":"string"},"trade_type":{"type":"string"},"liquidity_pool_fee_bp":{"type":"number","format":"uint32"},"base_liquidity_pool_id":{"type":"string"},"base_offer_id":{"type":"string"},"base_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"base_amount":{"type":"string"},"base_asset_type":{"type":"string"},"base_asset_code":{"type":"string"},"base_asset_issuer":{"type":"string"},"counter_liquidity_pool_id":{"type":"string"},"counter_offer_id":{"type":"string"},"counter_account":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"counter_amount":{"type":"string"},"counter_asset_type":{"type":"string"},"counter_asset_code":{"type":"string"},"counter_asset_issuer":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"base_is_seller":{"type":"boolean"},"price":{"required":["id","paging_token","ledger_close_time","trade_type","base_amount","base_asset_type","counter_amount","counter_asset_type","base_is_seller"],"type":"object","properties":{"n":{"type":"string"},"d":{"type":"string"}},"title":"tradePrice"}}}}}}},"title":"Trade"}]},"examples":{"RetrieveRelatedTrades":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/liquidity_pools/3b476aff8a406a6ec3b61d5c038009cef85f2ddfaf616822dc4fec92845149b4/trades?cursor=&limit=2&order=asc"},"next":{"href":"https://horizon.stellar.org/liquidity_pools/3b476aff8a406a6ec3b61d5c038009cef85f2ddfaf616822dc4fec92845149b4/trades?cursor=120192370561220608&limit=2&order=asc"},"prev":{"href":"https://horizon.stellar.org/liquidity_pools/3b476aff8a406a6ec3b61d5c038009cef85f2ddfaf616822dc4fec92845149b4/trades?cursor=120192344791343104&limit=2&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":""},"base":{"href":"https://horizon.stellar.org/accounts/GAVH5JM5OKXGMQDS7YPRJ4MQCPXJUGH26LYQPQJ4SOMOJ4SXY472ZM7G"},"counter":{"href":"https://horizon.stellar.org/accounts/GBB4JST32UWKOLGYYSCEYBHBCOFL2TGBHDVOMZP462ET4ZRD4ULA7S2L"},"operation":{"href":"https://horizon.stellar.org/operations/3697472920621057"}},"id":"3697472920621057-0","paging_token":"3697472920621057-0","ledger_close_time":"2015-11-18T03:47:47Z","offer_id":"9","base_offer_id":"9","base_account":"GAVH5JM5OKXGMQDS7YPRJ4MQCPXJUGH26LYQPQJ4SOMOJ4SXY472ZM7G","base_amount":"10.0000000","base_asset_type":"native","counter_liquidity_pool":"3b476aff8a406a6ec3b61d5c038009cef85f2ddfaf616822dc4fec92845149b4","liquidity_pool_fee_bp":"30","counter_amount":"2.6700000","counter_asset_type":"credit_alphanum4","counter_asset_code":"JPY","counter_asset_issuer":"GBVAOIACNSB7OVUXJYC5UE2D4YK2F7A24T7EE5YOMN4CE6GCHUTOUQXM","base_is_seller":true,"price":{"n":"267","d":"1000"},"trade_type":"liquidity_pool"}]}}}}}}}},"extensions":[{"key":"x-supports-streaming","value":true}],"method":"get","path":"/liquidity_pools/{liquidity_pool_id}/trades","servers":[{"url":"https://horizon.stellar.org","description":"The main network"},{"url":"https://horizon-testnet.stellar.org","description":"The test network"}],"info":{"title":"Horizon","version":"0.0.1"},"postman":{"name":"Retrieve Related Trades","description":{"content":"This endpoint represents successful trades fulfilled by the given liquidity pool and can be used in streaming mode. Streaming mode allows you to listen for new trades referencing this liquidity pool 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 trade created since your request time. ","type":"text/plain"},"url":{"path":["liquidity_pools",":liquidity_pool_id","trades"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A number that points to a specific location in a collection of responses and is pulled from the paging_token value of a record.","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"order","value":""},{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"limit","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) A unique identifier for this liquidity pool.","type":"text/plain"},"type":"any","value":"","key":"liquidity_pool_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/horizon/resources/horizon custom_edit_url: null diff --git a/docs/anchoring-assets/anchor-platform/getting_started.mdx b/docs/anchoring-assets/anchor-platform/getting_started.mdx index a6b799ff0..b491eb0a4 100644 --- a/docs/anchoring-assets/anchor-platform/getting_started.mdx +++ b/docs/anchoring-assets/anchor-platform/getting_started.mdx @@ -12,7 +12,7 @@ The easiest way to install the Anchor Platform is to pull the [docker image][anc ```bash -docker pull stellar/anchor-platform:[platform_version] +docker pull stellar/anchor-platform:latest ``` @@ -27,10 +27,9 @@ Let's create a minimal compose file to get started. ```yaml # docker-compose.yml -version: "3.8" services: sep-server: - image: stellar/anchor-platform:[platform_version] + image: stellar/anchor-platform:latest command: --sep-server ports: - "8080:8080" @@ -39,7 +38,7 @@ services: volumes: - ./config:/home platform-server: - image: stellar/anchor-platform:[platform_version] + image: stellar/anchor-platform:latest command: --platform-server ports: - "8085:8085" @@ -210,7 +209,7 @@ A database is only needed if using the Anchor Platform to facilitate transaction version: "3.8" services: sep-server: - image: stellar/anchor-platform:[platform_version] + image: stellar/anchor-platform:latest command: --sep-server env_file: - ./dev.env @@ -221,7 +220,7 @@ services: depends_on: - db platform-server: - image: stellar/anchor-platform:[platform_version] + image: stellar/anchor-platform:latest command: --platform-server env_file: - ./dev.env diff --git a/docs/anchoring-assets/anchor-platform/index.mdx b/docs/anchoring-assets/anchor-platform/index.mdx index 71022b375..026f7e37f 100644 --- a/docs/anchoring-assets/anchor-platform/index.mdx +++ b/docs/anchoring-assets/anchor-platform/index.mdx @@ -15,7 +15,7 @@ Below is a list of SEPs currently supported: - [SEP-10][sep-10]: [Stellar Authentication][sep10-ap] - [SEP-12][sep-12]: KYC API - [SEP-24][sep-24]: [Hosted Deposit and Withdrawal][sep24-ap] -- [SEP-31][sep-31]: Cross-Border Payments API +- [SEP-31][sep-31]: [Cross-Border Payments API][sep31-ap] - [SEP-38][sep-38]: Anchor RFQ API The documentation for the Anchor Platform is a work in progress. Developers are welcome to dive into the code and existing documentation on the [GitHub repository][anchor-platform-github], or if you're looking to build an on & off-ramp service compatible with SEP-24, see our [getting started guide][sep24-ap]. @@ -30,3 +30,4 @@ The documentation for the Anchor Platform is a work in progress. Developers are [sep1-ap]: /docs/category/stellar-info-file [sep10-ap]: /docs/category/stellar-authentication [sep24-ap]: /docs/category/hosted-deposits-and-withdrawals +[sep31-ap]: /docs/category/cross-border-payments diff --git a/docs/anchoring-assets/anchor-platform/sep24/example.mdx b/docs/anchoring-assets/anchor-platform/sep24/example.mdx index dba1fbbf4..289d648e8 100644 --- a/docs/anchoring-assets/anchor-platform/sep24/example.mdx +++ b/docs/anchoring-assets/anchor-platform/sep24/example.mdx @@ -342,7 +342,7 @@ First, let's configure the Anchor Platform to observe the Stellar network for in # docker-compose.yml --- stellar-observer: - image: stellar/anchor-platform:[platform_version] + image: stellar/anchor-platform:latest command: --stellar-observer env_file: - ./dev.env diff --git a/docs/anchoring-assets/anchor-platform/sep31/integration.mdx b/docs/anchoring-assets/anchor-platform/sep31/integration.mdx index b2aa2733e..4e055417c 100644 --- a/docs/anchoring-assets/anchor-platform/sep31/integration.mdx +++ b/docs/anchoring-assets/anchor-platform/sep31/integration.mdx @@ -29,7 +29,7 @@ version: "3.8" services: sep-server: - image: stellar/anchor-platform:[platform_version] + image: stellar/anchor-platform:latest command: --sep-server env_file: - ./dev.env @@ -40,7 +40,7 @@ services: depends_on: - db platform-server: - image: stellar/anchor-platform:[platform_version] + image: stellar/anchor-platform:latest command: --platform-server env_file: - ./dev.env @@ -193,7 +193,7 @@ The Stellar Observer monitors the Stellar ledger for payments made to your accou services: ... observer: - image: stellar/anchor-platform:[platform_version] + image: stellar/anchor-platform:latest command: --stellar-observer env_file: - ./dev.env diff --git a/docs/building-apps/example-application-tutorial/_category_.json b/docs/building-apps/example-application-tutorial/_category_.json index 9a592308a..28343e9bd 100644 --- a/docs/building-apps/example-application-tutorial/_category_.json +++ b/docs/building-apps/example-application-tutorial/_category_.json @@ -1,6 +1,6 @@ { "position": 55, - "label": "Example Application Tutorial", + "label": "Build a Payment App with the JS SDK", "link": { "type": "generated-index" } diff --git a/docs/tutorials/moneygram-access-integration-guide.mdx b/docs/building-apps/moneygram-access-integration-guide.mdx similarity index 100% rename from docs/tutorials/moneygram-access-integration-guide.mdx rename to docs/building-apps/moneygram-access-integration-guide.mdx diff --git a/docs/building-apps/overview.mdx b/docs/building-apps/overview.mdx index 56a02d03f..cd2318e20 100644 --- a/docs/building-apps/overview.mdx +++ b/docs/building-apps/overview.mdx @@ -7,6 +7,8 @@ Stellar is an open-source distributed ledger that you can use as a backend to po Stellar has built-in logic for key storage, creating accounts, signing transactions, tracking balances, and queries to the Stellar database, and anyone can use the network to issue, store, transfer, and trade assets. +This documentation will walk you through how to build a wallet with the Wallet SDK (recommended) or an example payment application with the JS Stellar SDK (legacy). + ## Anchors Many Stellar assets connect to real-world currencies, and Stellar has open protocols for integrating deposits and withdrawals of these assets via the [anchor network](https://stellar.org/learn/anchor-basics). Because of this, a Stellar-based application can take advantage of real banking rails and connect to real money. diff --git a/docs/building-apps/wallet/_category_.json b/docs/building-apps/wallet/_category_.json index 4d4b03537..f32c8ebbe 100644 --- a/docs/building-apps/wallet/_category_.json +++ b/docs/building-apps/wallet/_category_.json @@ -1,6 +1,6 @@ { "position": 45, - "label": "Build a Wallet", + "label": "Build a Wallet with the Wallet SDK", "link": { "type": "generated-index" } diff --git a/docs/building-apps/wallet/sep10.mdx b/docs/building-apps/wallet/sep10.mdx index df6330d76..4c698ed78 100644 --- a/docs/building-apps/wallet/sep10.mdx +++ b/docs/building-apps/wallet/sep10.mdx @@ -62,11 +62,10 @@ suspend fun getAuthToken(): AuthToken { ``` ```typescript -let authKey = Keypair.fromSecret("my secret key"); +const authKey = SigningKeypair.fromSecret("my secret key"); +const sep10 = await anchor.sep10(); -const getAuthToken = async (): Promise => { - return anchor.sep10().authenticate({ authKey }); -}; +const authToken = await sep10.authenticate({ accountKp: authKey }); ``` ```dart diff --git a/docs/building-apps/wallet/stellar.mdx b/docs/building-apps/wallet/stellar.mdx index adbecfab4..5458239fc 100644 --- a/docs/building-apps/wallet/stellar.mdx +++ b/docs/building-apps/wallet/stellar.mdx @@ -8,7 +8,7 @@ import { WalletCodeExample as CodeExample } from "@site/src/components/WalletCod import Header from "./component/header.mdx"; import CreateKeyPairInfo from "./component/ts/createKeypairInfo.mdx"; -
    +
    In the previous section we learned how to create a wallet and a `Stellar` object that provides a connection to Horizon. In this section, we will look at the usages of this class. @@ -67,7 +67,6 @@ suspend fun createAccount(): Transaction { ```typescript const txBuilder = await stellar.transaction({ sourceAddress: sourceAccountKeyPair, - baseFee: 100, }); const tx = txBuilder.createAccount(destinationAccountKeyPair).build(); ``` @@ -86,6 +85,14 @@ suspend fun lockMasterKey(): Transaction { } ``` +```typescript +const txBuilder = await stellar.transaction({ + sourceAddress: sourceAccountKeyPair, +}); + +const tx = txBuilder.lockAccountMasterKey().build(); +``` + Add a new signer to the account. Use caution when adding new signers and make sure you set the correct signer weight. Otherwise, you will lock the account irreversibly. @@ -100,6 +107,12 @@ suspend fun addSigner(): Transaction { } ``` +```typescript +const newSignerKeyPair = account.createKeypair(); + +const tx = txBuilder.addAccountSigner(newSignerKeyPair, 10).build(); +``` + Remove a signer from the account. @@ -112,6 +125,10 @@ suspend fun removeSigner(): Transaction { } ``` +```typescript +const tx = txBuilder.removeAccountSigner(newSignerKeyPair).build(); +``` + Modify account thresholds (useful when multiple signers are assigned to the account). This allows you to restrict access to certain operations when the limit is not reached. @@ -124,6 +141,10 @@ suspend fun setThreshold(): Transaction { } ``` +```typescript +const tx = txBuilder.setThreshold({ low: 1, medium: 10, high: 30 }).build(); +``` + #### Modify Assets (Trustlines) @@ -179,6 +200,12 @@ val externalKeyPair = "MySponsorAddress".toPublicKeyPair() val newKeyPair = account.createKeyPair() ``` +```typescript +// Third-party key that will sponsor creating new account +const externalKeyPair = new PublicKeypair.fromPublicKey("GC5GD..."); +const newKeyPair = account.createKeypair(); +``` + First, the account must be created. @@ -191,6 +218,10 @@ suspend fun makeCreateTx(): Transaction { } ``` +```typescript +const createTxn = txBuilder.createAccount(newKeyPair).build(); +``` + This transaction must be sent to external signer (holder of `externalKeyPair`) to be signed. @@ -200,12 +231,23 @@ This transaction must be sent to external signer (holder of `externalKeyPair`) t ```kt suspend fun remoteSignTransaction(transaction: Transaction) { val xdrString = transaction.toEnvelopeXdrBase64() - // Send xdr encoded transaction to your backend server - val signedTransaction = sendTransactionToBackend(xdrString) - val decodedTransaction = stellar.decodeTransaction(xdrString) + // Send xdr encoded transaction to your backend server to sign + val xdrStringFromBackend = sendTransactionToBackend(xdrString) + + // Decode xdr to get the signed transaction + val signedTransaction = stellar.decodeTransaction(xdrStringFromBackend) } ``` +```typescript +const xdrString = createTxn.toXDR(); +// Send xdr encoded transaction to your backend server to sign +const xdrStringFromBackend = await sendTransactionToBackend(xdrString); + +// Decode xdr to get the signed transaction +const signedTransaction = stellar.decodeTransaction(xdrStringFromBackend); +``` + :::note @@ -225,6 +267,10 @@ suspend fun submitCreateTx(signedCreateTx: Transaction) { ``` +```typescript +await wallet.stellar().submitTransaction(signedTransaction); +``` + Now, after the account is created, it can perform operations. For example, we can disable the master keypair and replace it with a new one (let's call it the device keypair) atomically in one transaction: @@ -250,13 +296,26 @@ suspend fun addDeviceKeyPair() { } ``` +```typescript +const deviceKeyPair = account.createKeypair(); + +const txBuilder = await stellar.transaction({ sourceAddress: newKeyPair }); +const modifyAccountTransaction = txBuilder + .addAccountSigner(deviceKeyPair, 1) + .lockAccountMasterKey() + .build(); +newKeyPair.sign(modifyAccountTransaction); + +await wallet.stellar().submitTransaction(modifyAccountTransaction); +``` + ### Sponsoring Transactions #### Sponsor Operations -Some operations, that modify account reserves can be [sponsored](https://developers.stellar.org/docs/encyclopedia/sponsored-reserves#sponsored-reserves-operations). For sponsored operations, the sponsoring account will be paying for the reserves instead of the account that being sponsored. This allows you to do some operations, even if account doesn't have enough funds to perform such operations. To sponsor a transaction, simply start a `sponsoring` block: +Some operations, that modify account reserves can be [sponsored](https://developers.stellar.org/docs/encyclopedia/sponsored-reserves#sponsored-reserves-operations). For sponsored operations, the sponsoring account will be paying for the reserves instead of the account that being sponsored. This allows you to do some operations, even if account doesn't have enough funds to perform such operations. To sponsor a transaction, simply start a sponsoring block:} ts={simply create a building function (describing which operations are to be sponsored) and pass it to the sponsoring method:}/> @@ -272,11 +331,25 @@ suspend fun sponsorOperation() { } ``` +```typescript +const txBuilder = await stellar.transaction({ + sourceAddress: sponsoredKeyPair, +}); + +const buildingFunction = (bldr) => bldr.addAssetSupport(asset); +const transaction = txBuilder + .sponsoring(sponsorKeyPair, buildingFunction) + .build(); + +sponsoredKeyPair.sign(transaction); +sponsorKeyPair.sign(transaction); +``` + :::info -Only some operations can be sponsored, and a sponsoring block has a slightly different set of functions available compared to the regular `TransactionBuilder`. Note, that a transaction must be signed by both the sponsor account (`sponsoringKeyPair`) and the account being sponsored (`sponsoredKeyPair`). +Only some operations can be sponsored, and a sponsoring block} ts={builder} /> has a slightly different set of functions available compared to the regular `TransactionBuilder`. Note, that a transaction must be signed by both the sponsor account (`sponsoringKeyPair`) and the account being sponsored (`sponsoredKeyPair`). ::: @@ -300,15 +373,29 @@ suspend fun sponsorAccountCreation() { } ``` +```typescript +const txBuilder = await stellar.transaction({ sourceAddress: sponsorKeyPair }); + +const newKeyPair = account.createKeypair(); + +const buildingFunction = (bldr) => bldr.createAccount(newKeyPair); +const transaction = txBuilder + .sponsoring(sponsorKeyPair, buildingFunction, newKeyPair) + .build(); + +newKeyPair.sign(transaction); +sponsorKeyPair.sign(transaction); +``` + -Note how the transaction source account should be set to `sponsorKeyPair`. This time, we need to pass the sponsored account. In the example above, it was omitted and was defaulted to the transaction source account (`sponsoredKey`). +Note how in the first example the transaction source account is set to `sponsoredKeyPair`. Due to this, we did not need to pass a sponsored account value to the `sponsoring` block} ts={method} />. Since when ommitted, the sponsored account defaults to the transaction source account (`sponsoredKeyPair`). -However, this time, the sponsored account (freshly created) is different from the transaction source account. Therefore, it's necessary to specify it. Otherwise, the transaction will contain a malformed operation. As before, the transaction must be signed by both keys. +However, this time, the sponsored account (freshly created `newKeyPair`) is different from the transaction source account. Therefore, it's necessary to specify it. Otherwise, the transaction will contain a malformed operation. As before, the transaction must be signed by both keys. #### Sponsoring Account Creation and Modification -If you want to create an account and modify it in one transaction, it's possible to do so with passing a `sponsoredAccount` optional argument to the sponsored block. If this argument is present, all operations inside the sponsored block will be sourced by `sponsoredAccount`. (Except account creation, which is always sourced by the sponsor). +If you want to create an account and modify it in one transaction, it's possible to do so with passing a `sponsoredAccount` optional argument to the sponsored block} ts={sponsoring method} /> (`newKeyPair` below). If this argument is present, all operations inside the sponsored block will be sourced by this `sponsoredAccount`. (Except account creation, which is always sourced by the sponsor). @@ -322,6 +409,7 @@ suspend fun sponsorAccountCreationAndModification() { .transaction(sponsorKeyPair) .sponsoring(sponsorKeyPair, newKeyPair) { createAccount(newKeyPair) + // source account for below operations will be newKeyPair addAccountSigner(replaceWith, 1) lockAccountMasterKey() } @@ -331,11 +419,32 @@ suspend fun sponsorAccountCreationAndModification() { } ``` +```typescript +const txBuilder = await stellar.transaction({ sourceAddress: sponsorKeyPair }); + +const newKeyPair = account.createKeypair(); +const replaceWith = account.createKeypair(); + +const buildingFunction = (bldr) => + bldr + .createAccount(newKeyPair) + // source account for below operations will be newKeyPair + .addAccountSigner(replaceWith, 1) + .lockAccountMasterKey(); + +const transaction = txBuilder + .sponsoring(sponsorKeyPair, buildingFunction, newKeyPair) + .build(); + +newKeyPair.sign(transaction); +sponsorKeyPair.sign(transaction); +``` + ### Fee-Bump Transaction -If you wish to modify a newly created account with a 0 balance, it's also possible to do so via `FeeBump`. It can be combined with a sponsoring block to achieve the same result as in the example above. However, with `FeeBump` it's also possible to add more operations (that don't require sponsoring), such as a transfer. +If you wish to modify a newly created account with a 0 balance, it's also possible to do so via `FeeBump`. It can be combined with a sponsoring block} ts={method} /> to achieve the same result as in the example above. However, with `FeeBump` it's also possible to add more operations (that don't require sponsoring), such as a transfer. First, let's create a transaction that will replace the master key of an account with a new keypair. @@ -355,6 +464,20 @@ val transaction = ``` +```typescript +const txBuilder = await stellar.transaction({ + sourceAddress: sponsoredKeyPair, +}); + +const replaceWith = account.createKeypair(); + +const buildingFunction = (bldr) => + bldr.lockAccountMasterKey().addAccountSigner(replaceWith, 1); +const transaction = txBuilder + .sponsoring(sponsorKeyPair, buildingFunction) + .build(); +``` + Second, sign transaction with both keys. @@ -365,6 +488,11 @@ Second, sign transaction with both keys. transaction.sign(sponsoredKeyPair).sign(sponsorKeyPair) ``` +```typescript +sponsorKeyPair.sign(transaction); +sponsoredKeyPair.sign(transaction); +``` + Next, create a fee bump, targeting the transaction. @@ -376,6 +504,14 @@ val feeBump = stellar.makeFeeBump(sponsorKeyPair, transaction) feeBump.sign(sponsorKeyPair) ``` +```typescript +const feeBump = stellar.makeFeeBump({ + feeAddress: sponsorKeyPair, + transaction, +}); +sponsorKeyPair.sign(feeBump); +``` + Finally, submit a fee-bump transaction. Executing this transaction will be fully covered by the `sponsorKeyPair` and `sponsoredKeyPair` and may not even have any XLM funds on its account. @@ -386,6 +522,10 @@ Finally, submit a fee-bump transaction. Executing this transaction will be fully wallet.stellar().submitTransaction(feeBump) ``` +```typescript +await wallet.stellar().submitTransaction(feeBump); +``` + ### Using XDR to Send Transaction Data @@ -398,6 +538,10 @@ Note, that a wallet may not have a signing key for `sponsorKeyPair`. In that cas val sponsorKeyPair = "SponsorAddress".toPublicKeyPair() ``` +```typescript +const sponsorKeyPair = new PublicKeypair.fromPublicKey("GC5GD..."); +``` + Next, create an account in the same manner as before and sign it with `newKeyPair`. This time, convert the transaction to XDR: @@ -418,6 +562,17 @@ suspend fun sponsorAccountCreation(): String { ``` +```typescript +const txBuilder = await stellar.transaction({ sourceAddress: sponsorKeyPair }); + +const newKeyPair = account.createKeypair(); + +const transaction = txBuilder + .sponsoring(sponsorKeyPair, (bldr) => bldr.createAccount(newKeyPair)) + .build(); +const xdrString = newKeyPair.sign(transaction).toXDR(); +``` + It can now be sent to the server. On the server, sign it with a private key for the sponsor address: @@ -427,7 +582,7 @@ It can now be sent to the server. On the server, sign it with a private key for ```kt // On the server fun signTransaction(xdrString: String): String { - val sponsorPrivateKey = SigningKeyPair.fromSecret("MySecred") + val sponsorPrivateKey = SigningKeyPair.fromSecret("MySecret") val signedTransaction = stellar.decodeTransaction(xdrString).sign(sponsorPrivateKey) @@ -435,6 +590,17 @@ fun signTransaction(xdrString: String): String { } ``` +```typescript +// On the server +const sponsorPrivateKey = SigningKeyPair.fromSecret("SD3LH4..."); + +const signedTransaction = sponsorPrivateKey.sign( + stellar.decodeTransaction(xdrString), +); + +return signedTransaction.toXDR(); +``` + When the client receives the fully signed transaction, it can be decoded and sent to the Stellar network: @@ -450,6 +616,12 @@ suspend fun recoverSigned(xdrString: String) { ``` +```typescript +const signedTransaction = stellar.decodeTransaction(xdrString); + +await wallet.stellar().submitTransaction(signedTransaction); +``` + ## Submit Transaction @@ -500,7 +672,7 @@ const buildingFunction = (builder) => await stellar.submitWithFeeIncrease({ sourceAddress: kp, - timeout: 180, + timeout: 30, baseFeeIncrease: 100, buildingFunction, }); diff --git a/docs/encyclopedia/liquidity-on-stellar-sdex-liquidity-pools.mdx b/docs/encyclopedia/liquidity-on-stellar-sdex-liquidity-pools.mdx index 685c66b20..c1295201a 100644 --- a/docs/encyclopedia/liquidity-on-stellar-sdex-liquidity-pools.mdx +++ b/docs/encyclopedia/liquidity-on-stellar-sdex-liquidity-pools.mdx @@ -140,6 +140,7 @@ The following code sets up the accounts and defines some helper functions. These ```js const sdk = require("stellar-sdk"); +const BigNumber = require("bignumber.js"); let server = new sdk.Server("https://horizon-testnet.stellar.org"); @@ -148,7 +149,6 @@ function buildTx(source, signer, ...ops) { let tx = new sdk.TransactionBuilder(source, { fee: sdk.BASE_FEE, networkPassphrase: sdk.Networks.TESTNET, - withMuxing: true, }); ops.forEach((op) => tx.addOperation(op)); tx = tx.setTimeout(30).build(); @@ -172,39 +172,41 @@ const kps = [ "SCJWYFTBDMDPAABHVJZE3DRMBRTEH4AIC5YUM54QGW57NUBM2XX6433P", ].map((s) => sdk.Keypair.fromSecret(s)); -// kp1 issues the assets -const kp1 = kps[0]; +// kp0 issues the assets +const kp0 = kps[0]; const [A, B] = orderAssets( - ...[new sdk.Asset("A", kp1.publicKey()), new sdk.Asset("B", kp1.publicKey())], + ...[new sdk.Asset("A", kp0.publicKey()), new sdk.Asset("B", kp0.publicKey())], ); -/// Establishes trustlines and funds `recipientKp` for all `assets`. -function distributeAssets(issuerKp, recipientKp, ...assets) { +/// Establishes trustlines and funds `recipientKps` for all `assets`. +function distributeAssets(issuerKp, recipientKps, ...assets) { return server.loadAccount(issuerKp.publicKey()).then((issuer) => { - const ops = assets - .map((asset) => [ - sdk.Operation.changeTrust({ - source: recipientKp.publicKey(), - limit: "100000", - asset: asset, - }), - sdk.Operation.payment({ - source: issuerKp.publicKey(), - destination: recipientKp.publicKey(), - amount: "100000", - asset: asset, - }), - ]) - .flat(); + const ops = recipientKps + .map((recipientKp) => + assets.map((asset) => [ + sdk.Operation.changeTrust({ + source: recipientKp.publicKey(), + limit: "100000", + asset: asset, + }), + sdk.Operation.payment({ + source: issuerKp.publicKey(), + destination: recipientKp.publicKey(), + amount: "100000", + asset: asset, + }), + ]), + ) + .flat(2); let tx = buildTx(issuer, issuerKp, ...ops); - tx.sign(recipientKp); + tx.sign(...recipientKps); return server.submitTransaction(tx); }); } function preamble() { - return Promise.all([1, 2].map((i) => distributeAssets(kp1, kps[i], A, B))); + return distributeAssets(kp0, [kps[1], kps[2]], A, B); } ``` @@ -274,7 +276,7 @@ def preamble() -> None: -Here, we use `distributeAssets()` to establish trustlines and set up initial balances of two custom assets (`A` and `B`, issued by `kp1`) for two accounts (`kp2` and `kp3`). For someone to participate in the pool, they must establish trustlines to each of the asset issuers and to the pool share asset (explained below). +Here, we use `distributeAssets()` to establish trustlines and set up initial balances of two custom assets (`A` and `B`, issued by `kp0`) for two accounts (`kp2` and `kp3`). For someone to participate in the pool, they must establish trustlines to each of the asset issuers and to the pool share asset (explained below). Note the `orderAssets()` helper here. Operations related to liquidity pools refer to the asset pair arbitrarily as `A` and `B`; however, they must be “ordered” such that `A` < `B`. This ordering is defined by the protocol, but its details should not be relevant (if you’re curious, it’s essentially lexicographically ordered by asset type, code, then issuer). We can use the comparison methods built into the SDKs (like `Asset.compare`) to ensure we pass them in the right order and avoid errors. @@ -338,7 +340,7 @@ const poolId = sdk .toString("hex"); function addLiquidity(source, signer, poolId, maxReserveA, maxReserveB) { - const exactPrice = reserveA / reserveB; + const exactPrice = maxReserveA / maxReserveB; const minPrice = exactPrice - exactPrice * 0.1; const maxPrice = exactPrice + exactPrice * 0.1; @@ -399,18 +401,31 @@ If you own shares of a particular pool, you can withdraw reserves from it. The o ```js -function removeLiquidity(source, signer, poolId, minReserveA, minReserveB) { - return server.submitTransaction( - buildTx( - source, - signer, - sdk.Operation.liquidityPoolWithdraw({ - liquidityPoolId: poolId, - minAmountA: minReserveA, - minAmountB: minReserveB, - }), - ), - ); +function removeLiquidity(source, signer, poolId, sharesAmount) { + return server + .liquidityPools() + .liquidityPoolId(poolId) + .call() + .then((poolInfo) => { + let totalShares = poolInfo.total_shares; + let minReserveA = + (sharesAmount / totalShares) * poolInfo.reserves[0].amount * 0.95; + let minReserveB = + (sharesAmount / totalShares) * poolInfo.reserves[1].amount * 0.95; + + return server.submitTransaction( + buildTx( + source, + signer, + sdk.Operation.liquidityPoolWithdraw({ + liquidityPoolId: poolId, + amount: sharesAmount, + minAmountA: minReserveA.toFixed(7), + minAmountB: minReserveB.toFixed(7), + }), + ), + ); + }); } ``` @@ -459,21 +474,44 @@ Finally, we can combine these pieces together to simulate some participation in ```js function main() { return getAccounts() - .then((accounts) => - Promise.all( + .then((accounts) => { + return Promise.all( kps.map((kp, i) => { const acc = accounts[i]; const depositA = ((i + 1) * 1000).toString(); const depositB = ((i + 1) * 3000).toString(); // maintain a 1:3 ratio return establishPoolTrustline(acc, kp, poolShareAsset) - .then((_) => addLiquidity(acc, kp, poolId, depositA, depositB)) - .then((_) => getSpotPrice()); + .then(() => addLiquidity(acc, kp, poolId, depositA, depositB)) + .then(() => getSpotPrice()); }), - ), - ) - .then((_) => withdrawLiquidity(accounts[1], kps[1], "500", "2000")) - .then((_) => getSpotPrice()); + ).then(() => accounts); + }) + .then((accounts) => { + // kp1 takes all his/her shares out + return server + .accounts() + .accountId(kps[1].publicKey()) + .call() + .then(({ balances }) => { + let balance = 0; + balances.every((bal) => { + if ( + bal.asset_type === "liquidity_pool_shares" && + bal.liquidity_pool_id === poolId + ) { + balance = bal.balance; + return false; + } + return true; + }); + return balance; + }) + .then((balance) => + removeLiquidity(accounts[1], kps[1], poolId, balance), + ); + }) + .then(() => getSpotPrice()); } function getSpotPrice() { diff --git a/docs/fundamentals-and-concepts/stellar-data-structures/ledgers.mdx b/docs/fundamentals-and-concepts/stellar-data-structures/ledgers.mdx index 744415c92..dc237de00 100644 --- a/docs/fundamentals-and-concepts/stellar-data-structures/ledgers.mdx +++ b/docs/fundamentals-and-concepts/stellar-data-structures/ledgers.mdx @@ -5,6 +5,8 @@ sidebar_position: 10 A ledger represents the state of the Stellar network at a point in time. It is shared across all Core nodes in the network and contains the list of accounts and balances, orders on the distributed exchange, and any other persisting data. +Other blockchains refer to this concept as a "block", and the entire blockchain as "the ledger". + In every Stellar Consensus Protocol round, the network reaches consensus on which transaction set to apply to the last closed ledger, and when the new set is applied, a new “last closed ledger” is defined. Each ledger is cryptographically linked to the unique previous ledger, creating a historical chain that goes back to the genesis ledger. Data is stored on the ledger as ledger entries. Possible ledger entries include: diff --git a/docs/run-core-node/configuring.mdx b/docs/run-core-node/configuring.mdx index d6cafc9c8..b561d4119 100644 --- a/docs/run-core-node/configuring.mdx +++ b/docs/run-core-node/configuring.mdx @@ -219,7 +219,7 @@ Without those settings, your validator depends on other nodes on the network to ### Updating and Coordinating Your Quorum Set -When you join the ranks of node operators, it's also important to join the conversation. The best way to do that: get on the #validators channel on the [Stellar Keybase](https://keybase.io/team/stellar.public) and sign up for the [Stellar Validators Google Group](https://groups.google.com/forum/#!forum/stellar-validators); You can also join the #validators channel on our [Developer Discord](https://discord.gg/stellardev). That way, you can and coordinate changes with the rest of the network. +When you join the ranks of node operators, it's also important to join the conversation. The best way to do that: get on the #validators channel on the [Stellar Keybase](https://keybase.io/team/stellar.public) and sign up for the [Stellar Validators Google Group](https://groups.google.com/forum/#!forum/stellar-validators); You can also join the #validators channel on our [Developer Discord](https://discord.gg/stellardev). That way, you can coordinate changes with the rest of the network. When you need to make changes to your validator or to your quorum set — say you take a validator down for maintenance or add new validators to your node's quorum set — it's crucial to stage the changes to preserve quorum intersection and general good health of the network: diff --git a/docs/soroban.mdx b/docs/soroban.mdx new file mode 100644 index 000000000..e6dbe84e8 --- /dev/null +++ b/docs/soroban.mdx @@ -0,0 +1,6 @@ +--- +sidebar_position: 150 +title: Soroban Smart Contracts +--- + +This is documentation for the Stellar network. To access Soroban smart contract documentation, please visit the [Soroban docs](https://soroban.stellar.org/docs). diff --git a/docs/stellar-disbursement-platform/anchor-platform-integration-points.mdx b/docs/stellar-disbursement-platform/anchor-platform-integration-points.mdx new file mode 100644 index 000000000..06498641b --- /dev/null +++ b/docs/stellar-disbursement-platform/anchor-platform-integration-points.mdx @@ -0,0 +1,44 @@ +--- +title: Anchor Platform Integration Points +sidebar_position: 60 +--- + +As mentioned in the [Design and Architecture](/docs/stellar-disbursement-platform/design-and-architecture) guide, the Stellar Disbursement Platform consists of a few services deployed together, where the Anchor Platform is one of them. + +For that reason, there are some connection points between the two instances that need to be properly configured in order for the Stellar Disbursement Platform to work correctly. We will be covering these integration points in this guide. + +Please note that for the default deployment of the Stellar Disbursement Platform, that relies on default Helm values and default Wallets and Assets, no extra configuration is needed. This guide is for those who want to customize the deployment by changing the Wallets and Assets available in their SDP instance. + +## Role of the Anchor Platform in SDP + +The Wallet Registration flow kicks off within the recipient's wallet app. This app interacts with the [Anchor Platform] to initiate the [SEP-24] deposit process through the SDP (Stellar Disbursement Platform). The SDP collects the necessary recipient information to ultimately execute the payment to them. + +The Anchor Platform (AP) is used to handle the implementation of interoperability protocols such as [SEP-1], [SEP-10], and [SEP-24], making their endpoints available to wallet apps. The [Anchor Platform] is pre-configured in both [the repo]'s Helm chart, and in the Docker Compose file available in the `dev` directory. + +## Steps for Configuring SDP-AnchorPlatform Integration + +To ensure a seamless integration between the SDP and the [Anchor Platform], make sure to follow these steps: + +1. 🚨 **Critical Step**: Configure the Anchor Platform with `PLATFORM_SERVER_AUTH_TYPE: JWT`. This setting is crucial for securing your Anchor Platform's backoffice API via JWT token authentication. +1. **Shared Secrets for API Authentication**: The `SECRET_PLATFORM_API_AUTH_SECRET` in the Anchor Platform should match `ANCHOR_PLATFORM_OUTGOING_JWT_SECRET` in the SDP. +1. **Shared Secrets for SEP-24**: The secrets `SECRET_SEP24_INTERACTIVE_URL_JWT_SECRET` and `SECRET_SEP24_MORE_INFO_URL_JWT_SECRET` in the Anchor Platform need to align with `SEP24_JWT_SECRET` in the SDP. +1. **SEP-10 Configuration**: The `SECRET_SEP10_SIGNING_SEED` in the Anchor Platform should be consistent with both the `SEP10_SIGNING_PRIVATE_KEY` and `SEP10_SIGNING_PUBLIC_KEY` in the SDP. + +By following these steps, you'll ensure a secure and efficient integration between your SDP and Anchor Platform systems. + +## Manual Synchronization of Custom Assets and Wallets + +Currently, some configurations within the Anchor Platform are static and loaded via environment variables. On the other hand, the SDP reads these same configurations from its database and allows an owner user to modify them. This dynamic pertains particularly to the lists of supported assets and wallets. + +While we are actively exploring ways to automate this synchronization process, manual adjustments to the Anchor Platform configuration are necessary whenever an asset or wallet is added or removed on the SDP. + +1. **(Required) Update Supported Assets**: Whenever you change the list of supported assets in the SDP, it's essential to update the Anchor Platform's `ASSETS_VALUE` configuration to reflect these changes. Refer to [the repo]'s Helm values or Docker Compose file(s) for examples. +1. **(Optional, but Recommended) Wallets and SEP-10 Domains**: If you employ the `SEP10_CLIENT_ATTRIBUTION_REQUIRED: true` setting in the Anchor Platform - a recommended best practice - you must also update the `SEP10_CLIENT_ATTRIBUTION_ALLOW_LIST` to include trusted wallet domains. This ensures that the Anchor Platform will process SEP-10 requests only from trusted wallets. + +By adhering to these guidelines, you can ensure a consistent and secure configuration between your SDP and Anchor Platform instances. + +[sep-1]: https://stellar.org/protocol/sep-1 +[sep-10]: https://stellar.org/protocol/sep-10 +[sep-24]: https://stellar.org/protocol/sep-24 +[anchor platform]: https://github.com/stellar/java-stellar-anchor-sdk +[the repo]: https://github.com/stellar/stellar-disbursement-platform-backend diff --git a/docs/stellar-disbursement-platform/deploy-the-sdp.mdx b/docs/stellar-disbursement-platform/deploy-the-sdp.mdx new file mode 100644 index 000000000..f6e8e9917 --- /dev/null +++ b/docs/stellar-disbursement-platform/deploy-the-sdp.mdx @@ -0,0 +1,49 @@ +--- +title: Deploy the SDP +sidebar_position: 40 +--- + +In this guide, you will learn to deploy the SDP on a Kubernetes cluster using publicly available Helm charts. + +This option is recommended for persistent deployments of production or staging instances of the SDP. If you want to deploy the SDP on a local machine for development purposes, see [Run the SDP Locally](./getting-started.mdx#run-the-sdp-locally). + +Please note that configuring deployment details like ingress, TLS, resource limits, and so on are out of scope for this guide. This guide assumes that you have a Kubernetes cluster with a Postgres database deployed in the same cluster and that you have the necessary permissions to deploy the SDP. It also assumes that you have the operational knowledge to manage the cluster and the database. + +## Prerequisites + +- Kubernetes 1.19+ +- Helm 3.2.0+ +- Postgres 14.0+ + +## Installing the Chart + +### Add the Helm repository + +Before you can install the chart, you need to add the Stellar Helm repository. + +```bash +helm repo add stellar https://helm.stellar.org/charts +helm repo update +``` + +### Customize the values + +The SDP Helm chart has a number of configurable values. You can customize these values by creating a values file and passing it to the `helm install` command. + +We provided a sample values file that you can use as a starting point. This file has the minimum set of configurations required to deploy an SDP instance. You can download the file from the [SDP GitHub repository](https://github.com/stellar/stellar-disbursement-platform-backend/blob/develop/helmchart/sdp/minimal-values.yaml) or by running the following command: + +```bash +curl -O https://raw.githubusercontent.com/stellar/stellar-disbursement-platform-backend/develop/helmchart/sdp/minimal-values.yaml +``` + +You can find the full list of configurable values in the [SDP GitHub repository](https://github.com/stellar/stellar-disbursement-platform-backend/blob/develop/helmchart/sdp/README.md#stellar-disbursement-platform-sdp-parameters). + +### Install the chart + +To install the chart with the release name `sdp` and the values file `myvalues.yaml`: + +```bash +helm install sdp -f myvalues.yaml stellar/stellar-disbursement-platform +``` + +Now you should have a running SDP instance. To learn how to use the SDP, see [Create your first disbursement](./getting-started.mdx#create-your-first-disbursement). diff --git a/docs/stellar-disbursement-platform/getting-started.mdx b/docs/stellar-disbursement-platform/getting-started.mdx index b1acec03c..21a7b88b5 100644 --- a/docs/stellar-disbursement-platform/getting-started.mdx +++ b/docs/stellar-disbursement-platform/getting-started.mdx @@ -3,6 +3,8 @@ title: Getting Started sidebar_position: 30 --- +import { CodeExample } from "@site/src/components/CodeExample"; + In this guide, you will learn to: - create and fund a distribution account for making payments @@ -269,6 +271,8 @@ You can add and remove assets easily in the SDP dashboard. The SDP backend handl Head to the Wallets page of the SDP dashboard to add and remove assets. You'll need the Stellar asset code and the public key of the asset issuer. +> Note: please make sure to update the appropriate configuration on the Anchor Platform side, according with the [Anchor Platform Integration Points](/docs/stellar-disbursement-platform/anchor-platform-integration-points#manual-synchronization-of-custom-assets-and-wallets) guide. + ### Countries To customize wallets and countries, you’ll need to do some backend work. @@ -287,57 +291,7 @@ DELETE FROM countries WHERE code = 'FRA'; ### Wallets -Remember you’ll need an agreement with a wallet provider before sending disbursements into their wallet. This ensures the wallets are comfortable receiving funds from your organization and governs any commercial arrangement between the organizations. The wallet will need to whitelist your SDP domain before you send disbursements. When you add the wallet’s domain to your SDP, you are effectively whitelisting them. Both sides listing the other allows them to retrieve the Stellar toml file and check the signing key needed for the SEP-10 handshake. - -The default list of SDP wallets depends on which network you’re using (testnet or pubnet). The network is passed as an environment variable and then the list of wallets is seeded appropriately on SDP startup. You can add new wallets through the code when you deploy your SDP, or you can insert directly into the SDP database. Both methods require adding the wallet name, homepage, SEP-10 client domain, and deep link schema. - -To insert into the database directly, update your values and run the following. Make sure to check your database and namespace first. - - - -```sql -INSERT INTO wallets (name, homepage, deep_link_schema, sep_10_client_domain) -VALUES ('Vibrant Assist', 'https://vibrantapp.com', 'https://vibrantapp.com/sdp', 'api.vibrantapp.com'); -``` - - - -To configure a wallet through the code, add it to the testnet or pubnet section of `DefaultWalletsNetworkMap`. This will get picked up by the `SetupWalletsForProperNetwork` function, which updates the SDP database and makes the wallet available for new disbursements. You’ll see a default list in the code. Add your new wallet using the same format. - - - -```go -var DefaultWalletsNetworkMap = WalletsNetworkMapType{ - utils.PubnetNetworkType: { - { - Name: "Vibrant Assist", - Homepage: "https://vibrantapp.com/assist", - DeepLinkSchema: "https://vibrantapp.com/sdp", - SEP10ClientDomain: "api.vibrantapp.com", - }, - }, - utils.TestnetNetworkType: { - { - Name: "Vibrant Assist", - Homepage: "https://vibrantapp.com", - DeepLinkSchema: "https://vibrantapp.com/sdp-dev", - SEP10ClientDomain: "api-dev.vibrantapp.com", - }, - { - Name: "Demo Wallet", - Homepage: "https://demo-wallet.stellar.org", - DeepLinkSchema: "https://demo-wallet.stellar.org", - SEP10ClientDomain: "demo-wallet-server.stellar.org", - }, - }, -} -``` - - - -Once you’ve added the new wallet, make sure the wallet has whitelisted your SDP domain (the domain that appears in the deep link). - -Now you should be set with whichever countries and wallets you want available for new disbursements! +For a full overview on how to add wallets and how to make a wallet SDP-compatible, check out the [Making Your Wallet SDP-Ready](/docs/stellar-disbursement-platform/making-your-wallet-sdp-ready) guide. [demo-wallet]: https://demo-wallet.stellar.org [circle-sandbox]: https://login-sandbox.circle.com/ diff --git a/docs/stellar-disbursement-platform/making-your-wallet-sdp-ready.mdx b/docs/stellar-disbursement-platform/making-your-wallet-sdp-ready.mdx new file mode 100644 index 000000000..e8670a8ec --- /dev/null +++ b/docs/stellar-disbursement-platform/making-your-wallet-sdp-ready.mdx @@ -0,0 +1,171 @@ +--- +title: Making Your Wallet SDP-Ready +sidebar_position: 50 +--- + +import { CodeExample } from "@site/src/components/CodeExample"; + +Remember that any SDP instance will need an agreement with a wallet provider before sending disbursements into that wallet. This ensures the wallets are comfortable receiving funds from your organization and governs any commercial arrangement between the organizations. The wallet will need to allowlist the SDP domain before the SDP can send disbursements to that wallet. When the wallet domain is added to a SDP, it's effectively being allowlisted by the SDP. Both sides listing the other allows them to retrieve the stellar.toml file and check the signing key needed for the [SEP-10] handshake. + +In this page, we will cover the technical aspects of the SDP-Wallet integration, including how to add a Wallet in the SDP database, how to validate and support the registration links using mobile app's [deep linking], how to start the user registration flow in the wallet using [SEP-24], and a recommended approach for handling [deferred deep linking]. + +## Adding a Wallet to an SDP + +The default list of SDP wallets depends on which network is being used (testnet or pubnet). The network is passed as an environment variable and then the list of wallets can be seeded appropriately on SDP startup through the CLI command `./stellar-disbursement-platform db setup-for-network`, according with a hardcoded list of known wallets. Alternatively, wallets can be inserted directly into the SDP database through a SQL command. Both methods require adding the wallet name, homepage, SEP-10 client domain, and deep link schema. + +To insert it directly into the database, update your values and run the following Postgres query. Make sure to check your database and namespace first. + + + +```sql +INSERT INTO wallets (name, homepage, deep_link_schema, sep_10_client_domain) +VALUES ('Vibrant Assist', 'https://vibrantapp.com', 'https://vibrantapp.com/sdp', 'api.vibrantapp.com'); +``` + + + +To configure a wallet through the code, add it to the testnet or pubnet section of `DefaultWalletsNetworkMap`. This will be used when you execute the `./stellar-disbursement-platform db setup-for-network` CLI command, which updates the SDP database and makes the wallet available for new disbursements. Add your new wallet following the same format already present in the code. + + + +```go +var DefaultWalletsNetworkMap = WalletsNetworkMapType{ + utils.PubnetNetworkType: { + { + Name: "Vibrant Assist", + Homepage: "https://vibrantapp.com/assist", + DeepLinkSchema: "https://vibrantapp.com/sdp", + SEP10ClientDomain: "api.vibrantapp.com", + }, + }, + utils.TestnetNetworkType: { + { + Name: "Vibrant Assist", + Homepage: "https://vibrantapp.com", + DeepLinkSchema: "https://vibrantapp.com/sdp-dev", + SEP10ClientDomain: "api-dev.vibrantapp.com", + }, + { + Name: "Demo Wallet", + Homepage: "https://demo-wallet.stellar.org", + DeepLinkSchema: "https://demo-wallet.stellar.org", + SEP10ClientDomain: "demo-wallet-server.stellar.org", + }, + }, +} +``` + + + +> Note: please make sure to update the appropriate configuration on the Anchor Platform side, according with the [Anchor Platform Integration Points](/docs/stellar-disbursement-platform/anchor-platform-integration-points#manual-synchronization-of-custom-assets-and-wallets) guide. + +## Recipient Registration Experience + +The recipient registration experience is paramount to make this application smooth and easy to use. this requires the wallet to support [deferred deep linking], which will be discussed in a later section. A good description of the registration experience is as follows: + +1. The recipient receives an SMS message notifying them they have a payment waiting from the organization and prompts them to click a [deep link] to open or install&open a wallet application +1. When the recipient opens the wallet app, the wallet immediately onboards the recipient, creates a Stellar account and trustline for the desired asset, initiates a [SEP-24] deposit transaction with the SDP, and opens the SDP's registration webpage as an overlay screen/iframe inside the app. +1. The user confirms their phone number and date of birth directly with the SDP, without sharing any data with the wallet, and after the registration finishes, the user is sent back to the wallet application. Here are the screens demonstrating these steps: + + ![Registration Flow](/assets/SDP/SDP25.png) + +1. The user receives the payment within seconds + +## Registration Deep Link + +Once the user has installed the wallet application, the wallet should be able to interpret a [deep link] that follows the format registered in the SDP in order to kick off the [Wallet Registration Procedure](#wallet-registration-procedure). The deep link format supported by the SDP follows this format: + +```url +https://?asset=&domain=&name=&signature= +``` + +- `asset`: the Stellar asset +- `domain`: the domain hosting the SDP's `stellar.toml` file +- `name`: the name of the organization sending payments +- `signature`: a signature from the SDP's [SEP-10] signing key + +> Note that the deep link is specific to each SDP, payer org, and asset. It is not specific per individual receiver. There is no risk in sharing the link with receivers who are part of the same disbursement. The link will be the same for multiple receivers and they will prove their identity as part of the [SEP-24] deposit flow. + +Below is an example of a registration link (signed) + +```url +https://vibrantapp.com/sdp-dev?asset=USDC-GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5&domain=ap-stellar-disbursement-platform-backend-dev.stellar.org&name=Stellar+Test&signature=fea6c5e805a29b903835bea2f6c60069113effdf1c5cb448d4948573c65557b1d667bcd176c24a94ed9d54a1829317c74f39319076511512a3e697b4b746ae0a +``` + +In this example, the host is `https://vibrantapp.com/sdp-dev` and the signature is the result of signing the below (unsigned) url using the [SEP-10] signing key `SBUSPEKAZKLZSWHRSJ2HWDZUK6I3IVDUWA7JJZSGBLZ2WZIUJI7FPNB5`, with the public key being `GBFDUUZ5ZYC6RAPOQLM7IYXLFHYTMCYXBGM7NIC4EE2MWOSGIYCOSN5F`: + +```url +https://vibrantapp.com/sdp-dev?asset=USDC-GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5&domain=ap-stellar-disbursement-platform-backend-dev.stellar.org&name=Stellar+Test +``` + +In this example, the signature is `fea6c5e805a29b903835bea2f6c60069113effdf1c5cb448d4948573c65557b1d667bcd176c24a94ed9d54a1829317c74f39319076511512a3e697b4b746ae0a`. + +Below is a JavaScript snippet demonstrating how to verify the signature: + +```js +#!/usr/bin/env node + +const { Keypair } = require("stellar-sdk"); + +// The SDP's stellar.toml SIGNING_KEY +// +// For security, this should ideally be fetched from +// https:///.well-known/stellar.toml on demand +const keypair = Keypair.fromPublicKey( + "GBFDUUZ5ZYC6RAPOQLM7IYXLFHYTMCYXBGM7NIC4EE2MWOSGIYCOSN5F", +); +console.log("public key:", keypair.publicKey()); + +let url = + "https://vibrantapp.com/sdp-dev?asset=USDC-GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5&domain=ap-stellar-disbursement-platform-backend-dev.stellar.org&name=Stellar%20Test"; +let signature = + "fea6c5e805a29b903835bea2f6c60069113effdf1c5cb448d4948573c65557b1d667bcd176c24a94ed9d54a1829317c74f39319076511512a3e697b4b746ae0a"; + +console.log( + "verified:", + keypair.verify( + Buffer.from(url.toString(), "utf8"), + Buffer.from(signature, "hex"), + ), +); +``` + +### Wallet Registration Procedure + +When opening registration [deep link], these are the steps the wallet should follow in order to enforce the security and pricacy measures expected in this flow, and to allow the user to input their information dicectly with the SDP: + +1. 🚨 Confirm that the `domain` of the deep link is on the wallet's allowlist. This is crucial for authenticating from a trusted wallet.🚨 +1. Fetch the SDP's toml file at `{domain}/.well-known/stellar.toml` and confirm the `SIGNING_KEY` variable is populated. +1. Verify that the registration link signature was made using `SIGNING_KEY` similar to the `keypairPk.verify(...)` function in the snippet above, and that the signature is valid with the content of the link. +1. Check the `asset` from the link and confirm that the recipient user has a trustline for that asset. Create one if it doesn't exist. +1. (Optional) Use the `name` from the link to update the wallet user interface. +1. Initiate the [SEP-24] deposit flow with that asset using the `TRANSFER_SERVER_SEP0024` value from the SDP's toml file. + - This includes using [SEP-10] to authenticate the user with the SDP's server and implementing the `client_domain` check, as detailed in the [SEP-10] spec. +1. Launch the deposit flow interactive _in-app browser_ within your mobile app, following the instructions in the [SEP-24] spec. + - ATTENTION: the wallet should not, in any circumstances, scrape or attempt to scrape the content from the _in-app browser_ for the recipient's information. + - NOTE: it's highly recommended to use an _in-app browser_ rather than a webview. +1. 🎉 Congratulations! The recipient user can now fill out the forms in the _in-app browser_ and register to receive their payment 🎉. + +Additionally, the wallet should save the link and/or link attributes and associate it with the individual receiving user for these reasons: + +1. This is how the wallet will know that the user is associated with a certain org or SDP. +1. Saving the data is useful for reporting and troubleshooting, especially if the wallet needs to justify the source of funds for regulatory or tax purposes. +1. If the payer org wants to pay any cashout fees charged by the wallet or offramp, the wallet will need to know which users and transactions should be invoiced upstream. + +### Deferred Deep Links + +Most likely, the intended recipient will not have the necessary wallet application installed on their device. For this reason, wallets should support the concept of [deferred deep linking], which enables the following flow: + +1. The recipient's initial action of clicking the deep link should redirect them to the appropriate app store to download the wallet application. +1. After installing and opening the application, the recipient should be rerouted to the wallet's typical onboarding flow. +1. Once the user has successfully onboarded, the wallet should use the information included in the deep link to kick off the [Wallet Registration Procedure](#wallet-registration-procedure). + +Deferred deep linking is a feature commonly supported by numerous mobile deep linking solutions, there are third-party services that can be used to implement this functionality, such as Singular, Branch, AppsFlyer, Adjust, and others. [Here](https://medium.com/bumble-tech/universal-links-for-android-and-ios-1ddb1e70cab0) is a blog post with more information on how to implement [deferred deep linking]. + +The SDP supports a basic link format, such as `https://`. If your wallet's deep linking system needs a more complex structure, you'll have to manage this with a web application. This application should be owned by the wallet provider, and it should be able to receive the deep link, interpret it, and direct the user to the correct location. + +[deferred deep linking]: https://en.wikipedia.org/wiki/Mobile_deep_linking#Deferred_deep_linking +[deep link]: https://en.wikipedia.org/wiki/Mobile_deep_linking +[deep linking]: https://en.wikipedia.org/wiki/Mobile_deep_linking +[sep-10]: https://stellar.org/protocol/sep-10 +[sep-24]: https://stellar.org/protocol/sep-24 diff --git a/docs/tutorials/_category_.json b/docs/tutorials/_category_.json index e74dec28a..75d304675 100644 --- a/docs/tutorials/_category_.json +++ b/docs/tutorials/_category_.json @@ -1,6 +1,6 @@ { "position": 20, - "label": "Tutorials", + "label": "Basic Tutorials", "link": { "type": "generated-index" } diff --git a/docusaurus.config.js b/docusaurus.config.js index 17fad7ecc..f15fd2fb5 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -164,6 +164,11 @@ const config = { label: "GitHub", position: "right", }, + { + href: "https://discord.gg/stellardev", + label: "Discord", + position: "right", + }, { type: "search", position: "right", diff --git a/openapi/anchor-platform/Callbacks API.yml b/openapi/anchor-platform/Callbacks API.yml index 37bdd8315..1125ce85a 100644 --- a/openapi/anchor-platform/Callbacks API.yml +++ b/openapi/anchor-platform/Callbacks API.yml @@ -197,6 +197,7 @@ paths: tags: - Rates - SEP-31 + - SEP-38 summary: Retrieve Rates operationId: getRates parameters: @@ -466,3 +467,23 @@ paths: application/json: schema: $ref: './schemas.yml#/components/schemas/Error' + /event: + post: + tags: + - Events + - SEP-24 + - SEP-31 + summary: Receive an Event + operationId: postEvent + description: | + Receive a JSON object representing an event. + requestBody: + content: + application/json: + schema: + $ref: './schemas.yml#/components/schemas/Event' + responses: + '200': + description: The event is successfully processed and ready to receive next event. The response body is empty. + '400': + description: The event is invalid or rejected. The response body contains the error message. diff --git a/openapi/anchor-platform/Events Schema.yml b/openapi/anchor-platform/Events Schema.yml deleted file mode 100644 index 58a2154cf..000000000 --- a/openapi/anchor-platform/Events Schema.yml +++ /dev/null @@ -1,18 +0,0 @@ -openapi: 3.0.0 -info: - version: "2.0.0" - title: Event Schemas - description: | - This document specifies the schemas used for Events in Stellar Anchor Platform project. - - There are currently two types of Events: `QuoteEvent` and `TransactionEvent`. When events occur (quote_created, transaction_created, etc...), the events are published by the Anchor Platform to a queue (Kafka, SQS, ect...) for the Anchor to consume and process. - - This differs from the Callbacks API, which defines requests made while the Platform is processing a request from a client application. -tags: - - name: "Event Schemas" - description: "Event Schemas for events that are published to a queue for the Anchor to consume." -paths: { } -components: - schemas: - Event: - $ref: './schemas.yml#/components/schemas/Event' diff --git a/openapi/anchor-platform/bundled.yml b/openapi/anchor-platform/bundled.yml index deaad66a2..d3d58aec6 100644 --- a/openapi/anchor-platform/bundled.yml +++ b/openapi/anchor-platform/bundled.yml @@ -332,6 +332,11 @@ components: type: string memo_type: $ref: '#/components/schemas/MemoType' + refund_memo: + description: if provided, this memo should be used for refund transactions + type: string + refund_memo_type: + $ref: '#/components/schemas/MemoType' TransactionListSEP24: type: object properties: diff --git a/openapi/anchor-platform/bundled_callback.yml b/openapi/anchor-platform/bundled_callback.yml index 1091fcb52..c80fc5a57 100644 --- a/openapi/anchor-platform/bundled_callback.yml +++ b/openapi/anchor-platform/bundled_callback.yml @@ -196,6 +196,7 @@ paths: tags: - Rates - SEP-31 + - SEP-38 summary: Retrieve Rates operationId: getRates parameters: @@ -465,6 +466,26 @@ paths: application/json: schema: $ref: '#/components/schemas/Error' + /event: + post: + tags: + - Events + - SEP-24 + - SEP-31 + summary: Receive an Event + operationId: postEvent + description: | + Receive a JSON object representing an event. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Event' + responses: + '200': + description: The event is successfully processed and ready to receive next event. The response body is empty. + '400': + description: The event is invalid or rejected. The response body contains the error message. components: schemas: Error: @@ -711,6 +732,340 @@ components: properties: id: type: string + StatusSEP24: + type: string + description: Possible status value for SEP-24 transactions + enum: + - incomplete + - completed + - refunded + - expired + - error + - pending_stellar + - pending_external + - pending_user_transfer_start + - pending_user_transfer_complete + - pending_anchor + - pending_trust + - pending_user + - no_market + - too_small + - too_large + Refunds: + type: object + properties: + amount_refunded: + $ref: '#/components/schemas/Amount' + amount_fee: + $ref: '#/components/schemas/Amount' + payments: + type: array + items: + type: object + properties: + id: + type: string + id_type: + type: string + enum: + - stellar + - external + amount: + $ref: '#/components/schemas/Amount' + fee: + $ref: '#/components/schemas/Amount' + requested_at: + type: string + format: date-time + refunded_at: + type: string + format: date-time + StellarTransaction: + type: object + required: + - id + - created_at + - envelope + - payments + properties: + id: + type: string + description: The ID of the transaction in the Stellar network. + memo: + type: string + description: The memo of the transaction in the Stellar network. + memo_type: + type: string + description: The memo type of the transaction in the Stellar network. Should be present if memo is not null. + enum: + - text + - hash + - id + created_at: + type: string + format: date-time + description: The time the transaction was registered in the Stellar network. + envelope: + type: string + description: The transaction envelope, containing all the transaction information. + payments: + type: array + items: + type: object + required: + - id + - payment_type + - source_account + - destination_account + - amount + properties: + id: + type: string + description: The ID of the payment in the Stellar Network. + payment_type: + type: string + description: The type of payment in the Stellar Network. + enum: + - payment + - path_payment + default: payment + source_account: + type: string + description: The account being debited in the Stellar Network. + destination_account: + type: string + description: The account being credited in the Stellar Network. + amount: + $ref: '#/components/schemas/Amount' + MemoType: + type: string + description: The memo type of the transaction in the Stellar network. Should be present if memo is not null. + enum: + - text id hash + TransactionSEP24: + type: object + required: + - id + - sep + - kind + - status + - amount_expected + - destination_account + - started_at + properties: + id: + type: string + sep: + type: string + enum: + - '24' + kind: + type: string + enum: + - deposit + - withdrawal + status: + $ref: '#/components/schemas/StatusSEP24' + amount_expected: + $ref: '#/components/schemas/Amount' + amount_in: + $ref: '#/components/schemas/Amount' + amount_out: + $ref: '#/components/schemas/Amount' + amount_fee: + $ref: '#/components/schemas/Amount' + started_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + completed_at: + type: string + format: date-time + transfer_received_at: + type: string + format: date-time + message: + type: string + refunds: + $ref: '#/components/schemas/Refunds' + stellar_transactions: + type: array + items: + $ref: '#/components/schemas/StellarTransaction' + source_account: + type: string + destination_account: + type: string + external_transaction_id: + type: string + memo: + type: string + memo_type: + $ref: '#/components/schemas/MemoType' + refund_memo: + description: if provided, this memo should be used for refund transactions + type: string + refund_memo_type: + $ref: '#/components/schemas/MemoType' + StatusSEP31: + type: string + description: Possible status value for SEP-31 transactions + enum: + - incomplete + - completed + - refunded + - expired + - error + - pending_stellar + - pending_external + - pending_sender + - pending_receiver + - pending_transaction_info_update + - pending_customer_info_update + StellarId: + type: object + description: | + StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors. + + For a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend. + + For a SEP-31 Sending Anchor, the `account` field should be used. + properties: + id: + type: string + description: The `id` of the customer registered through SEP-12. + account: + type: string + description: Either the Stellar account or Muxed account address of the on-chain entity. + TransactionSEP31: + type: object + required: + - id + - sep + - kind + - status + - started_at + properties: + id: + type: string + sep: + type: string + enum: + - '31' + kind: + type: string + enum: + - receive + status: + $ref: '#/components/schemas/StatusSEP31' + amount_expected: + $ref: '#/components/schemas/Amount' + amount_in: + $ref: '#/components/schemas/Amount' + amount_out: + $ref: '#/components/schemas/Amount' + amount_fee: + $ref: '#/components/schemas/Amount' + quote_id: + type: string + started_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + completed_at: + type: string + format: date-time + transfer_received_at: + type: string + format: date-time + message: + type: string + refunds: + $ref: '#/components/schemas/Refunds' + stellar_transactions: + type: array + items: + $ref: '#/components/schemas/StellarTransaction' + external_transaction_id: + type: string + customers: + type: object + description: | + The Identification info of the sending and receiving customers. If they were created through [SEP-12](https://stellar.org/protocol/sep-12), + this object should contain the SEP-12 customer `id`. Otherwise, the `account` address of the customer. + properties: + sender: + $ref: '#/components/schemas/StellarId' + receiver: + $ref: '#/components/schemas/StellarId' + creator: + $ref: '#/components/schemas/StellarId' + Quote: + type: object + properties: + id: + type: string + sell_amount: + type: string + sell_asset: + type: string + buy_amount: + type: string + buy_asset: + type: string + expires_at: + type: string + format: date-time + price: + type: string + total_price: + type: string + creator: + $ref: '#/components/schemas/StellarId' + transaction_id: + type: string + created_at: + type: string + format: date-time + Event: + type: object + properties: + id: + type: string + type: + type: string + enum: + - transaction_created + - transaction_status_changed + - transaction_error + - quote_created + description: | + The transaction event type. Can be one of the following: + - `transaction_created` - a transaction was created through the SEP endpoints. The payload is in the `transaction` field. + - `transaction_status_changed` - the status of a transaction has changed. The payload is in the `transaction` field. + - `transaction_error` - error processing the transaction. The payload is in the `transaction` field. + - `quote_created` - a quote was created via the SEP38 API. The payload is in the `quote` field. + timestamp: + type: string + format: date-time + payload: + type: object + properties: + transaction: + oneOf: + - $ref: '#/components/schemas/TransactionSEP24' + - $ref: '#/components/schemas/TransactionSEP31' + quote: + $ref: '#/components/schemas/Quote' + required: + - id + - type + - payload + - timestamp examples: SuccessKYC: summary: The case when a customer has been successfully KYC'd and approved diff --git a/openapi/anchor-platform/schemas.yml b/openapi/anchor-platform/schemas.yml index 7c5bac190..769b3c908 100644 --- a/openapi/anchor-platform/schemas.yml +++ b/openapi/anchor-platform/schemas.yml @@ -366,6 +366,11 @@ components: type: string memo_type: $ref: '#/components/schemas/MemoType' + refund_memo: + description: if provided, this memo should be used for refund transactions + type: string + refund_memo_type: + $ref: '#/components/schemas/MemoType' MemoType: type: string @@ -629,26 +634,32 @@ components: properties: id: type: string - sep: - type: string type: type: string enum: - transaction_created - transaction_status_changed - transaction_error - - quote_created - a quote was created via the SEP38 API + - quote_created description: | The transaction event type. Can be one of the following: - `transaction_created` - a transaction was created through the SEP endpoints. The payload is in the `transaction` field. - `transaction_status_changed` - the status of a transaction has changed. The payload is in the `transaction` field. - `transaction_error` - error processing the transaction. The payload is in the `transaction` field. - - `quote_created - a quote was created via the SEP38 API. The payload is in the `quote` field. - transaction: - $ref: '#/components/schemas/MutableTransaction' - quote: - $ref: '#/components/schemas/Quote' - + - `quote_created` - a quote was created via the SEP38 API. The payload is in the `quote` field. + timestamp: + type: string + format: date-time + payload: + type: object + properties: + transaction: + oneOf: + - $ref: './schemas.yml#/components/schemas/TransactionSEP24' + - $ref: './schemas.yml#/components/schemas/TransactionSEP31' + quote: + $ref: '#/components/schemas/Quote' + required: [ id, type, payload, timestamp ] Quote: type: object properties: diff --git a/src/components/CodeExample.js b/src/components/CodeExample.js index e7a05b909..ce73e5430 100644 --- a/src/components/CodeExample.js +++ b/src/components/CodeExample.js @@ -2,11 +2,9 @@ import React from 'react'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import CodeBlock from '@theme/CodeBlock'; -import {CODE_LANGS, PLATFORM_VERSION} from "../constants"; +import {CODE_LANGS} from "../constants"; export const CodeExample = ({ children }) => ( - // console.log(children), - {React.Children.map(children, (child, index) => { const codeProps = child.props.children.props; @@ -14,8 +12,6 @@ export const CodeExample = ({ children }) => ( const [, language] = className.split('-'); - const platformReplace = codeProps.children.replaceAll('[platform_version]', PLATFORM_VERSION) - return ( ( label={CODE_LANGS[language] || 'Example'} > - {typeof (codeProps.children) === 'string' ? platformReplace : codeProps.children} + {codeProps.children} ); diff --git a/src/constants.ts b/src/constants.ts index 447e1b047..390675e6f 100644 --- a/src/constants.ts +++ b/src/constants.ts @@ -1,5 +1,3 @@ -export const PLATFORM_VERSION="2.1.1" - export const CODE_LANGS = { bash: 'bash', cpp: 'C++', diff --git a/static/assets/SDP/SDP25.png b/static/assets/SDP/SDP25.png new file mode 100644 index 000000000..15f72b194 Binary files /dev/null and b/static/assets/SDP/SDP25.png differ