From 19b1dce2237f8b9c0de58b98fbd739fa056e5387 Mon Sep 17 00:00:00 2001 From: Elliot Voris Date: Thu, 6 Jul 2023 13:11:51 -0500 Subject: [PATCH] Re-organizing API documentation collections (#169) * Re-organizing API documentation collections These changes make it a bit more manageable to collect our various API specifications into a single navbar item in our docusaurus site. With the upcoming addition of the Hubble information, this will ease the implementation, and make things a bit more uniform. - I've included some nginx rewrites that I _think_ will do the correct redirections from any old URLs to the new ones. - There is now a single `API` dropdown menu item in the site's navbar, instead of having separate navbar links for all the various APIs, we can now collect them under a single button. - The `DocSidebar` component has been swizzled to allow us to keep the "category" of API used in the breadcrumbs, but to not clutter the sidebar with extra (and unnecessary) links. * Some updates to the anchor-platform openapi output * Fixing some broken links * Fixing the `/api/horizon` redirect with a negative lookahead. got myself into a redirect loop there. * Including `anchor-platform` in the negative lookahead * Changind dropdown menu text `API` -> `APIs` --------- Signed-off-by: Elliot Voris --- ap_api/callbacks/gen-address.api.mdx | 55 -------- ap_api/callbacks/get-fee.api.mdx | 60 --------- ap_api/callbacks/get-rates.api.mdx | 67 ---------- ap_api/callbacks/sidebar.js | 1 - ap_api/resources/sidebar.js | 1 - .../callbacks/_category_.json | 0 .../callbacks/customer/index.mdx | 0 .../callbacks/del-customer.api.mdx | 8 +- .../anchor-platform}/callbacks/fee/index.mdx | 0 .../callbacks/gen-address.api.mdx | 55 ++++++++ .../callbacks/get-customer.api.mdx | 20 +-- api/anchor-platform/callbacks/get-fee.api.mdx | 60 +++++++++ .../callbacks/get-rates.api.mdx | 67 ++++++++++ .../anchor-platform}/callbacks/index.mdx | 0 .../callbacks/put-customer.api.mdx | 10 +- .../anchor-platform}/callbacks/rate/index.mdx | 0 api/anchor-platform/callbacks/sidebar.js | 1 + .../callbacks/unique-address/index.mdx | 0 .../introduction/_category_.json | 0 .../anchor-platform}/introduction/index.mdx | 2 +- .../resources/_category_.json | 0 .../resources/get-transaction.api.mdx | 4 +- .../resources/get-transactions.api.mdx | 4 +- .../anchor-platform}/resources/index.mdx | 0 .../resources/patch-transactions.api.mdx | 6 +- api/anchor-platform/resources/sidebar.js | 1 + .../resources/transactions/index.mdx | 2 +- .../aggregations/_category_.json | 0 .../aggregations/fee-stats/_category_.json | 0 .../aggregations/fee-stats/index.mdx | 0 .../aggregations/fee-stats/object.mdx | 0 .../aggregations/fee-stats/single.mdx | 0 api/{ => horizon}/aggregations/index.mdx | 0 .../aggregations/order-books/_category_.json | 0 .../aggregations/order-books/index.mdx | 2 +- .../aggregations/order-books/object.mdx | 0 .../aggregations/order-books/single.mdx | 0 .../aggregations/paths/_category_.json | 0 .../aggregations/paths/index.mdx | 2 +- .../aggregations/paths/object.mdx | 0 .../aggregations/paths/strict-receive.mdx | 0 .../aggregations/paths/strict-send.mdx | 0 .../trade-aggregations/_category_.json | 0 .../aggregations/trade-aggregations/index.mdx | 0 .../aggregations/trade-aggregations/list.mdx | 0 .../trade-aggregations/object.mdx | 0 api/{ => horizon}/errors/_category_.json | 0 .../errors/http-status-codes/_category_.json | 0 .../horizon-specific/before-history.mdx | 0 .../horizon-specific/index.mdx | 0 .../horizon-specific/stale-history.mdx | 0 .../horizon-specific/timeout.mdx | 0 .../horizon-specific/transaction-failed.mdx | 0 .../transaction-malformed.mdx | 0 .../errors/http-status-codes/index.mdx | 0 .../errors/http-status-codes/standard.mdx | 0 api/{ => horizon}/errors/index.mdx | 0 api/{ => horizon}/errors/response.mdx | 0 .../errors/result-codes/_category_.json | 0 .../errors/result-codes/index.mdx | 0 .../operation-specific/account-merge.mdx | 2 +- .../operation-specific/allow-trust.mdx | 2 +- .../operation-specific/bump-sequence.mdx | 2 +- .../operation-specific/category.json | 0 .../operation-specific/change-trust.mdx | 2 +- .../operation-specific/create-account.mdx | 2 +- .../create-passive-sell-offer.mdx | 2 +- .../result-codes/operation-specific/index.mdx | 2 +- .../operation-specific/manage-buy-offer.mdx | 2 +- .../operation-specific/manage-data.mdx | 2 +- .../operation-specific/manage-sell-offer.mdx | 2 +- .../path-payment-strict-receive.mdx | 2 +- .../path-payment-strict-send.mdx | 2 +- .../operation-specific/payment.mdx | 2 +- .../operation-specific/set-options.mdx | 2 +- .../errors/result-codes/operations.mdx | 0 .../errors/result-codes/transactions.mdx | 0 .../introduction/_category_.json | 0 api/{ => horizon}/introduction/index.mdx | 9 +- .../introduction/pagination/_category_.json | 0 .../introduction/pagination/index.mdx | 0 .../pagination/page-arguments.mdx | 0 .../introduction/rate-limiting.mdx | 0 .../introduction/response-format.mdx | 0 api/{ => horizon}/introduction/streaming.mdx | 2 +- api/{ => horizon}/introduction/xdr.mdx | 0 api/{ => horizon}/resources/_category_.json | 0 .../resources/accounts/index.mdx | 2 +- .../resources/accounts/object.mdx | 6 +- api/{ => horizon}/resources/assets/index.mdx | 2 +- api/{ => horizon}/resources/assets/object.mdx | 0 .../cb-retrieve-related-operations.api.mdx | 2 +- .../cb-retrieve-related-transactions.api.mdx | 2 +- .../resources/claimablebalances/index.mdx | 0 .../resources/claimablebalances/object.mdx | 0 api/{ => horizon}/resources/effects/index.mdx | 0 api/{ => horizon}/resources/effects/types.mdx | 0 .../resources/get-all-offers.api.mdx | 2 +- .../resources/get-all-trades.api.mdx | 2 +- .../resources/get-data-by-account-id.api.mdx | 2 +- .../get-effects-by-account-id.api.mdx | 2 +- .../resources/get-offer-by-offer-id.api.mdx | 2 +- .../get-offers-by-account-id.api.mdx | 2 +- .../get-operations-by-account-id.api.mdx | 2 +- .../get-payments-by-account-id.api.mdx | 2 +- .../get-trades-by-account-id.api.mdx | 2 +- .../resources/get-trades-by-offer-id.api.mdx | 2 +- .../get-transactions-by-account-id.api.mdx | 2 +- api/{ => horizon}/resources/index.mdx | 0 api/{ => horizon}/resources/ledgers/index.mdx | 2 +- .../resources/ledgers/object.mdx | 2 +- .../resources/liquiditypools/index.mdx | 0 .../resources/list-all-accounts.api.mdx | 2 +- .../resources/list-all-assets.api.mdx | 2 +- .../list-all-claimable-balances.api.mdx | 2 +- .../resources/list-all-effects.api.mdx | 2 +- .../resources/list-all-ledgers.api.mdx | 2 +- .../resources/list-all-operations.api.mdx | 2 +- .../resources/list-all-payments.api.mdx | 2 +- .../resources/list-all-transactions.api.mdx | 2 +- .../resources/list-liquidity-pools.api.mdx | 2 +- .../list-strict-receive-payment-paths.api.mdx | 2 +- .../list-strict-send-payment-paths.api.mdx | 2 +- .../resources/list-trade-aggregations.api.mdx | 2 +- .../lp-retrieve-related-operations.api.mdx | 2 +- .../lp-retrieve-related-transactions.api.mdx | 2 +- api/{ => horizon}/resources/offers/index.mdx | 2 +- api/{ => horizon}/resources/offers/object.mdx | 0 .../resources/operations/index.mdx | 0 .../operations/object/account-merge.mdx | 0 .../operations/object/allow-trust.mdx | 0 .../begin-sponsoring-future-reserves.mdx | 0 .../operations/object/bump-sequence.mdx | 0 .../resources/operations/object/buy-offer.mdx | 0 .../operations/object/change-trust.mdx | 0 .../object/claim-claimable-balance.mdx | 0 .../operations/object/create-account.mdx | 0 .../object/create-claimable-balance.mdx | 0 .../object/end-sponsoring-future-reserves.mdx | 0 .../resources/operations/object/index.mdx | 0 .../object/liquidity-pool-deposit.mdx | 2 +- .../object/liquidity-pool-withdraw.mdx | 2 +- .../operations/object/manage-data.mdx | 0 .../operations/object/passive-sell-offer.mdx | 0 .../object/path-payment-strict-receive.mdx | 0 .../object/path-payment-strict-send.mdx | 0 .../resources/operations/object/payment.mdx | 0 .../operations/object/revoke-sponsorship.mdx | 0 .../operations/object/sell-offer.mdx | 0 .../operations/object/set-options.mdx | 0 .../retrieve-a-claimable-balance.api.mdx | 2 +- .../resources/retrieve-a-ledger.api.mdx | 2 +- .../retrieve-a-ledgers-effects.api.mdx | 2 +- .../retrieve-a-ledgers-operations.api.mdx | 2 +- .../retrieve-a-ledgers-payments.api.mdx | 2 +- .../retrieve-a-ledgers-transactions.api.mdx | 2 +- .../retrieve-a-liquidity-pool.api.mdx | 2 +- .../resources/retrieve-a-transaction.api.mdx | 2 +- .../retrieve-a-transactions-effects.api.mdx | 2 +- ...retrieve-a-transactions-operations.api.mdx | 2 +- .../resources/retrieve-an-account.api.mdx | 2 +- .../resources/retrieve-an-operation.api.mdx | 2 +- .../retrieve-an-operations-effects.api.mdx | 2 +- .../resources/retrieve-an-order-book.api.mdx | 2 +- .../resources/retrieve-fee-stats.api.mdx | 2 +- .../retrieve-related-effects.api.mdx | 2 +- .../resources/retrieve-related-trades.api.mdx | 2 +- api/horizon/resources/sidebar.js | 1 + .../resources/submit-a-transaction.api.mdx | 2 +- api/{ => horizon}/resources/trades/index.mdx | 2 +- api/{ => horizon}/resources/trades/object.mdx | 0 .../resources/transactions/index.mdx | 2 +- .../resources/transactions/object.mdx | 6 +- api/index.mdx | 26 ++++ api/resources/sidebar.js | 1 - .../anchor-platform/architecture.mdx | 4 +- .../anchor-platform/sep31/configuration.mdx | 2 +- .../anchor-platform/sep31/integration.mdx | 20 +-- docusaurus.config.js | 51 +++---- nginx/includes/redirects.conf | 4 + .../{ap => anchor-platform}/Callbacks API.yml | 106 +++++++-------- .../{ap => anchor-platform}/Events Schema.yml | 0 .../{ap => anchor-platform}/Platform API.yml | 0 openapi/{ap => anchor-platform}/bundled.yml | 0 .../bundled_callback.yml | 82 ++++++------ openapi/{ap => anchor-platform}/examples.yml | 0 openapi/{ap => anchor-platform}/schemas.yml | 0 openapi/{ => horizon}/README.md | 0 openapi/{ => horizon}/bundled.yml | 0 .../components/endpoints/accounts.yml | 0 .../components/endpoints/assets.yml | 0 .../endpoints/claimableBalances.yml | 0 .../components/endpoints/effects.yml | 0 .../components/endpoints/feeStats.yml | 0 .../components/endpoints/ledgers.yml | 0 .../components/endpoints/liquidityPools.yml | 0 .../components/endpoints/offers.yml | 0 .../components/endpoints/operations.yml | 0 .../components/endpoints/orderBooks.yml | 0 .../components/endpoints/paths.yml | 0 .../endpoints/tradeAggregations.yml | 0 .../components/endpoints/trades.yml | 0 .../components/endpoints/transactions.yml | 0 .../responses/Accounts/ListAllAccounts.yml | 0 .../responses/Accounts/RetrieveAnAccount.yml | 0 .../Accounts/RetrieveAnAccountsData.yml | 0 .../Accounts/RetrieveAnAccountsEffects.yml | 0 .../Accounts/RetrieveAnAccountsOffers.yml | 0 .../Accounts/RetrieveAnAccountsOperations.yml | 0 .../Accounts/RetrieveAnAccountsPayments.yml | 0 .../Accounts/RetrieveAnAccountsTrades.yml | 0 .../RetrieveAnAccountsTransactions.yml | 0 .../responses/Assets/ListAllAssets.yml | 0 .../CBRetrieveRelatedOperations.yml | 0 .../CBRetrieveRelatedTransactions.yml | 0 .../ListAllClaimableBalances.yml | 0 .../RetrieveAClaimableBalance.yml | 0 .../responses/Effects/ListAllEffects.yml | 0 .../responses/FeeStats/RetrieveFeeStats.yml | 0 .../responses/Ledgers/ListAllLedgers.yml | 0 .../responses/Ledgers/RetrieveALedger.yml | 0 .../Ledgers/RetrieveALedgersEffects.yml | 0 .../Ledgers/RetrieveALedgersOperations.yml | 0 .../Ledgers/RetrieveALedgersPayments.yml | 0 .../Ledgers/RetrieveALedgersTransactions.yml | 0 .../LPRetrieveRelatedOperations.yml | 0 .../LPRetrieveRelatedTransactions.yml | 0 .../LiqudityPools/ListLiquidityPools.yml | 0 .../LiqudityPools/RetrieveALiquidityPool.yml | 0 .../LiqudityPools/RetrieveRelatedEffects.yml | 0 .../LiqudityPools/RetrieveRelatedTrades.yml | 0 .../responses/Offers/GetAllOffers.yml | 0 .../responses/Offers/GetOfferByOfferId.yml | 0 .../responses/Offers/GetTradesByOfferId.yml | 0 .../Operations/ListAllOperations.yml | 0 .../responses/Operations/ListAllPayments.yml | 0 .../Operations/RetrieveAnOperation.yml | 0 .../RetrieveAnOperationsEffects.yml | 0 .../OrderBooks/RetrieveAnOrderBook.yml | 0 .../Paths/ListStrictReceivePaymentPaths.yml | 0 .../Paths/ListStrictSendPaymentPaths.yml | 0 .../ListTradeAggregations.yml | 0 .../responses/Trades/GetAllTrades.yml | 0 .../Transactions/ListAllTransactions.yml | 0 .../Transactions/RetrieveATransaction.yml | 0 .../RetrieveATransactionsEffects.yml | 0 .../RetrieveATransactionsOperations.yml | 0 .../Transactions/SubmitaTransaction.yml | 0 .../components/instance_variables.yml | 0 .../{ => horizon}/components/parameters.yml | 0 .../components/schemas/accountMergeSchema.yml | 0 .../components/schemas/accountSchema.yml | 0 .../components/schemas/allowTrustSchema.yml | 0 .../components/schemas/assetSchema.yml | 0 .../components/schemas/balanceSchema.yml | 0 .../components/schemas/baseAssetSchema.yml | 0 .../beginSponsoringFutureReservesSchema.yml | 0 .../components/schemas/bumpSequenceSchema.yml | 0 .../components/schemas/changeTrustSchema.yml | 0 .../schemas/claimClaimableBalanceSchema.yml | 0 .../schemas/claimableBalanceSchema.yml | 0 .../schemas/createAccountSchema.yml | 0 .../schemas/createClaimableBalanceSchema.yml | 0 .../schemas/createPassiveSellOfferSchema.yml | 0 .../components/schemas/effectsSchema.yml | 0 .../endSponsoringFutureReservesSchema.yml | 0 .../components/schemas/feeStatsSchema.yml | 0 .../components/schemas/ledgerSchema.yml | 0 .../components/schemas/linksSchema.yml | 0 .../components/schemas/liquidityPool.yml | 0 .../schemas/liquidityPoolDepositSchema.yml | 0 .../schemas/liquidityPoolWithdrawSchema.yml | 0 .../schemas/manageBuyOfferSchema.yml | 0 .../components/schemas/manageDataSchema.yml | 0 .../schemas/manageSellOfferSchema.yml | 0 .../components/schemas/offerSchema.yml | 0 .../components/schemas/operationSchema.yml | 0 .../components/schemas/orderBook.yml | 0 .../{ => horizon}/components/schemas/path.yml | 0 .../pathPaymentStrictReceiveSchema.yml | 0 .../schemas/pathPaymentStrictSendSchema.yml | 0 .../components/schemas/paymentSchema.yml | 0 .../schemas/revokeSponsorshipSchema.yml | 0 .../components/schemas/setOptionsSchema.yml | 0 .../schemas/tradeAggregationSchema.yml | 0 .../components/schemas/tradeSchema.yml | 0 .../components/schemas/transactionSchema.yml | 0 .../schemas/transactionTransactionSchema.yml | 0 openapi/horizon/main.yml | 125 +++++++++++++++++ openapi/main.yml | 126 ------------------ package.json | 4 +- sidebars.js | 2 +- sidebarsApi.js | 27 +++- src/css/custom.scss | 2 +- src/sidebar-api-generator.js | 2 + src/theme/DocSidebar/index.js | 23 ++++ 296 files changed, 631 insertions(+), 564 deletions(-) delete mode 100644 ap_api/callbacks/gen-address.api.mdx delete mode 100644 ap_api/callbacks/get-fee.api.mdx delete mode 100644 ap_api/callbacks/get-rates.api.mdx delete mode 100644 ap_api/callbacks/sidebar.js delete mode 100644 ap_api/resources/sidebar.js rename {ap_api => api/anchor-platform}/callbacks/_category_.json (100%) rename {ap_api => api/anchor-platform}/callbacks/customer/index.mdx (100%) rename {ap_api => api/anchor-platform}/callbacks/del-customer.api.mdx (56%) rename {ap_api => api/anchor-platform}/callbacks/fee/index.mdx (100%) create mode 100644 api/anchor-platform/callbacks/gen-address.api.mdx rename {ap_api => api/anchor-platform}/callbacks/get-customer.api.mdx (55%) create mode 100644 api/anchor-platform/callbacks/get-fee.api.mdx create mode 100644 api/anchor-platform/callbacks/get-rates.api.mdx rename {ap_api => api/anchor-platform}/callbacks/index.mdx (100%) rename {ap_api => api/anchor-platform}/callbacks/put-customer.api.mdx (67%) rename {ap_api => api/anchor-platform}/callbacks/rate/index.mdx (100%) create mode 100644 api/anchor-platform/callbacks/sidebar.js rename {ap_api => api/anchor-platform}/callbacks/unique-address/index.mdx (100%) rename {ap_api => api/anchor-platform}/introduction/_category_.json (100%) rename {ap_api => api/anchor-platform}/introduction/index.mdx (97%) rename {ap_api => api/anchor-platform}/resources/_category_.json (100%) rename {ap_api => api/anchor-platform}/resources/get-transaction.api.mdx (98%) rename {ap_api => api/anchor-platform}/resources/get-transactions.api.mdx (99%) rename {ap_api => api/anchor-platform}/resources/index.mdx (100%) rename {ap_api => api/anchor-platform}/resources/patch-transactions.api.mdx (98%) create mode 100644 api/anchor-platform/resources/sidebar.js rename {ap_api => api/anchor-platform}/resources/transactions/index.mdx (86%) rename api/{ => horizon}/aggregations/_category_.json (100%) rename api/{ => horizon}/aggregations/fee-stats/_category_.json (100%) rename api/{ => horizon}/aggregations/fee-stats/index.mdx (100%) rename api/{ => horizon}/aggregations/fee-stats/object.mdx (100%) rename api/{ => horizon}/aggregations/fee-stats/single.mdx (100%) rename api/{ => horizon}/aggregations/index.mdx (100%) rename api/{ => horizon}/aggregations/order-books/_category_.json (100%) rename api/{ => horizon}/aggregations/order-books/index.mdx (81%) rename api/{ => horizon}/aggregations/order-books/object.mdx (100%) rename api/{ => horizon}/aggregations/order-books/single.mdx (100%) rename api/{ => horizon}/aggregations/paths/_category_.json (100%) rename api/{ => horizon}/aggregations/paths/index.mdx (72%) rename api/{ => horizon}/aggregations/paths/object.mdx (100%) rename api/{ => horizon}/aggregations/paths/strict-receive.mdx (100%) rename api/{ => horizon}/aggregations/paths/strict-send.mdx (100%) rename api/{ => horizon}/aggregations/trade-aggregations/_category_.json (100%) rename api/{ => horizon}/aggregations/trade-aggregations/index.mdx (100%) rename api/{ => horizon}/aggregations/trade-aggregations/list.mdx (100%) rename api/{ => horizon}/aggregations/trade-aggregations/object.mdx (100%) rename api/{ => horizon}/errors/_category_.json (100%) rename api/{ => horizon}/errors/http-status-codes/_category_.json (100%) rename api/{ => horizon}/errors/http-status-codes/horizon-specific/before-history.mdx (100%) rename api/{ => horizon}/errors/http-status-codes/horizon-specific/index.mdx (100%) rename api/{ => horizon}/errors/http-status-codes/horizon-specific/stale-history.mdx (100%) rename api/{ => horizon}/errors/http-status-codes/horizon-specific/timeout.mdx (100%) rename api/{ => horizon}/errors/http-status-codes/horizon-specific/transaction-failed.mdx (100%) rename api/{ => horizon}/errors/http-status-codes/horizon-specific/transaction-malformed.mdx (100%) rename api/{ => horizon}/errors/http-status-codes/index.mdx (100%) rename api/{ => horizon}/errors/http-status-codes/standard.mdx (100%) rename api/{ => horizon}/errors/index.mdx (100%) rename api/{ => horizon}/errors/response.mdx (100%) rename api/{ => horizon}/errors/result-codes/_category_.json (100%) rename api/{ => horizon}/errors/result-codes/index.mdx (100%) rename api/{ => horizon}/errors/result-codes/operation-specific/account-merge.mdx (90%) rename api/{ => horizon}/errors/result-codes/operation-specific/allow-trust.mdx (91%) rename api/{ => horizon}/errors/result-codes/operation-specific/bump-sequence.mdx (83%) rename api/{ => horizon}/errors/result-codes/operation-specific/category.json (100%) rename api/{ => horizon}/errors/result-codes/operation-specific/change-trust.mdx (90%) rename api/{ => horizon}/errors/result-codes/operation-specific/create-account.mdx (89%) rename api/{ => horizon}/errors/result-codes/operation-specific/create-passive-sell-offer.mdx (94%) rename api/{ => horizon}/errors/result-codes/operation-specific/index.mdx (89%) rename api/{ => horizon}/errors/result-codes/operation-specific/manage-buy-offer.mdx (94%) rename api/{ => horizon}/errors/result-codes/operation-specific/manage-data.mdx (91%) rename api/{ => horizon}/errors/result-codes/operation-specific/manage-sell-offer.mdx (94%) rename api/{ => horizon}/errors/result-codes/operation-specific/path-payment-strict-receive.mdx (93%) rename api/{ => horizon}/errors/result-codes/operation-specific/path-payment-strict-send.mdx (93%) rename api/{ => horizon}/errors/result-codes/operation-specific/payment.mdx (93%) rename api/{ => horizon}/errors/result-codes/operation-specific/set-options.mdx (93%) rename api/{ => horizon}/errors/result-codes/operations.mdx (100%) rename api/{ => horizon}/errors/result-codes/transactions.mdx (100%) rename api/{ => horizon}/introduction/_category_.json (100%) rename api/{ => horizon}/introduction/index.mdx (61%) rename api/{ => horizon}/introduction/pagination/_category_.json (100%) rename api/{ => horizon}/introduction/pagination/index.mdx (100%) rename api/{ => horizon}/introduction/pagination/page-arguments.mdx (100%) rename api/{ => horizon}/introduction/rate-limiting.mdx (100%) rename api/{ => horizon}/introduction/response-format.mdx (100%) rename api/{ => horizon}/introduction/streaming.mdx (94%) rename api/{ => horizon}/introduction/xdr.mdx (100%) rename api/{ => horizon}/resources/_category_.json (100%) rename api/{ => horizon}/resources/accounts/index.mdx (95%) rename api/{ => horizon}/resources/accounts/object.mdx (97%) rename api/{ => horizon}/resources/assets/index.mdx (86%) rename api/{ => horizon}/resources/assets/object.mdx (100%) rename api/{ => horizon}/resources/cb-retrieve-related-operations.api.mdx (99%) rename api/{ => horizon}/resources/cb-retrieve-related-transactions.api.mdx (99%) rename api/{ => horizon}/resources/claimablebalances/index.mdx (100%) rename api/{ => horizon}/resources/claimablebalances/object.mdx (100%) rename api/{ => horizon}/resources/effects/index.mdx (100%) rename api/{ => horizon}/resources/effects/types.mdx (100%) rename api/{ => horizon}/resources/get-all-offers.api.mdx (99%) rename api/{ => horizon}/resources/get-all-trades.api.mdx (99%) rename api/{ => horizon}/resources/get-data-by-account-id.api.mdx (99%) rename api/{ => horizon}/resources/get-effects-by-account-id.api.mdx (99%) rename api/{ => horizon}/resources/get-offer-by-offer-id.api.mdx (99%) rename api/{ => horizon}/resources/get-offers-by-account-id.api.mdx (99%) rename api/{ => horizon}/resources/get-operations-by-account-id.api.mdx (99%) rename api/{ => horizon}/resources/get-payments-by-account-id.api.mdx (99%) rename api/{ => horizon}/resources/get-trades-by-account-id.api.mdx (99%) rename api/{ => horizon}/resources/get-trades-by-offer-id.api.mdx (99%) rename api/{ => horizon}/resources/get-transactions-by-account-id.api.mdx (99%) rename api/{ => horizon}/resources/index.mdx (100%) rename api/{ => horizon}/resources/ledgers/index.mdx (94%) rename api/{ => horizon}/resources/ledgers/object.mdx (97%) rename api/{ => horizon}/resources/liquiditypools/index.mdx (100%) rename api/{ => horizon}/resources/list-all-accounts.api.mdx (99%) rename api/{ => horizon}/resources/list-all-assets.api.mdx (99%) rename api/{ => horizon}/resources/list-all-claimable-balances.api.mdx (99%) rename api/{ => horizon}/resources/list-all-effects.api.mdx (99%) rename api/{ => horizon}/resources/list-all-ledgers.api.mdx (99%) rename api/{ => horizon}/resources/list-all-operations.api.mdx (99%) rename api/{ => horizon}/resources/list-all-payments.api.mdx (99%) rename api/{ => horizon}/resources/list-all-transactions.api.mdx (99%) rename api/{ => horizon}/resources/list-liquidity-pools.api.mdx (99%) rename api/{ => horizon}/resources/list-strict-receive-payment-paths.api.mdx (99%) rename api/{ => horizon}/resources/list-strict-send-payment-paths.api.mdx (99%) rename api/{ => horizon}/resources/list-trade-aggregations.api.mdx (99%) rename api/{ => horizon}/resources/lp-retrieve-related-operations.api.mdx (99%) rename api/{ => horizon}/resources/lp-retrieve-related-transactions.api.mdx (99%) rename api/{ => horizon}/resources/offers/index.mdx (88%) rename api/{ => horizon}/resources/offers/object.mdx (100%) rename api/{ => horizon}/resources/operations/index.mdx (100%) rename api/{ => horizon}/resources/operations/object/account-merge.mdx (100%) rename api/{ => horizon}/resources/operations/object/allow-trust.mdx (100%) rename api/{ => horizon}/resources/operations/object/begin-sponsoring-future-reserves.mdx (100%) rename api/{ => horizon}/resources/operations/object/bump-sequence.mdx (100%) rename api/{ => horizon}/resources/operations/object/buy-offer.mdx (100%) rename api/{ => horizon}/resources/operations/object/change-trust.mdx (100%) rename api/{ => horizon}/resources/operations/object/claim-claimable-balance.mdx (100%) rename api/{ => horizon}/resources/operations/object/create-account.mdx (100%) rename api/{ => horizon}/resources/operations/object/create-claimable-balance.mdx (100%) rename api/{ => horizon}/resources/operations/object/end-sponsoring-future-reserves.mdx (100%) rename api/{ => horizon}/resources/operations/object/index.mdx (100%) rename api/{ => horizon}/resources/operations/object/liquidity-pool-deposit.mdx (94%) rename api/{ => horizon}/resources/operations/object/liquidity-pool-withdraw.mdx (93%) rename api/{ => horizon}/resources/operations/object/manage-data.mdx (100%) rename api/{ => horizon}/resources/operations/object/passive-sell-offer.mdx (100%) rename api/{ => horizon}/resources/operations/object/path-payment-strict-receive.mdx (100%) rename api/{ => horizon}/resources/operations/object/path-payment-strict-send.mdx (100%) rename api/{ => horizon}/resources/operations/object/payment.mdx (100%) rename api/{ => horizon}/resources/operations/object/revoke-sponsorship.mdx (100%) rename api/{ => horizon}/resources/operations/object/sell-offer.mdx (100%) rename api/{ => horizon}/resources/operations/object/set-options.mdx (100%) rename api/{ => horizon}/resources/retrieve-a-claimable-balance.api.mdx (99%) rename api/{ => horizon}/resources/retrieve-a-ledger.api.mdx (99%) rename api/{ => horizon}/resources/retrieve-a-ledgers-effects.api.mdx (99%) rename api/{ => horizon}/resources/retrieve-a-ledgers-operations.api.mdx (99%) rename api/{ => horizon}/resources/retrieve-a-ledgers-payments.api.mdx (99%) rename api/{ => horizon}/resources/retrieve-a-ledgers-transactions.api.mdx (99%) rename api/{ => horizon}/resources/retrieve-a-liquidity-pool.api.mdx (99%) rename api/{ => horizon}/resources/retrieve-a-transaction.api.mdx (99%) rename api/{ => horizon}/resources/retrieve-a-transactions-effects.api.mdx (99%) rename api/{ => horizon}/resources/retrieve-a-transactions-operations.api.mdx (99%) rename api/{ => horizon}/resources/retrieve-an-account.api.mdx (99%) rename api/{ => horizon}/resources/retrieve-an-operation.api.mdx (99%) rename api/{ => horizon}/resources/retrieve-an-operations-effects.api.mdx (99%) rename api/{ => horizon}/resources/retrieve-an-order-book.api.mdx (99%) rename api/{ => horizon}/resources/retrieve-fee-stats.api.mdx (99%) rename api/{ => horizon}/resources/retrieve-related-effects.api.mdx (99%) rename api/{ => horizon}/resources/retrieve-related-trades.api.mdx (99%) create mode 100644 api/horizon/resources/sidebar.js rename api/{ => horizon}/resources/submit-a-transaction.api.mdx (99%) rename api/{ => horizon}/resources/trades/index.mdx (88%) rename api/{ => horizon}/resources/trades/object.mdx (100%) rename api/{ => horizon}/resources/transactions/index.mdx (92%) rename api/{ => horizon}/resources/transactions/object.mdx (94%) create mode 100644 api/index.mdx delete mode 100644 api/resources/sidebar.js rename openapi/{ap => anchor-platform}/Callbacks API.yml (90%) rename openapi/{ap => anchor-platform}/Events Schema.yml (100%) rename openapi/{ap => anchor-platform}/Platform API.yml (100%) rename openapi/{ap => anchor-platform}/bundled.yml (100%) rename openapi/{ap => anchor-platform}/bundled_callback.yml (93%) rename openapi/{ap => anchor-platform}/examples.yml (100%) rename openapi/{ap => anchor-platform}/schemas.yml (100%) rename openapi/{ => horizon}/README.md (100%) rename openapi/{ => horizon}/bundled.yml (100%) rename openapi/{ => horizon}/components/endpoints/accounts.yml (100%) rename openapi/{ => horizon}/components/endpoints/assets.yml (100%) rename openapi/{ => horizon}/components/endpoints/claimableBalances.yml (100%) rename openapi/{ => horizon}/components/endpoints/effects.yml (100%) rename openapi/{ => horizon}/components/endpoints/feeStats.yml (100%) rename openapi/{ => horizon}/components/endpoints/ledgers.yml (100%) rename openapi/{ => horizon}/components/endpoints/liquidityPools.yml (100%) rename openapi/{ => horizon}/components/endpoints/offers.yml (100%) rename openapi/{ => horizon}/components/endpoints/operations.yml (100%) rename openapi/{ => horizon}/components/endpoints/orderBooks.yml (100%) rename openapi/{ => horizon}/components/endpoints/paths.yml (100%) rename openapi/{ => horizon}/components/endpoints/tradeAggregations.yml (100%) rename openapi/{ => horizon}/components/endpoints/trades.yml (100%) rename openapi/{ => horizon}/components/endpoints/transactions.yml (100%) rename openapi/{ => horizon}/components/examples/responses/Accounts/ListAllAccounts.yml (100%) rename openapi/{ => horizon}/components/examples/responses/Accounts/RetrieveAnAccount.yml (100%) rename openapi/{ => horizon}/components/examples/responses/Accounts/RetrieveAnAccountsData.yml (100%) rename openapi/{ => horizon}/components/examples/responses/Accounts/RetrieveAnAccountsEffects.yml (100%) rename openapi/{ => horizon}/components/examples/responses/Accounts/RetrieveAnAccountsOffers.yml (100%) rename openapi/{ => horizon}/components/examples/responses/Accounts/RetrieveAnAccountsOperations.yml (100%) rename openapi/{ => horizon}/components/examples/responses/Accounts/RetrieveAnAccountsPayments.yml (100%) rename openapi/{ => horizon}/components/examples/responses/Accounts/RetrieveAnAccountsTrades.yml (100%) rename openapi/{ => horizon}/components/examples/responses/Accounts/RetrieveAnAccountsTransactions.yml (100%) rename openapi/{ => horizon}/components/examples/responses/Assets/ListAllAssets.yml (100%) rename openapi/{ => horizon}/components/examples/responses/ClaimableBalances/CBRetrieveRelatedOperations.yml (100%) rename openapi/{ => horizon}/components/examples/responses/ClaimableBalances/CBRetrieveRelatedTransactions.yml (100%) rename openapi/{ => horizon}/components/examples/responses/ClaimableBalances/ListAllClaimableBalances.yml (100%) rename openapi/{ => horizon}/components/examples/responses/ClaimableBalances/RetrieveAClaimableBalance.yml (100%) rename openapi/{ => horizon}/components/examples/responses/Effects/ListAllEffects.yml (100%) rename openapi/{ => horizon}/components/examples/responses/FeeStats/RetrieveFeeStats.yml (100%) rename openapi/{ => horizon}/components/examples/responses/Ledgers/ListAllLedgers.yml (100%) rename openapi/{ => horizon}/components/examples/responses/Ledgers/RetrieveALedger.yml (100%) rename openapi/{ => horizon}/components/examples/responses/Ledgers/RetrieveALedgersEffects.yml (100%) rename openapi/{ => horizon}/components/examples/responses/Ledgers/RetrieveALedgersOperations.yml (100%) rename openapi/{ => horizon}/components/examples/responses/Ledgers/RetrieveALedgersPayments.yml (100%) rename openapi/{ => horizon}/components/examples/responses/Ledgers/RetrieveALedgersTransactions.yml (100%) rename openapi/{ => horizon}/components/examples/responses/LiqudityPools/LPRetrieveRelatedOperations.yml (100%) rename openapi/{ => horizon}/components/examples/responses/LiqudityPools/LPRetrieveRelatedTransactions.yml (100%) rename openapi/{ => horizon}/components/examples/responses/LiqudityPools/ListLiquidityPools.yml (100%) rename openapi/{ => horizon}/components/examples/responses/LiqudityPools/RetrieveALiquidityPool.yml (100%) rename openapi/{ => horizon}/components/examples/responses/LiqudityPools/RetrieveRelatedEffects.yml (100%) rename openapi/{ => horizon}/components/examples/responses/LiqudityPools/RetrieveRelatedTrades.yml (100%) rename openapi/{ => horizon}/components/examples/responses/Offers/GetAllOffers.yml (100%) rename openapi/{ => horizon}/components/examples/responses/Offers/GetOfferByOfferId.yml (100%) rename openapi/{ => horizon}/components/examples/responses/Offers/GetTradesByOfferId.yml (100%) rename openapi/{ => horizon}/components/examples/responses/Operations/ListAllOperations.yml (100%) rename openapi/{ => horizon}/components/examples/responses/Operations/ListAllPayments.yml (100%) rename openapi/{ => horizon}/components/examples/responses/Operations/RetrieveAnOperation.yml (100%) rename openapi/{ => horizon}/components/examples/responses/Operations/RetrieveAnOperationsEffects.yml (100%) rename openapi/{ => horizon}/components/examples/responses/OrderBooks/RetrieveAnOrderBook.yml (100%) rename openapi/{ => horizon}/components/examples/responses/Paths/ListStrictReceivePaymentPaths.yml (100%) rename openapi/{ => horizon}/components/examples/responses/Paths/ListStrictSendPaymentPaths.yml (100%) rename openapi/{ => horizon}/components/examples/responses/TradeAggregations/ListTradeAggregations.yml (100%) rename openapi/{ => horizon}/components/examples/responses/Trades/GetAllTrades.yml (100%) rename openapi/{ => horizon}/components/examples/responses/Transactions/ListAllTransactions.yml (100%) rename openapi/{ => horizon}/components/examples/responses/Transactions/RetrieveATransaction.yml (100%) rename openapi/{ => horizon}/components/examples/responses/Transactions/RetrieveATransactionsEffects.yml (100%) rename openapi/{ => horizon}/components/examples/responses/Transactions/RetrieveATransactionsOperations.yml (100%) rename openapi/{ => horizon}/components/examples/responses/Transactions/SubmitaTransaction.yml (100%) rename openapi/{ => horizon}/components/instance_variables.yml (100%) rename openapi/{ => horizon}/components/parameters.yml (100%) rename openapi/{ => horizon}/components/schemas/accountMergeSchema.yml (100%) rename openapi/{ => horizon}/components/schemas/accountSchema.yml (100%) rename openapi/{ => horizon}/components/schemas/allowTrustSchema.yml (100%) rename openapi/{ => horizon}/components/schemas/assetSchema.yml (100%) rename openapi/{ => horizon}/components/schemas/balanceSchema.yml (100%) rename openapi/{ => horizon}/components/schemas/baseAssetSchema.yml (100%) rename openapi/{ => horizon}/components/schemas/beginSponsoringFutureReservesSchema.yml (100%) rename openapi/{ => horizon}/components/schemas/bumpSequenceSchema.yml (100%) rename openapi/{ => horizon}/components/schemas/changeTrustSchema.yml (100%) rename openapi/{ => horizon}/components/schemas/claimClaimableBalanceSchema.yml (100%) rename openapi/{ => horizon}/components/schemas/claimableBalanceSchema.yml (100%) rename openapi/{ => horizon}/components/schemas/createAccountSchema.yml (100%) rename openapi/{ => horizon}/components/schemas/createClaimableBalanceSchema.yml (100%) rename openapi/{ => horizon}/components/schemas/createPassiveSellOfferSchema.yml (100%) rename openapi/{ => horizon}/components/schemas/effectsSchema.yml (100%) rename openapi/{ => horizon}/components/schemas/endSponsoringFutureReservesSchema.yml (100%) rename openapi/{ => horizon}/components/schemas/feeStatsSchema.yml (100%) rename openapi/{ => horizon}/components/schemas/ledgerSchema.yml (100%) rename openapi/{ => horizon}/components/schemas/linksSchema.yml (100%) rename openapi/{ => horizon}/components/schemas/liquidityPool.yml (100%) rename openapi/{ => horizon}/components/schemas/liquidityPoolDepositSchema.yml (100%) rename openapi/{ => horizon}/components/schemas/liquidityPoolWithdrawSchema.yml (100%) rename openapi/{ => horizon}/components/schemas/manageBuyOfferSchema.yml (100%) rename openapi/{ => horizon}/components/schemas/manageDataSchema.yml (100%) rename openapi/{ => horizon}/components/schemas/manageSellOfferSchema.yml (100%) rename openapi/{ => horizon}/components/schemas/offerSchema.yml (100%) rename openapi/{ => horizon}/components/schemas/operationSchema.yml (100%) rename openapi/{ => horizon}/components/schemas/orderBook.yml (100%) rename openapi/{ => horizon}/components/schemas/path.yml (100%) rename openapi/{ => horizon}/components/schemas/pathPaymentStrictReceiveSchema.yml (100%) rename openapi/{ => horizon}/components/schemas/pathPaymentStrictSendSchema.yml (100%) rename openapi/{ => horizon}/components/schemas/paymentSchema.yml (100%) rename openapi/{ => horizon}/components/schemas/revokeSponsorshipSchema.yml (100%) rename openapi/{ => horizon}/components/schemas/setOptionsSchema.yml (100%) rename openapi/{ => horizon}/components/schemas/tradeAggregationSchema.yml (100%) rename openapi/{ => horizon}/components/schemas/tradeSchema.yml (100%) rename openapi/{ => horizon}/components/schemas/transactionSchema.yml (100%) rename openapi/{ => horizon}/components/schemas/transactionTransactionSchema.yml (100%) create mode 100644 openapi/horizon/main.yml delete mode 100644 openapi/main.yml create mode 100644 src/theme/DocSidebar/index.js diff --git a/ap_api/callbacks/gen-address.api.mdx b/ap_api/callbacks/gen-address.api.mdx deleted file mode 100644 index 7c312698d..000000000 --- a/ap_api/callbacks/gen-address.api.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -id: gen-address -title: "Generate Unique Address" -description: "If the platform is configured with `depositInfoGeneratorType: api`, the Platform make this request to" -sidebar_label: "Generate Unique Address" -hide_title: true -hide_table_of_contents: true -api: {"description":"If the platform is configured with `depositInfoGeneratorType: api`, the Platform make this request to \nthe Anchor backend every time a transaction is initiated by a client application.\n\nThe Anchor must guarantee that the memo returned in this request is unique, so it can be mapped 1-to-1 to a Platform\nresource such as a [SEP-31](https://stellar.org/protocol/sep-31) transaction.\n\nHere is how this flow would be used for Receiving Anchors that need to create their unique `(account, memo)` pairs\noutside the platform, using Circle:\n\n[![](https://mermaid.ink/img/pako:eNqlVctu2zAQ_JUFTy1iOwhyE9AUhuu0ORQ1YvdmIKDJVUSYIlWSihEY_veuRMuPhHaTVCc9VjPD4exyzYSVyDLm8U-NRuA3xR8dL-cG6AoqaMxgOp70r69g5rjxXARlDdxqu4KVCgXM2VpwrRdcLIeTu81lbRQhPXApHXo_ZxGp4i4ooSpuAkwDas1d4gMaqcwjDI0obOL7p3sUqJ6o5DNMNA-5deX5qlNII-WExvj-mLV_c3OR4slg8ms6g7XH6vpqcxn2XvgIYyuCJSPgnB2w4B4lkIGhQKi22CCsydVj7XiDF-GaK6WD9KXlTfkTwoGsf8JcvDYqg-_j2dkFfD1geFDyS5plb2U0mnDRIC0PgcNCW7EUBVcGtqCDPUqs79Ov_ZS8ewy1Mx4MriAKo_z5mKdOYlZiaeeM9lu5wVl9L1n2Zn6Qh5IUb5KWn9y6W2WUL5DSUSvdZrFJx7brDgyPDdd8e4emU1L6x7nfrznNPTjRLNtmzuAnX2LX2sT_XKIJ3U_xbf9Mb3WdIDGgCJ5i8gIKCl5VFCIJte8c-l8Xjvej82GnxdNaGyUHc2_81EjZbcPhRLwzuU2Q7YxKUjkrEIlkh0jyA9i8vc9pxvZaFd2COy-CbR93iDDSam93uhNPGD-cjX7AuptEbcenE1dJal-ZSqUPPNR-8JHk_25RW4KTiG-dz-3oSozny0zJxjFRoFi2VBG-s_l1yN_ZMq_kK9P80Q7zAeuxEulBSTpk1w3-nFF9iXOW0a3EnNc6NMfkhkqjy2OpgnUsy7n22GO8Dnb6bATLgquxK9oe1NuqzV8v2LI1)](https://mermaid.live/edit#pako:eNqlVctu2zAQ_JUFTy1iOwhyE9AUhuu0ORQ1YvdmIKDJVUSYIlWSihEY_veuRMuPhHaTVCc9VjPD4exyzYSVyDLm8U-NRuA3xR8dL-cG6AoqaMxgOp70r69g5rjxXARlDdxqu4KVCgXM2VpwrRdcLIeTu81lbRQhPXApHXo_ZxGp4i4ooSpuAkwDas1d4gMaqcwjDI0obOL7p3sUqJ6o5DNMNA-5deX5qlNII-WExvj-mLV_c3OR4slg8ms6g7XH6vpqcxn2XvgIYyuCJSPgnB2w4B4lkIGhQKi22CCsydVj7XiDF-GaK6WD9KXlTfkTwoGsf8JcvDYqg-_j2dkFfD1geFDyS5plb2U0mnDRIC0PgcNCW7EUBVcGtqCDPUqs79Ov_ZS8ewy1Mx4MriAKo_z5mKdOYlZiaeeM9lu5wVl9L1n2Zn6Qh5IUb5KWn9y6W2WUL5DSUSvdZrFJx7brDgyPDdd8e4emU1L6x7nfrznNPTjRLNtmzuAnX2LX2sT_XKIJ3U_xbf9Mb3WdIDGgCJ5i8gIKCl5VFCIJte8c-l8Xjvej82GnxdNaGyUHc2_81EjZbcPhRLwzuU2Q7YxKUjkrEIlkh0jyA9i8vc9pxvZaFd2COy-CbR93iDDSam93uhNPGD-cjX7AuptEbcenE1dJal-ZSqUPPNR-8JHk_25RW4KTiG-dz-3oSozny0zJxjFRoFi2VBG-s_l1yN_ZMq_kK9P80Q7zAeuxEulBSTpk1w3-nFF9iXOW0a3EnNc6NMfkhkqjy2OpgnUsy7n22GO8Dnb6bATLgquxK9oe1NuqzV8v2LI1)\n","operationId":"genAddress","tags":["Unique Address","SEP-31"],"parameters":[{"in":"query","name":"transaction_id","description":"The platform server will save the posted transaction and pass the `transaction_id` through this endpoint. \nIf the anchor wishes to return transaction-dependent unique_address, the anchor may query the [`GET /transactions` endpoint of the Platform API](/ap_api/resources/get-transaction).\n","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"unique_address":{"description":"An object containing the unique `stellar_address:memo` pair used to identify a destination.","type":"object","properties":{"stellar_address":{"description":"A `G...` stellar address or a `M...` [muxed stellar address](https://developers.stellar.org/docs/glossary/muxed-accounts/) of an **existing** account in the Stellar network.","type":"string"},"memo":{"description":"The memo to attach to the Stellar payment.","type":"string"},"memo_type":{"description":"The type of memo to attach to the Stellar payment (text, hash, or id).","type":"string","enum":["text","hash","id"]}},"required":["stellar_address"]}}}}}},"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":"/unique_address","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":"Generate Unique Address","description":{"content":"If the platform is configured with `depositInfoGeneratorType: api`, the Platform make this request to \nthe Anchor backend every time a transaction is initiated by a client application.\n\nThe Anchor must guarantee that the memo returned in this request is unique, so it can be mapped 1-to-1 to a Platform\nresource such as a [SEP-31](https://stellar.org/protocol/sep-31) transaction.\n\nHere is how this flow would be used for Receiving Anchors that need to create their unique `(account, memo)` pairs\noutside the platform, using Circle:\n\n[![](https://mermaid.ink/img/pako:eNqlVctu2zAQ_JUFTy1iOwhyE9AUhuu0ORQ1YvdmIKDJVUSYIlWSihEY_veuRMuPhHaTVCc9VjPD4exyzYSVyDLm8U-NRuA3xR8dL-cG6AoqaMxgOp70r69g5rjxXARlDdxqu4KVCgXM2VpwrRdcLIeTu81lbRQhPXApHXo_ZxGp4i4ooSpuAkwDas1d4gMaqcwjDI0obOL7p3sUqJ6o5DNMNA-5deX5qlNII-WExvj-mLV_c3OR4slg8ms6g7XH6vpqcxn2XvgIYyuCJSPgnB2w4B4lkIGhQKi22CCsydVj7XiDF-GaK6WD9KXlTfkTwoGsf8JcvDYqg-_j2dkFfD1geFDyS5plb2U0mnDRIC0PgcNCW7EUBVcGtqCDPUqs79Ov_ZS8ewy1Mx4MriAKo_z5mKdOYlZiaeeM9lu5wVl9L1n2Zn6Qh5IUb5KWn9y6W2WUL5DSUSvdZrFJx7brDgyPDdd8e4emU1L6x7nfrznNPTjRLNtmzuAnX2LX2sT_XKIJ3U_xbf9Mb3WdIDGgCJ5i8gIKCl5VFCIJte8c-l8Xjvej82GnxdNaGyUHc2_81EjZbcPhRLwzuU2Q7YxKUjkrEIlkh0jyA9i8vc9pxvZaFd2COy-CbR93iDDSam93uhNPGD-cjX7AuptEbcenE1dJal-ZSqUPPNR-8JHk_25RW4KTiG-dz-3oSozny0zJxjFRoFi2VBG-s_l1yN_ZMq_kK9P80Q7zAeuxEulBSTpk1w3-nFF9iXOW0a3EnNc6NMfkhkqjy2OpgnUsy7n22GO8Dnb6bATLgquxK9oe1NuqzV8v2LI1)](https://mermaid.live/edit#pako:eNqlVctu2zAQ_JUFTy1iOwhyE9AUhuu0ORQ1YvdmIKDJVUSYIlWSihEY_veuRMuPhHaTVCc9VjPD4exyzYSVyDLm8U-NRuA3xR8dL-cG6AoqaMxgOp70r69g5rjxXARlDdxqu4KVCgXM2VpwrRdcLIeTu81lbRQhPXApHXo_ZxGp4i4ooSpuAkwDas1d4gMaqcwjDI0obOL7p3sUqJ6o5DNMNA-5deX5qlNII-WExvj-mLV_c3OR4slg8ms6g7XH6vpqcxn2XvgIYyuCJSPgnB2w4B4lkIGhQKi22CCsydVj7XiDF-GaK6WD9KXlTfkTwoGsf8JcvDYqg-_j2dkFfD1geFDyS5plb2U0mnDRIC0PgcNCW7EUBVcGtqCDPUqs79Ov_ZS8ewy1Mx4MriAKo_z5mKdOYlZiaeeM9lu5wVl9L1n2Zn6Qh5IUb5KWn9y6W2WUL5DSUSvdZrFJx7brDgyPDdd8e4emU1L6x7nfrznNPTjRLNtmzuAnX2LX2sT_XKIJ3U_xbf9Mb3WdIDGgCJ5i8gIKCl5VFCIJte8c-l8Xjvej82GnxdNaGyUHc2_81EjZbcPhRLwzuU2Q7YxKUjkrEIlkh0jyA9i8vc9pxvZaFd2COy-CbR93iDDSam93uhNPGD-cjX7AuptEbcenE1dJal-ZSqUPPNR-8JHk_25RW4KTiG-dz-3oSozny0zJxjFRoFi2VBG-s_l1yN_ZMq_kK9P80Q7zAeuxEulBSTpk1w3-nFF9iXOW0a3EnNc6NMfkhkqjy2OpgnUsy7n22GO8Dnb6bATLgquxK9oe1NuqzV8v2LI1)\n","type":"text/plain"},"url":{"path":["unique_address"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) The platform server will save the posted transaction and pass the `transaction_id` through this endpoint. \nIf the anchor wishes to return transaction-dependent unique_address, the anchor may query the [`GET /transactions` endpoint of the Platform API](/ap_api/resources/get-transaction).\n","type":"text/plain"},"key":"transaction_id","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: api/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"; - -## Generate Unique Address - - - -If the platform is configured with `depositInfoGeneratorType: api`, the Platform make this request to -the Anchor backend every time a transaction is initiated by a client application. - -The Anchor must guarantee that the memo returned in this request is unique, so it can be mapped 1-to-1 to a Platform -resource such as a [SEP-31](https://stellar.org/protocol/sep-31) transaction. - -Here is how this flow would be used for Receiving Anchors that need to create their unique `(account, memo)` pairs -outside the platform, using Circle: - -[![](https://mermaid.ink/img/pako:eNqlVctu2zAQ_JUFTy1iOwhyE9AUhuu0ORQ1YvdmIKDJVUSYIlWSihEY_veuRMuPhHaTVCc9VjPD4exyzYSVyDLm8U-NRuA3xR8dL-cG6AoqaMxgOp70r69g5rjxXARlDdxqu4KVCgXM2VpwrRdcLIeTu81lbRQhPXApHXo_ZxGp4i4ooSpuAkwDas1d4gMaqcwjDI0obOL7p3sUqJ6o5DNMNA-5deX5qlNII-WExvj-mLV_c3OR4slg8ms6g7XH6vpqcxn2XvgIYyuCJSPgnB2w4B4lkIGhQKi22CCsydVj7XiDF-GaK6WD9KXlTfkTwoGsf8JcvDYqg-_j2dkFfD1geFDyS5plb2U0mnDRIC0PgcNCW7EUBVcGtqCDPUqs79Ov_ZS8ewy1Mx4MriAKo_z5mKdOYlZiaeeM9lu5wVl9L1n2Zn6Qh5IUb5KWn9y6W2WUL5DSUSvdZrFJx7brDgyPDdd8e4emU1L6x7nfrznNPTjRLNtmzuAnX2LX2sT_XKIJ3U_xbf9Mb3WdIDGgCJ5i8gIKCl5VFCIJte8c-l8Xjvej82GnxdNaGyUHc2_81EjZbcPhRLwzuU2Q7YxKUjkrEIlkh0jyA9i8vc9pxvZaFd2COy-CbR93iDDSam93uhNPGD-cjX7AuptEbcenE1dJal-ZSqUPPNR-8JHk_25RW4KTiG-dz-3oSozny0zJxjFRoFi2VBG-s_l1yN_ZMq_kK9P80Q7zAeuxEulBSTpk1w3-nFF9iXOW0a3EnNc6NMfkhkqjy2OpgnUsy7n22GO8Dnb6bATLgquxK9oe1NuqzV8v2LI1)](https://mermaid.live/edit#pako:eNqlVctu2zAQ_JUFTy1iOwhyE9AUhuu0ORQ1YvdmIKDJVUSYIlWSihEY_veuRMuPhHaTVCc9VjPD4exyzYSVyDLm8U-NRuA3xR8dL-cG6AoqaMxgOp70r69g5rjxXARlDdxqu4KVCgXM2VpwrRdcLIeTu81lbRQhPXApHXo_ZxGp4i4ooSpuAkwDas1d4gMaqcwjDI0obOL7p3sUqJ6o5DNMNA-5deX5qlNII-WExvj-mLV_c3OR4slg8ms6g7XH6vpqcxn2XvgIYyuCJSPgnB2w4B4lkIGhQKi22CCsydVj7XiDF-GaK6WD9KXlTfkTwoGsf8JcvDYqg-_j2dkFfD1geFDyS5plb2U0mnDRIC0PgcNCW7EUBVcGtqCDPUqs79Ov_ZS8ewy1Mx4MriAKo_z5mKdOYlZiaeeM9lu5wVl9L1n2Zn6Qh5IUb5KWn9y6W2WUL5DSUSvdZrFJx7brDgyPDdd8e4emU1L6x7nfrznNPTjRLNtmzuAnX2LX2sT_XKIJ3U_xbf9Mb3WdIDGgCJ5i8gIKCl5VFCIJte8c-l8Xjvej82GnxdNaGyUHc2_81EjZbcPhRLwzuU2Q7YxKUjkrEIlkh0jyA9i8vc9pxvZaFd2COy-CbR93iDDSam93uhNPGD-cjX7AuptEbcenE1dJal-ZSqUPPNR-8JHk_25RW4KTiG-dz-3oSozny0zJxjFRoFi2VBG-s_l1yN_ZMq_kK9P80Q7zAeuxEulBSTpk1w3-nFF9iXOW0a3EnNc6NMfkhkqjy2OpgnUsy7n22GO8Dnb6bATLgquxK9oe1NuqzV8v2LI1) - - -
Query Parameters
- -Success. - -
Schema
    unique_address object
    - -An object containing the unique `stellar_address:memo` pair used to identify a destination. - -
- -Error. The Platform will respond to the client application with the same response code and body. - -
Schema
diff --git a/ap_api/callbacks/get-fee.api.mdx b/ap_api/callbacks/get-fee.api.mdx deleted file mode 100644 index 3f9eadb19..000000000 --- a/ap_api/callbacks/get-fee.api.mdx +++ /dev/null @@ -1,60 +0,0 @@ ---- -id: get-fee -title: "Retrieve Fees" -description: "The Platform will make this request to the anchor every time a transaction is initiated by a client application" -sidebar_label: "Retrieve Fees" -hide_title: true -hide_table_of_contents: true -api: {"description":"The Platform will make this request to the anchor every time a transaction is initiated by a client application\nwithout a `quote_id`.\n\nThe Anchor must ensure that the sending and receiving customers specified in the request meet the KYC requirements\nnecessary to partake in the transaction described in the request.\n\nThe anchor must return the fee it will charge for the transaction.\n\nIn the future, this endpoint may be used to provide estimated fees to client applications prior to initiating transactions.\nWhen this change is made, the request schema will be adapted to support the use case.\n","tags":["Fees","SEP-31"],"operationId":"getFee","parameters":[{"in":"query","name":"send_asset","description":"The asset the client application will send to the anchor in exchange for `receive_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":"receive_asset","description":"The asset the that the anchor will send in exchange for `send_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":"send_amount","description":"The amount of `send_asset` the client application will send in exchange for `receive_asset`. One of `send_amount` \nor `receive_amount` will always be included in the request. If the client application specified a `quote_id` in \nits transaction creation request, both amounts specified in the referenced quote will be passed.\n","schema":{"type":"string"}},{"in":"query","name":"receive_amount","description":"The amount of `receive_asset` the anchor will send in exchange for `send_asset`. One of `send_amount` or \n`receive_amount` will always be included in the request. If the client application specified a `quote_id` in its \ntransaction creation request, both amounts specified in the referenced quote will be passed.\n","schema":{"type":"string"}},{"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.\nA client ID it the Stellar account of a sending anchor: In SEP-31, the `client_id` should match the account of a known SEP-31 sending anchor match the one used to authenticate via SEP-10.\n","schema":{"type":"string"},"required":true},{"in":"query","name":"sender_id","description":"The SEP-12 customer ID of the sending user.\n","schema":{"type":"string"},"required":true},{"in":"query","name":"receiver_id","description":"The SEP-12 customer ID of the receiving user.\n","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"}},"title":"FeeResponse"}}}},"422":{"description":"Unprocessable Entity. This status should be returned when the anchor understood the request but cannot \nreturn a success response. An example for when this response code would be appropriate is if the sender \nand/or receiver is not permitted to initiate a transaction with the specified amounts. In these cases, \nthe Platform will respond to the client application's request with a `400 Bad Request` and include the \nerror 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":"/fee","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 Fees","description":{"content":"The Platform will make this request to the anchor every time a transaction is initiated by a client application\nwithout a `quote_id`.\n\nThe Anchor must ensure that the sending and receiving customers specified in the request meet the KYC requirements\nnecessary to partake in the transaction described in the request.\n\nThe anchor must return the fee it will charge for the transaction.\n\nIn the future, this endpoint may be used to provide estimated fees to client applications prior to initiating transactions.\nWhen this change is made, the request schema will be adapted to support the use case.\n","type":"text/plain"},"url":{"path":["fee"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) The asset the client application will send to the anchor in exchange for `receive_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":"send_asset","value":""},{"disabled":false,"description":{"content":"(Required) The asset the that the anchor will send in exchange for `send_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":"receive_asset","value":""},{"disabled":false,"description":{"content":"The amount of `send_asset` the client application will send in exchange for `receive_asset`. One of `send_amount` \nor `receive_amount` will always be included in the request. If the client application specified a `quote_id` in \nits transaction creation request, both amounts specified in the referenced quote will be passed.\n","type":"text/plain"},"key":"send_amount","value":""},{"disabled":false,"description":{"content":"The amount of `receive_asset` the anchor will send in exchange for `send_asset`. One of `send_amount` or \n`receive_amount` will always be included in the request. If the client application specified a `quote_id` in its \ntransaction creation request, both amounts specified in the referenced quote will be passed.\n","type":"text/plain"},"key":"receive_amount","value":""},{"disabled":false,"description":{"content":"(Required) An identifier for the client application making the request. This ID can be used to offer different fees to different clients.\nA client ID it the Stellar account of a sending anchor: In SEP-31, the `client_id` should match the account of a known SEP-31 sending anchor match the one used to authenticate via SEP-10.\n","type":"text/plain"},"key":"client_id","value":""},{"disabled":false,"description":{"content":"(Required) The SEP-12 customer ID of the sending user.\n","type":"text/plain"},"key":"sender_id","value":""},{"disabled":false,"description":{"content":"(Required) The SEP-12 customer ID of the receiving user.\n","type":"text/plain"},"key":"receiver_id","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: api/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"; - -## Retrieve Fees - - - -The Platform will make this request to the anchor every time a transaction is initiated by a client application -without a `quote_id`. - -The Anchor must ensure that the sending and receiving customers specified in the request meet the KYC requirements -necessary to partake in the transaction described in the request. - -The anchor must return the fee it will charge for the transaction. - -In the future, this endpoint may be used to provide estimated fees to client applications prior to initiating transactions. -When this change is made, the request schema will be adapted to support the use case. - - -
Query Parameters
- -Success. - -
Schema
    fee object
- -Unprocessable Entity. This status should be returned when the anchor understood the request but cannot -return a success response. An example for when this response code would be appropriate is if the sender -and/or receiver is not permitted to initiate a transaction with the specified amounts. In these cases, -the Platform will respond to the client application's request with a `400 Bad Request` and include the -error message provided by the anchor in the response body. - - -
Schema
- -Error. The Platform will respond to the client application with the same response code and body. - -
Schema
diff --git a/ap_api/callbacks/get-rates.api.mdx b/ap_api/callbacks/get-rates.api.mdx deleted file mode 100644 index 540ef63ff..000000000 --- a/ap_api/callbacks/get-rates.api.mdx +++ /dev/null @@ -1,67 +0,0 @@ ---- -id: get-rates -title: "Retrieve Rates" -description: "Transactions that involve two non-equivalent on & off-chain assets (such as USDC on Stellar and fiat EUR) must" -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"}} -sidebar_class_name: "get api-method" -info_path: api/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"; - -## Retrieve Rates - - - -Transactions that involve two non-equivalent on & off-chain assets (such as USDC on Stellar and fiat EUR) must -use exchange rates that are communicated to the client application requesting the transaction. When clients make -requests to the Platform for these exchange rates, the Platform sends this request to the anchor to fetch it. - -Rates can be [indicative](https://www.investopedia.com/terms/i/indicativequote.asp) or -[firm](https://www.investopedia.com/terms/f/firmquote.asp). The anchor must provide an ID and expiration if the -client requests a firm rate. - -Anchors can provide discounted rates specific client applications. The Platform includes the `client_id` parameter -for this reason. - -Either `sell_amount` or `buy_amount` will be included in requests as parameters, but never both. In the same way, -either `sell_delivery_method` and `buy_delivery_method` may be included in requests, but never both, since either -`sell_asset` or `buy_asset` is a Stellar asset. - - -
Query Parameters
- -Success. - -
Schema
    rate object
    fee object
    - -An object describing the fees added on top of the rate provided via the `price` attribute. - -
    details object[]
  • Array [
  • ]
- -Unprocessable Entity. This status should be returned when the anchor understood the request but cannot -return a success response. -In these cases, the Platform will respond to the client application's request with a `400 Bad Request` -and include the error message provided by the anchor in the response body. - - -
Schema
- -Error. The Platform will respond to the client application with the same response code and body. - -
Schema
diff --git a/ap_api/callbacks/sidebar.js b/ap_api/callbacks/sidebar.js deleted file mode 100644 index dc3b27a72..000000000 --- a/ap_api/callbacks/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"doc","id":"callbacks/synchronous-callbacks-api"},{"type":"category","label":"Unique Address","link":{"type":"generated-index","title":"Unique Address","slug":"/category/callbacks/unique-address"},"items":[{"type":"doc","id":"callbacks/gen-address","label":"Generate Unique Address","className":"api-method get"}]},{"type":"category","label":"Fees","link":{"type":"generated-index","title":"Fees","slug":"/category/callbacks/fees"},"items":[{"type":"doc","id":"callbacks/get-fee","label":"Retrieve Fees","className":"api-method get"}]},{"type":"category","label":"Rates","link":{"type":"generated-index","title":"Rates","slug":"/category/callbacks/rates"},"items":[{"type":"doc","id":"callbacks/get-rates","label":"Retrieve Rates","className":"api-method get"}]},{"type":"category","label":"Customers","link":{"type":"generated-index","title":"Customers","slug":"/category/callbacks/customers"},"items":[{"type":"doc","id":"callbacks/get-customer","label":"Retrieve Customer's Info","className":"api-method get"},{"type":"doc","id":"callbacks/put-customer","label":"Create or Update Customer Info","className":"api-method put"},{"type":"doc","id":"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/callbacks/sep-31"},"items":[{"type":"doc","id":"callbacks/gen-address","label":"Generate Unique Address","className":"api-method get"},{"type":"doc","id":"callbacks/get-fee","label":"Retrieve Fees","className":"api-method get"},{"type":"doc","id":"callbacks/get-rates","label":"Retrieve Rates","className":"api-method get"},{"type":"doc","id":"callbacks/get-customer","label":"Retrieve Customer's Info","className":"api-method get"},{"type":"doc","id":"callbacks/put-customer","label":"Create or Update Customer Info","className":"api-method put"},{"type":"doc","id":"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/callbacks/sep-12"},"items":[{"type":"doc","id":"callbacks/get-customer","label":"Retrieve Customer's Info","className":"api-method get"},{"type":"doc","id":"callbacks/put-customer","label":"Create or Update Customer Info","className":"api-method put"},{"type":"doc","id":"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/callbacks/sep-24"},"items":[{"type":"doc","id":"callbacks/put-customer","label":"Create or Update Customer Info","className":"api-method put"}]}]; \ No newline at end of file diff --git a/ap_api/resources/sidebar.js b/ap_api/resources/sidebar.js deleted file mode 100644 index 45aa4dc21..000000000 --- a/ap_api/resources/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"doc","id":"resources/platform-api"},{"type":"category","label":"Transactions","link":{"type":"generated-index","title":"Transactions","slug":"/category/resources/transactions"},"items":[{"type":"doc","id":"resources/patch-transactions","label":"Update Transactions Info","className":"api-method patch"},{"type":"doc","id":"resources/get-transactions","label":"Retrieve a List of Transactions","className":"api-method get"},{"type":"doc","id":"resources/get-transaction","label":"Retrieve a Transaction","className":"api-method get"}]},{"type":"category","label":"SEP-24","link":{"type":"generated-index","title":"SEP-24","slug":"/category/resources/sep-24"},"items":[{"type":"doc","id":"resources/patch-transactions","label":"Update Transactions Info","className":"api-method patch"},{"type":"doc","id":"resources/get-transactions","label":"Retrieve a List of Transactions","className":"api-method get"},{"type":"doc","id":"resources/get-transaction","label":"Retrieve a Transaction","className":"api-method get"}]},{"type":"category","label":"SEP-31","link":{"type":"generated-index","title":"SEP-31","slug":"/category/resources/sep-31"},"items":[{"type":"doc","id":"resources/patch-transactions","label":"Update Transactions Info","className":"api-method patch"},{"type":"doc","id":"resources/get-transactions","label":"Retrieve a List of Transactions","className":"api-method get"},{"type":"doc","id":"resources/get-transaction","label":"Retrieve a Transaction","className":"api-method get"}]}]; \ No newline at end of file diff --git a/ap_api/callbacks/_category_.json b/api/anchor-platform/callbacks/_category_.json similarity index 100% rename from ap_api/callbacks/_category_.json rename to api/anchor-platform/callbacks/_category_.json diff --git a/ap_api/callbacks/customer/index.mdx b/api/anchor-platform/callbacks/customer/index.mdx similarity index 100% rename from ap_api/callbacks/customer/index.mdx rename to api/anchor-platform/callbacks/customer/index.mdx diff --git a/ap_api/callbacks/del-customer.api.mdx b/api/anchor-platform/callbacks/del-customer.api.mdx similarity index 56% rename from ap_api/callbacks/del-customer.api.mdx rename to api/anchor-platform/callbacks/del-customer.api.mdx index 7874a8a95..e205c58d0 100644 --- a/ap_api/callbacks/del-customer.api.mdx +++ b/api/anchor-platform/callbacks/del-customer.api.mdx @@ -5,9 +5,9 @@ description: "The request for this endpoint is identical to the" sidebar_label: "Delete Customer Data" hide_title: true hide_table_of_contents: true -api: {"tags":["Customers","SEP-12","SEP-31"],"description":"The request for this endpoint is identical to the \n[`DELETE /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-delete) \nrequest defined in SEP-12.\n\nDelete the customer's data or queue the customers data for deletion.\n","operationId":"delCustomer","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true}],"responses":{"204":{"description":"Success."},"404":{"description":"Customer not found.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"id":{"type":"string"}},"required":["error"],"title":"Error"}}}}},"method":"delete","path":"/customer/{id}","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":"Delete Customer Data","description":{"content":"The request for this endpoint is identical to the \n[`DELETE /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-delete) \nrequest defined in SEP-12.\n\nDelete the customer's data or queue the customers data for deletion.\n","type":"text/plain"},"url":{"path":["customer",":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":"DELETE"}} +api: {"tags":["Customers","SEP-12","SEP-31"],"description":"The request for this endpoint is identical to the\n[`DELETE /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-delete)\nrequest defined in SEP-12.\n\nDelete the customer's data or queue the customers data for deletion.\n","operationId":"delCustomer","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true}],"responses":{"204":{"description":"Success."},"404":{"description":"Customer not found.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"id":{"type":"string"}},"required":["error"],"title":"Error"}}}}},"method":"delete","path":"/customer/{id}","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":"Delete Customer Data","description":{"content":"The request for this endpoint is identical to the\n[`DELETE /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-delete)\nrequest defined in SEP-12.\n\nDelete the customer's data or queue the customers data for deletion.\n","type":"text/plain"},"url":{"path":["customer",":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":"DELETE"}} sidebar_class_name: "delete api-method" -info_path: api/callbacks/synchronous-callbacks-api +info_path: api/anchor-platform/callbacks/synchronous-callbacks-api custom_edit_url: null --- @@ -28,8 +28,8 @@ import TabItem from "@theme/TabItem"; -The request for this endpoint is identical to the -[`DELETE /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-delete) +The request for this endpoint is identical to the +[`DELETE /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-delete) request defined in SEP-12. Delete the customer's data or queue the customers data for deletion. diff --git a/ap_api/callbacks/fee/index.mdx b/api/anchor-platform/callbacks/fee/index.mdx similarity index 100% rename from ap_api/callbacks/fee/index.mdx rename to api/anchor-platform/callbacks/fee/index.mdx diff --git a/api/anchor-platform/callbacks/gen-address.api.mdx b/api/anchor-platform/callbacks/gen-address.api.mdx new file mode 100644 index 000000000..c33775bef --- /dev/null +++ b/api/anchor-platform/callbacks/gen-address.api.mdx @@ -0,0 +1,55 @@ +--- +id: gen-address +title: "Generate Unique Address" +description: "If the platform is configured with `depositInfoGeneratorType: api`, the Platform make this request to" +sidebar_label: "Generate Unique Address" +hide_title: true +hide_table_of_contents: true +api: {"description":"If the platform is configured with `depositInfoGeneratorType: api`, the Platform make this request to\nthe Anchor backend every time a transaction is initiated by a client application.\n\nThe Anchor must guarantee that the memo returned in this request is unique, so it can be mapped 1-to-1 to a Platform\nresource such as a [SEP-31](https://stellar.org/protocol/sep-31) transaction.\n\nHere is how this flow would be used for Receiving Anchors that need to create their unique `(account, memo)` pairs\noutside the platform, using Circle:\n\n[![](https://mermaid.ink/img/pako:eNqlVctu2zAQ_JUFTy1iOwhyE9AUhuu0ORQ1YvdmIKDJVUSYIlWSihEY_veuRMuPhHaTVCc9VjPD4exyzYSVyDLm8U-NRuA3xR8dL-cG6AoqaMxgOp70r69g5rjxXARlDdxqu4KVCgXM2VpwrRdcLIeTu81lbRQhPXApHXo_ZxGp4i4ooSpuAkwDas1d4gMaqcwjDI0obOL7p3sUqJ6o5DNMNA-5deX5qlNII-WExvj-mLV_c3OR4slg8ms6g7XH6vpqcxn2XvgIYyuCJSPgnB2w4B4lkIGhQKi22CCsydVj7XiDF-GaK6WD9KXlTfkTwoGsf8JcvDYqg-_j2dkFfD1geFDyS5plb2U0mnDRIC0PgcNCW7EUBVcGtqCDPUqs79Ov_ZS8ewy1Mx4MriAKo_z5mKdOYlZiaeeM9lu5wVl9L1n2Zn6Qh5IUb5KWn9y6W2WUL5DSUSvdZrFJx7brDgyPDdd8e4emU1L6x7nfrznNPTjRLNtmzuAnX2LX2sT_XKIJ3U_xbf9Mb3WdIDGgCJ5i8gIKCl5VFCIJte8c-l8Xjvej82GnxdNaGyUHc2_81EjZbcPhRLwzuU2Q7YxKUjkrEIlkh0jyA9i8vc9pxvZaFd2COy-CbR93iDDSam93uhNPGD-cjX7AuptEbcenE1dJal-ZSqUPPNR-8JHk_25RW4KTiG-dz-3oSozny0zJxjFRoFi2VBG-s_l1yN_ZMq_kK9P80Q7zAeuxEulBSTpk1w3-nFF9iXOW0a3EnNc6NMfkhkqjy2OpgnUsy7n22GO8Dnb6bATLgquxK9oe1NuqzV8v2LI1)](https://mermaid.live/edit#pako:eNqlVctu2zAQ_JUFTy1iOwhyE9AUhuu0ORQ1YvdmIKDJVUSYIlWSihEY_veuRMuPhHaTVCc9VjPD4exyzYSVyDLm8U-NRuA3xR8dL-cG6AoqaMxgOp70r69g5rjxXARlDdxqu4KVCgXM2VpwrRdcLIeTu81lbRQhPXApHXo_ZxGp4i4ooSpuAkwDas1d4gMaqcwjDI0obOL7p3sUqJ6o5DNMNA-5deX5qlNII-WExvj-mLV_c3OR4slg8ms6g7XH6vpqcxn2XvgIYyuCJSPgnB2w4B4lkIGhQKi22CCsydVj7XiDF-GaK6WD9KXlTfkTwoGsf8JcvDYqg-_j2dkFfD1geFDyS5plb2U0mnDRIC0PgcNCW7EUBVcGtqCDPUqs79Ov_ZS8ewy1Mx4MriAKo_z5mKdOYlZiaeeM9lu5wVl9L1n2Zn6Qh5IUb5KWn9y6W2WUL5DSUSvdZrFJx7brDgyPDdd8e4emU1L6x7nfrznNPTjRLNtmzuAnX2LX2sT_XKIJ3U_xbf9Mb3WdIDGgCJ5i8gIKCl5VFCIJte8c-l8Xjvej82GnxdNaGyUHc2_81EjZbcPhRLwzuU2Q7YxKUjkrEIlkh0jyA9i8vc9pxvZaFd2COy-CbR93iDDSam93uhNPGD-cjX7AuptEbcenE1dJal-ZSqUPPNR-8JHk_25RW4KTiG-dz-3oSozny0zJxjFRoFi2VBG-s_l1yN_ZMq_kK9P80Q7zAeuxEulBSTpk1w3-nFF9iXOW0a3EnNc6NMfkhkqjy2OpgnUsy7n22GO8Dnb6bATLgquxK9oe1NuqzV8v2LI1)\n","operationId":"genAddress","tags":["Unique Address","SEP-31"],"parameters":[{"in":"query","name":"transaction_id","description":"The platform server will save the posted transaction and pass the `transaction_id` through this endpoint.\nIf the anchor wishes to return transaction-dependent unique_address, the anchor may query the [`GET /transactions` endpoint of the Platform API](/api/anchor-platform/resources/get-transaction).\n","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"unique_address":{"description":"An object containing the unique `stellar_address:memo` pair used to identify a destination.","type":"object","properties":{"stellar_address":{"description":"A `G...` stellar address or a `M...` [muxed stellar address](https://developers.stellar.org/docs/glossary/muxed-accounts/) of an **existing** account in the Stellar network.","type":"string"},"memo":{"description":"The memo to attach to the Stellar payment.","type":"string"},"memo_type":{"description":"The type of memo to attach to the Stellar payment (text, hash, or id).","type":"string","enum":["text","hash","id"]}},"required":["stellar_address"]}}}}}},"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":"/unique_address","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":"Generate Unique Address","description":{"content":"If the platform is configured with `depositInfoGeneratorType: api`, the Platform make this request to\nthe Anchor backend every time a transaction is initiated by a client application.\n\nThe Anchor must guarantee that the memo returned in this request is unique, so it can be mapped 1-to-1 to a Platform\nresource such as a [SEP-31](https://stellar.org/protocol/sep-31) transaction.\n\nHere is how this flow would be used for Receiving Anchors that need to create their unique `(account, memo)` pairs\noutside the platform, using Circle:\n\n[![](https://mermaid.ink/img/pako:eNqlVctu2zAQ_JUFTy1iOwhyE9AUhuu0ORQ1YvdmIKDJVUSYIlWSihEY_veuRMuPhHaTVCc9VjPD4exyzYSVyDLm8U-NRuA3xR8dL-cG6AoqaMxgOp70r69g5rjxXARlDdxqu4KVCgXM2VpwrRdcLIeTu81lbRQhPXApHXo_ZxGp4i4ooSpuAkwDas1d4gMaqcwjDI0obOL7p3sUqJ6o5DNMNA-5deX5qlNII-WExvj-mLV_c3OR4slg8ms6g7XH6vpqcxn2XvgIYyuCJSPgnB2w4B4lkIGhQKi22CCsydVj7XiDF-GaK6WD9KXlTfkTwoGsf8JcvDYqg-_j2dkFfD1geFDyS5plb2U0mnDRIC0PgcNCW7EUBVcGtqCDPUqs79Ov_ZS8ewy1Mx4MriAKo_z5mKdOYlZiaeeM9lu5wVl9L1n2Zn6Qh5IUb5KWn9y6W2WUL5DSUSvdZrFJx7brDgyPDdd8e4emU1L6x7nfrznNPTjRLNtmzuAnX2LX2sT_XKIJ3U_xbf9Mb3WdIDGgCJ5i8gIKCl5VFCIJte8c-l8Xjvej82GnxdNaGyUHc2_81EjZbcPhRLwzuU2Q7YxKUjkrEIlkh0jyA9i8vc9pxvZaFd2COy-CbR93iDDSam93uhNPGD-cjX7AuptEbcenE1dJal-ZSqUPPNR-8JHk_25RW4KTiG-dz-3oSozny0zJxjFRoFi2VBG-s_l1yN_ZMq_kK9P80Q7zAeuxEulBSTpk1w3-nFF9iXOW0a3EnNc6NMfkhkqjy2OpgnUsy7n22GO8Dnb6bATLgquxK9oe1NuqzV8v2LI1)](https://mermaid.live/edit#pako:eNqlVctu2zAQ_JUFTy1iOwhyE9AUhuu0ORQ1YvdmIKDJVUSYIlWSihEY_veuRMuPhHaTVCc9VjPD4exyzYSVyDLm8U-NRuA3xR8dL-cG6AoqaMxgOp70r69g5rjxXARlDdxqu4KVCgXM2VpwrRdcLIeTu81lbRQhPXApHXo_ZxGp4i4ooSpuAkwDas1d4gMaqcwjDI0obOL7p3sUqJ6o5DNMNA-5deX5qlNII-WExvj-mLV_c3OR4slg8ms6g7XH6vpqcxn2XvgIYyuCJSPgnB2w4B4lkIGhQKi22CCsydVj7XiDF-GaK6WD9KXlTfkTwoGsf8JcvDYqg-_j2dkFfD1geFDyS5plb2U0mnDRIC0PgcNCW7EUBVcGtqCDPUqs79Ov_ZS8ewy1Mx4MriAKo_z5mKdOYlZiaeeM9lu5wVl9L1n2Zn6Qh5IUb5KWn9y6W2WUL5DSUSvdZrFJx7brDgyPDdd8e4emU1L6x7nfrznNPTjRLNtmzuAnX2LX2sT_XKIJ3U_xbf9Mb3WdIDGgCJ5i8gIKCl5VFCIJte8c-l8Xjvej82GnxdNaGyUHc2_81EjZbcPhRLwzuU2Q7YxKUjkrEIlkh0jyA9i8vc9pxvZaFd2COy-CbR93iDDSam93uhNPGD-cjX7AuptEbcenE1dJal-ZSqUPPNR-8JHk_25RW4KTiG-dz-3oSozny0zJxjFRoFi2VBG-s_l1yN_ZMq_kK9P80Q7zAeuxEulBSTpk1w3-nFF9iXOW0a3EnNc6NMfkhkqjy2OpgnUsy7n22GO8Dnb6bATLgquxK9oe1NuqzV8v2LI1)\n","type":"text/plain"},"url":{"path":["unique_address"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) The platform server will save the posted transaction and pass the `transaction_id` through this endpoint.\nIf the anchor wishes to return transaction-dependent unique_address, the anchor may query the [`GET /transactions` endpoint of the Platform API](/api/anchor-platform/resources/get-transaction).\n","type":"text/plain"},"key":"transaction_id","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 +--- + +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"; + +## Generate Unique Address + + + +If the platform is configured with `depositInfoGeneratorType: api`, the Platform make this request to +the Anchor backend every time a transaction is initiated by a client application. + +The Anchor must guarantee that the memo returned in this request is unique, so it can be mapped 1-to-1 to a Platform +resource such as a [SEP-31](https://stellar.org/protocol/sep-31) transaction. + +Here is how this flow would be used for Receiving Anchors that need to create their unique `(account, memo)` pairs +outside the platform, using Circle: + +[![](https://mermaid.ink/img/pako:eNqlVctu2zAQ_JUFTy1iOwhyE9AUhuu0ORQ1YvdmIKDJVUSYIlWSihEY_veuRMuPhHaTVCc9VjPD4exyzYSVyDLm8U-NRuA3xR8dL-cG6AoqaMxgOp70r69g5rjxXARlDdxqu4KVCgXM2VpwrRdcLIeTu81lbRQhPXApHXo_ZxGp4i4ooSpuAkwDas1d4gMaqcwjDI0obOL7p3sUqJ6o5DNMNA-5deX5qlNII-WExvj-mLV_c3OR4slg8ms6g7XH6vpqcxn2XvgIYyuCJSPgnB2w4B4lkIGhQKi22CCsydVj7XiDF-GaK6WD9KXlTfkTwoGsf8JcvDYqg-_j2dkFfD1geFDyS5plb2U0mnDRIC0PgcNCW7EUBVcGtqCDPUqs79Ov_ZS8ewy1Mx4MriAKo_z5mKdOYlZiaeeM9lu5wVl9L1n2Zn6Qh5IUb5KWn9y6W2WUL5DSUSvdZrFJx7brDgyPDdd8e4emU1L6x7nfrznNPTjRLNtmzuAnX2LX2sT_XKIJ3U_xbf9Mb3WdIDGgCJ5i8gIKCl5VFCIJte8c-l8Xjvej82GnxdNaGyUHc2_81EjZbcPhRLwzuU2Q7YxKUjkrEIlkh0jyA9i8vc9pxvZaFd2COy-CbR93iDDSam93uhNPGD-cjX7AuptEbcenE1dJal-ZSqUPPNR-8JHk_25RW4KTiG-dz-3oSozny0zJxjFRoFi2VBG-s_l1yN_ZMq_kK9P80Q7zAeuxEulBSTpk1w3-nFF9iXOW0a3EnNc6NMfkhkqjy2OpgnUsy7n22GO8Dnb6bATLgquxK9oe1NuqzV8v2LI1)](https://mermaid.live/edit#pako:eNqlVctu2zAQ_JUFTy1iOwhyE9AUhuu0ORQ1YvdmIKDJVUSYIlWSihEY_veuRMuPhHaTVCc9VjPD4exyzYSVyDLm8U-NRuA3xR8dL-cG6AoqaMxgOp70r69g5rjxXARlDdxqu4KVCgXM2VpwrRdcLIeTu81lbRQhPXApHXo_ZxGp4i4ooSpuAkwDas1d4gMaqcwjDI0obOL7p3sUqJ6o5DNMNA-5deX5qlNII-WExvj-mLV_c3OR4slg8ms6g7XH6vpqcxn2XvgIYyuCJSPgnB2w4B4lkIGhQKi22CCsydVj7XiDF-GaK6WD9KXlTfkTwoGsf8JcvDYqg-_j2dkFfD1geFDyS5plb2U0mnDRIC0PgcNCW7EUBVcGtqCDPUqs79Ov_ZS8ewy1Mx4MriAKo_z5mKdOYlZiaeeM9lu5wVl9L1n2Zn6Qh5IUb5KWn9y6W2WUL5DSUSvdZrFJx7brDgyPDdd8e4emU1L6x7nfrznNPTjRLNtmzuAnX2LX2sT_XKIJ3U_xbf9Mb3WdIDGgCJ5i8gIKCl5VFCIJte8c-l8Xjvej82GnxdNaGyUHc2_81EjZbcPhRLwzuU2Q7YxKUjkrEIlkh0jyA9i8vc9pxvZaFd2COy-CbR93iDDSam93uhNPGD-cjX7AuptEbcenE1dJal-ZSqUPPNR-8JHk_25RW4KTiG-dz-3oSozny0zJxjFRoFi2VBG-s_l1yN_ZMq_kK9P80Q7zAeuxEulBSTpk1w3-nFF9iXOW0a3EnNc6NMfkhkqjy2OpgnUsy7n22GO8Dnb6bATLgquxK9oe1NuqzV8v2LI1) + + +
Query Parameters
+ +Success. + +
Schema
    unique_address object
    + +An object containing the unique `stellar_address:memo` pair used to identify a destination. + +
+ +Error. The Platform will respond to the client application with the same response code and body. + +
Schema
diff --git a/ap_api/callbacks/get-customer.api.mdx b/api/anchor-platform/callbacks/get-customer.api.mdx similarity index 55% rename from ap_api/callbacks/get-customer.api.mdx rename to api/anchor-platform/callbacks/get-customer.api.mdx index d0ece5427..e50380e27 100644 --- a/ap_api/callbacks/get-customer.api.mdx +++ b/api/anchor-platform/callbacks/get-customer.api.mdx @@ -5,9 +5,9 @@ description: "The request and response for this endpoint is identical to the" sidebar_label: "Retrieve Customer's Info" hide_title: true hide_table_of_contents: true -api: {"description":"The request and response for this endpoint is identical to the \n[`GET /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-get) \nrequest and response defined in SEP-12.\n\nThis endpoint allows clients to:\n\n 1. Fetch the fields the server requires in order to register a new customer via a SEP-12 \n[`PUT /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-put) request\n\nIf the server does not have a customer registered for the parameters sent in the request, it should return the \nfields required in the response. The same response should be returned when no parameters are sent.\n\n 2. Check the status of a customer that may already be registered\n\nThis allows clients to check whether the customers information was accepted, rejected, or still needs more info. \nIf the server still needs more info, or the server needs updated information, it should return the fields required.\n","tags":["Customers","SEP-12","SEP-31"],"operationId":"getCustomer","parameters":[{"in":"query","name":"id","description":"The ID of the customer as returned in the response of a previous PUT request.","schema":{"type":"string"}},{"in":"query","name":"account","description":"The Stellar or Muxed Account authenticated with the Platform via SEP-10.","schema":{"type":"string"}},{"in":"query","name":"memo","description":"The memo value identifying a customer with a shared account, where the shared account is `account`.","schema":{"type":"string"}},{"in":"query","name":"memo_type","description":"The type of memo used to identify a customer with a shared account.","schema":{"type":"string","enum":["id","hash","text"]}},{"in":"query","name":"type","description":"The type of action the customer is being KYCd for. See the \n[Type Specification](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#type-specification)\ndocumented in SEP-12.\n","schema":{"type":"string"}},{"in":"query","name":"lang","description":"Defaults to `en`. Language code specified using ISO 639-1. Human readable descriptions, choices, and \nmessages should be in this language.\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Valid request. Customer either already exists or the customer identified by the parameters is new and must \nprovide the field values described in the response body. Response bodies are identical to the schema defined \nin [SEP-12](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-get).\n","content":{"application/json":{"schema":{"type":"object","required":["status"],"properties":{"id":{"type":"string"},"status":{"type":"string","enum":["ACCEPTED PROCESSING NEEDS_INFO REJECTED"]},"fields":{"type":"object","required":["type","description"],"properties":{"type":{"type":"string","enum":["string","binary","number","date"]},"description":{"type":"string"},"choices":{"type":"array","items":{"type":"string"}},"optional":{"type":"boolean"}}},"provided_fields":{"type":"object","required":["type","description"],"properties":{"type":{"type":"string","enum":["string","binary","number","date"]},"description":{"type":"string"},"choices":{"type":"array","items":{"type":"string"}},"optional":{"type":"boolean"},"status":{"type":"string","enum":["ACCEPTED","PROCESSING","REJECTED","VERIFICATION_REQUIRED"]},"error":{"type":"string"}}},"message":{"type":"string"}},"title":"GetCustomerResponse"},"examples":{"SuccessKYC":{"summary":"The case when a customer has been successfully KYC'd and approved","value":{"id":"d1ce2f48-3ff1-495d-9240-7a50d806cfed","status":"ACCEPTED","provided_fields":{"first_name":{"description":"The customer's first name","type":"string","status":"ACCEPTED"},"last_name":{"description":"The customer's last name","type":"string","status":"ACCEPTED"},"email_address":{"description":"The customer's email address","type":"string","status":"ACCEPTED"}}}}}}}},"400":{"description":"Error.","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":"get","path":"/customer","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 Customer's Info","description":{"content":"The request and response for this endpoint is identical to the \n[`GET /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-get) \nrequest and response defined in SEP-12.\n\nThis endpoint allows clients to:\n\n 1. Fetch the fields the server requires in order to register a new customer via a SEP-12 \n[`PUT /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-put) request\n\nIf the server does not have a customer registered for the parameters sent in the request, it should return the \nfields required in the response. The same response should be returned when no parameters are sent.\n\n 2. Check the status of a customer that may already be registered\n\nThis allows clients to check whether the customers information was accepted, rejected, or still needs more info. \nIf the server still needs more info, or the server needs updated information, it should return the fields required.\n","type":"text/plain"},"url":{"path":["customer"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The ID of the customer as returned in the response of a previous PUT request.","type":"text/plain"},"key":"id","value":""},{"disabled":false,"description":{"content":"The Stellar or Muxed Account authenticated with the Platform via SEP-10.","type":"text/plain"},"key":"account","value":""},{"disabled":false,"description":{"content":"The memo value identifying a customer with a shared account, where the shared account is `account`.","type":"text/plain"},"key":"memo","value":""},{"disabled":false,"description":{"content":"The type of memo used to identify a customer with a shared account.","type":"text/plain"},"key":"memo_type","value":""},{"disabled":false,"description":{"content":"The type of action the customer is being KYCd for. See the \n[Type Specification](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#type-specification)\ndocumented in SEP-12.\n","type":"text/plain"},"key":"type","value":""},{"disabled":false,"description":{"content":"Defaults to `en`. Language code specified using ISO 639-1. Human readable descriptions, choices, and \nmessages should be in this language.\n","type":"text/plain"},"key":"lang","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"description":"The request and response for this endpoint is identical to the\n[`GET /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-get)\nrequest and response defined in SEP-12.\n\nThis endpoint allows clients to:\n\n 1. Fetch the fields the server requires in order to register a new customer via a SEP-12\n[`PUT /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-put) request\n\nIf the server does not have a customer registered for the parameters sent in the request, it should return the\nfields required in the response. The same response should be returned when no parameters are sent.\n\n 2. Check the status of a customer that may already be registered\n\nThis allows clients to check whether the customers information was accepted, rejected, or still needs more info.\nIf the server still needs more info, or the server needs updated information, it should return the fields required.\n","tags":["Customers","SEP-12","SEP-31"],"operationId":"getCustomer","parameters":[{"in":"query","name":"id","description":"The ID of the customer as returned in the response of a previous PUT request.","schema":{"type":"string"}},{"in":"query","name":"account","description":"The Stellar or Muxed Account authenticated with the Platform via SEP-10.","schema":{"type":"string"}},{"in":"query","name":"memo","description":"The memo value identifying a customer with a shared account, where the shared account is `account`.","schema":{"type":"string"}},{"in":"query","name":"memo_type","description":"The type of memo used to identify a customer with a shared account.","schema":{"type":"string","enum":["id","hash","text"]}},{"in":"query","name":"type","description":"The type of action the customer is being KYCd for. See the\n[Type Specification](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#type-specification)\ndocumented in SEP-12.\n","schema":{"type":"string"}},{"in":"query","name":"lang","description":"Defaults to `en`. Language code specified using ISO 639-1. Human readable descriptions, choices, and\nmessages should be in this language.\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Valid request. Customer either already exists or the customer identified by the parameters is new and must\nprovide the field values described in the response body. Response bodies are identical to the schema defined\nin [SEP-12](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-get).\n","content":{"application/json":{"schema":{"type":"object","required":["status"],"properties":{"id":{"type":"string"},"status":{"type":"string","enum":["ACCEPTED PROCESSING NEEDS_INFO REJECTED"]},"fields":{"type":"object","required":["type","description"],"properties":{"type":{"type":"string","enum":["string","binary","number","date"]},"description":{"type":"string"},"choices":{"type":"array","items":{"type":"string"}},"optional":{"type":"boolean"}}},"provided_fields":{"type":"object","required":["type","description"],"properties":{"type":{"type":"string","enum":["string","binary","number","date"]},"description":{"type":"string"},"choices":{"type":"array","items":{"type":"string"}},"optional":{"type":"boolean"},"status":{"type":"string","enum":["ACCEPTED","PROCESSING","REJECTED","VERIFICATION_REQUIRED"]},"error":{"type":"string"}}},"message":{"type":"string"}},"title":"GetCustomerResponse"},"examples":{"SuccessKYC":{"summary":"The case when a customer has been successfully KYC'd and approved","value":{"id":"d1ce2f48-3ff1-495d-9240-7a50d806cfed","status":"ACCEPTED","provided_fields":{"first_name":{"description":"The customer's first name","type":"string","status":"ACCEPTED"},"last_name":{"description":"The customer's last name","type":"string","status":"ACCEPTED"},"email_address":{"description":"The customer's email address","type":"string","status":"ACCEPTED"}}}}}}}},"400":{"description":"Error.","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":"get","path":"/customer","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 Customer's Info","description":{"content":"The request and response for this endpoint is identical to the\n[`GET /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-get)\nrequest and response defined in SEP-12.\n\nThis endpoint allows clients to:\n\n 1. Fetch the fields the server requires in order to register a new customer via a SEP-12\n[`PUT /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-put) request\n\nIf the server does not have a customer registered for the parameters sent in the request, it should return the\nfields required in the response. The same response should be returned when no parameters are sent.\n\n 2. Check the status of a customer that may already be registered\n\nThis allows clients to check whether the customers information was accepted, rejected, or still needs more info.\nIf the server still needs more info, or the server needs updated information, it should return the fields required.\n","type":"text/plain"},"url":{"path":["customer"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The ID of the customer as returned in the response of a previous PUT request.","type":"text/plain"},"key":"id","value":""},{"disabled":false,"description":{"content":"The Stellar or Muxed Account authenticated with the Platform via SEP-10.","type":"text/plain"},"key":"account","value":""},{"disabled":false,"description":{"content":"The memo value identifying a customer with a shared account, where the shared account is `account`.","type":"text/plain"},"key":"memo","value":""},{"disabled":false,"description":{"content":"The type of memo used to identify a customer with a shared account.","type":"text/plain"},"key":"memo_type","value":""},{"disabled":false,"description":{"content":"The type of action the customer is being KYCd for. See the\n[Type Specification](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#type-specification)\ndocumented in SEP-12.\n","type":"text/plain"},"key":"type","value":""},{"disabled":false,"description":{"content":"Defaults to `en`. Language code specified using ISO 639-1. Human readable descriptions, choices, and\nmessages should be in this language.\n","type":"text/plain"},"key":"lang","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" -info_path: api/callbacks/synchronous-callbacks-api +info_path: api/anchor-platform/callbacks/synchronous-callbacks-api custom_edit_url: null --- @@ -28,28 +28,28 @@ import TabItem from "@theme/TabItem"; -The request and response for this endpoint is identical to the -[`GET /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-get) +The request and response for this endpoint is identical to the +[`GET /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-get) request and response defined in SEP-12. This endpoint allows clients to: - 1. Fetch the fields the server requires in order to register a new customer via a SEP-12 + 1. Fetch the fields the server requires in order to register a new customer via a SEP-12 [`PUT /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-put) request -If the server does not have a customer registered for the parameters sent in the request, it should return the +If the server does not have a customer registered for the parameters sent in the request, it should return the fields required in the response. The same response should be returned when no parameters are sent. 2. Check the status of a customer that may already be registered -This allows clients to check whether the customers information was accepted, rejected, or still needs more info. +This allows clients to check whether the customers information was accepted, rejected, or still needs more info. If the server still needs more info, or the server needs updated information, it should return the fields required. -
Query Parameters
+
Query Parameters
-Valid request. Customer either already exists or the customer identified by the parameters is new and must -provide the field values described in the response body. Response bodies are identical to the schema defined +Valid request. Customer either already exists or the customer identified by the parameters is new and must +provide the field values described in the response body. Response bodies are identical to the schema defined in [SEP-12](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-get). diff --git a/api/anchor-platform/callbacks/get-fee.api.mdx b/api/anchor-platform/callbacks/get-fee.api.mdx new file mode 100644 index 000000000..cc07b10d5 --- /dev/null +++ b/api/anchor-platform/callbacks/get-fee.api.mdx @@ -0,0 +1,60 @@ +--- +id: get-fee +title: "Retrieve Fees" +description: "The Platform will make this request to the anchor every time a transaction is initiated by a client application" +sidebar_label: "Retrieve Fees" +hide_title: true +hide_table_of_contents: true +api: {"description":"The Platform will make this request to the anchor every time a transaction is initiated by a client application\nwithout a `quote_id`.\n\nThe Anchor must ensure that the sending and receiving customers specified in the request meet the KYC requirements\nnecessary to partake in the transaction described in the request.\n\nThe anchor must return the fee it will charge for the transaction.\n\nIn the future, this endpoint may be used to provide estimated fees to client applications prior to initiating transactions.\nWhen this change is made, the request schema will be adapted to support the use case.\n","tags":["Fees","SEP-31"],"operationId":"getFee","parameters":[{"in":"query","name":"send_asset","description":"The asset the client application will send to the anchor in exchange for `receive_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":"receive_asset","description":"The asset the that the anchor will send in exchange for `send_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":"send_amount","description":"The amount of `send_asset` the client application will send in exchange for `receive_asset`. One of `send_amount`\nor `receive_amount` will always be included in the request. If the client application specified a `quote_id` in\nits transaction creation request, both amounts specified in the referenced quote will be passed.\n","schema":{"type":"string"}},{"in":"query","name":"receive_amount","description":"The amount of `receive_asset` the anchor will send in exchange for `send_asset`. One of `send_amount` or\n`receive_amount` will always be included in the request. If the client application specified a `quote_id` in its\ntransaction creation request, both amounts specified in the referenced quote will be passed.\n","schema":{"type":"string"}},{"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.\nA client ID it the Stellar account of a sending anchor: In SEP-31, the `client_id` should match the account of a known SEP-31 sending anchor match the one used to authenticate via SEP-10.\n","schema":{"type":"string"},"required":true},{"in":"query","name":"sender_id","description":"The SEP-12 customer ID of the sending user.\n","schema":{"type":"string"},"required":true},{"in":"query","name":"receiver_id","description":"The SEP-12 customer ID of the receiving user.\n","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"fee":{"type":"object","required":["amount","asset"],"properties":{"amount":{"type":"string"},"asset":{"type":"string"}},"title":"Amount"}},"title":"FeeResponse"}}}},"422":{"description":"Unprocessable Entity. This status should be returned when the anchor understood the request but cannot\nreturn a success response. An example for when this response code would be appropriate is if the sender\nand/or receiver is not permitted to initiate a transaction with the specified amounts. In these cases,\nthe Platform will respond to the client application's request with a `400 Bad Request` and include the\nerror 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":"/fee","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 Fees","description":{"content":"The Platform will make this request to the anchor every time a transaction is initiated by a client application\nwithout a `quote_id`.\n\nThe Anchor must ensure that the sending and receiving customers specified in the request meet the KYC requirements\nnecessary to partake in the transaction described in the request.\n\nThe anchor must return the fee it will charge for the transaction.\n\nIn the future, this endpoint may be used to provide estimated fees to client applications prior to initiating transactions.\nWhen this change is made, the request schema will be adapted to support the use case.\n","type":"text/plain"},"url":{"path":["fee"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) The asset the client application will send to the anchor in exchange for `receive_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":"send_asset","value":""},{"disabled":false,"description":{"content":"(Required) The asset the that the anchor will send in exchange for `send_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":"receive_asset","value":""},{"disabled":false,"description":{"content":"The amount of `send_asset` the client application will send in exchange for `receive_asset`. One of `send_amount`\nor `receive_amount` will always be included in the request. If the client application specified a `quote_id` in\nits transaction creation request, both amounts specified in the referenced quote will be passed.\n","type":"text/plain"},"key":"send_amount","value":""},{"disabled":false,"description":{"content":"The amount of `receive_asset` the anchor will send in exchange for `send_asset`. One of `send_amount` or\n`receive_amount` will always be included in the request. If the client application specified a `quote_id` in its\ntransaction creation request, both amounts specified in the referenced quote will be passed.\n","type":"text/plain"},"key":"receive_amount","value":""},{"disabled":false,"description":{"content":"(Required) An identifier for the client application making the request. This ID can be used to offer different fees to different clients.\nA client ID it the Stellar account of a sending anchor: In SEP-31, the `client_id` should match the account of a known SEP-31 sending anchor match the one used to authenticate via SEP-10.\n","type":"text/plain"},"key":"client_id","value":""},{"disabled":false,"description":{"content":"(Required) The SEP-12 customer ID of the sending user.\n","type":"text/plain"},"key":"sender_id","value":""},{"disabled":false,"description":{"content":"(Required) The SEP-12 customer ID of the receiving user.\n","type":"text/plain"},"key":"receiver_id","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 +--- + +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"; + +## Retrieve Fees + + + +The Platform will make this request to the anchor every time a transaction is initiated by a client application +without a `quote_id`. + +The Anchor must ensure that the sending and receiving customers specified in the request meet the KYC requirements +necessary to partake in the transaction described in the request. + +The anchor must return the fee it will charge for the transaction. + +In the future, this endpoint may be used to provide estimated fees to client applications prior to initiating transactions. +When this change is made, the request schema will be adapted to support the use case. + + +
Query Parameters
+ +Success. + +
Schema
    fee object
+ +Unprocessable Entity. This status should be returned when the anchor understood the request but cannot +return a success response. An example for when this response code would be appropriate is if the sender +and/or receiver is not permitted to initiate a transaction with the specified amounts. In these cases, +the Platform will respond to the client application's request with a `400 Bad Request` and include the +error message provided by the anchor in the response body. + + +
Schema
+ +Error. The Platform will respond to the client application with the same response code and body. + +
Schema
diff --git a/api/anchor-platform/callbacks/get-rates.api.mdx b/api/anchor-platform/callbacks/get-rates.api.mdx new file mode 100644 index 000000000..0999cd6cc --- /dev/null +++ b/api/anchor-platform/callbacks/get-rates.api.mdx @@ -0,0 +1,67 @@ +--- +id: get-rates +title: "Retrieve Rates" +description: "Transactions that involve two non-equivalent on & off-chain assets (such as USDC on Stellar and fiat EUR) must" +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"}} +sidebar_class_name: "get 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"; + +## Retrieve Rates + + + +Transactions that involve two non-equivalent on & off-chain assets (such as USDC on Stellar and fiat EUR) must +use exchange rates that are communicated to the client application requesting the transaction. When clients make +requests to the Platform for these exchange rates, the Platform sends this request to the anchor to fetch it. + +Rates can be [indicative](https://www.investopedia.com/terms/i/indicativequote.asp) or +[firm](https://www.investopedia.com/terms/f/firmquote.asp). The anchor must provide an ID and expiration if the +client requests a firm rate. + +Anchors can provide discounted rates specific client applications. The Platform includes the `client_id` parameter +for this reason. + +Either `sell_amount` or `buy_amount` will be included in requests as parameters, but never both. In the same way, +either `sell_delivery_method` and `buy_delivery_method` may be included in requests, but never both, since either +`sell_asset` or `buy_asset` is a Stellar asset. + + +
Query Parameters
+ +Success. + +
Schema
    rate object
    fee object
    + +An object describing the fees added on top of the rate provided via the `price` attribute. + +
    details object[]
  • Array [
  • ]
+ +Unprocessable Entity. This status should be returned when the anchor understood the request but cannot +return a success response. +In these cases, the Platform will respond to the client application's request with a `400 Bad Request` +and include the error message provided by the anchor in the response body. + + +
Schema
+ +Error. The Platform will respond to the client application with the same response code and body. + +
Schema
diff --git a/ap_api/callbacks/index.mdx b/api/anchor-platform/callbacks/index.mdx similarity index 100% rename from ap_api/callbacks/index.mdx rename to api/anchor-platform/callbacks/index.mdx diff --git a/ap_api/callbacks/put-customer.api.mdx b/api/anchor-platform/callbacks/put-customer.api.mdx similarity index 67% rename from ap_api/callbacks/put-customer.api.mdx rename to api/anchor-platform/callbacks/put-customer.api.mdx index f7ceea15f..ae14e2391 100644 --- a/ap_api/callbacks/put-customer.api.mdx +++ b/api/anchor-platform/callbacks/put-customer.api.mdx @@ -5,9 +5,9 @@ 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-06-15","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-06-15","id_expiration_date":"2023-06-15","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-06-30","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-06-30","id_expiration_date":"2023-06-30","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/callbacks/synchronous-callbacks-api +info_path: api/anchor-platform/callbacks/synchronous-callbacks-api custom_edit_url: null --- @@ -30,11 +30,11 @@ import TabItem from "@theme/TabItem"; **The Anchor Platform does not persist any customer KYC data.** -The request and response for this endpoint are identical to the -[`PUT /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-put) +The request and response for this endpoint are identical to the +[`PUT /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-put) request and response defined in SEP-12. -Client applications make requests with the following request body, which is forwarded to the anchor. Anchors +Client applications make requests with the following request body, which is forwarded to the anchor. Anchors must validate and persist the data passed, and return the customer's `id`. diff --git a/ap_api/callbacks/rate/index.mdx b/api/anchor-platform/callbacks/rate/index.mdx similarity index 100% rename from ap_api/callbacks/rate/index.mdx rename to api/anchor-platform/callbacks/rate/index.mdx diff --git a/api/anchor-platform/callbacks/sidebar.js b/api/anchor-platform/callbacks/sidebar.js new file mode 100644 index 000000000..2894c64a4 --- /dev/null +++ b/api/anchor-platform/callbacks/sidebar.js @@ -0,0 +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 diff --git a/ap_api/callbacks/unique-address/index.mdx b/api/anchor-platform/callbacks/unique-address/index.mdx similarity index 100% rename from ap_api/callbacks/unique-address/index.mdx rename to api/anchor-platform/callbacks/unique-address/index.mdx diff --git a/ap_api/introduction/_category_.json b/api/anchor-platform/introduction/_category_.json similarity index 100% rename from ap_api/introduction/_category_.json rename to api/anchor-platform/introduction/_category_.json diff --git a/ap_api/introduction/index.mdx b/api/anchor-platform/introduction/index.mdx similarity index 97% rename from ap_api/introduction/index.mdx rename to api/anchor-platform/introduction/index.mdx index 4c5c0d07b..b8ddcb54e 100644 --- a/ap_api/introduction/index.mdx +++ b/api/anchor-platform/introduction/index.mdx @@ -1,7 +1,7 @@ --- title: Anchor Platform API Reference sidebar_position: 10 -slug: / +slug: /anchor-platform --- The Anchor Platform is a set of tools and APIs that enable developers and businesses to build their own on and off-ramp services for the Stellar network. It provides a standardized interface, including the implementation of several Stellar Ecosystem Proposals (SEPs), to make it easy for businesses to integrate with Stellar-based wallets and exchanges. diff --git a/ap_api/resources/_category_.json b/api/anchor-platform/resources/_category_.json similarity index 100% rename from ap_api/resources/_category_.json rename to api/anchor-platform/resources/_category_.json diff --git a/ap_api/resources/get-transaction.api.mdx b/api/anchor-platform/resources/get-transaction.api.mdx similarity index 98% rename from ap_api/resources/get-transaction.api.mdx rename to api/anchor-platform/resources/get-transaction.api.mdx index 85e53f17f..74b55f5e0 100644 --- a/ap_api/resources/get-transaction.api.mdx +++ b/api/anchor-platform/resources/get-transaction.api.mdx @@ -7,7 +7,7 @@ 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"}} sidebar_class_name: "get api-method" -info_path: api/resources/platform-api +info_path: api/anchor-platform/resources/platform-api custom_edit_url: null --- @@ -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/ap_api/resources/get-transactions.api.mdx b/api/anchor-platform/resources/get-transactions.api.mdx similarity index 99% rename from ap_api/resources/get-transactions.api.mdx rename to api/anchor-platform/resources/get-transactions.api.mdx index 97b127c80..1ac21a159 100644 --- a/ap_api/resources/get-transactions.api.mdx +++ b/api/anchor-platform/resources/get-transactions.api.mdx @@ -7,7 +7,7 @@ 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"}} sidebar_class_name: "get api-method" -info_path: api/resources/platform-api +info_path: api/anchor-platform/resources/platform-api custom_edit_url: null --- @@ -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/ap_api/resources/index.mdx b/api/anchor-platform/resources/index.mdx similarity index 100% rename from ap_api/resources/index.mdx rename to api/anchor-platform/resources/index.mdx diff --git a/ap_api/resources/patch-transactions.api.mdx b/api/anchor-platform/resources/patch-transactions.api.mdx similarity index 98% rename from ap_api/resources/patch-transactions.api.mdx rename to api/anchor-platform/resources/patch-transactions.api.mdx index c361100b8..0add52d38 100644 --- a/ap_api/resources/patch-transactions.api.mdx +++ b/api/anchor-platform/resources/patch-transactions.api.mdx @@ -5,9 +5,9 @@ description: "Accepts one or more objects containing updated information on tran sidebar_label: "Update Transactions Info" hide_title: true hide_table_of_contents: true -api: {"tags":["Transactions","SEP-24","SEP-31"],"operationId":"patchTransactions","description":"Accepts one or more objects containing updated information on transactions. Note that requests containing invalid data for any transaction will result in a 400 Bad Request and no transactions will be updated. Importantly, this operation is NOT atomic. If one update fails, all previous updates would be applied, all subsequent updates would be discarded, and an error would be raised.","responses":{"200":{"description":"Transaction(s) updated.","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":"Invalid request body. The error returned pertains to the transaction first determined to be invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"id":{"type":"string","description":"The `id` of the transaction first determined to be invalid."}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"transaction":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"sep":{"type":"string","enum":["24"]},"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_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"},"external_transaction_id":{"type":"string"},"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"}},"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"},"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"}},"title":"MutableTransactionSEP24"}}}}},"title":"PatchTransactionSEP24"},{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"transaction":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"sep":{"type":"string","enum":["31"]},"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_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"},"external_transaction_id":{"type":"string"},"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"}},"message":{"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"},"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"}},"title":"MutableTransactionSEP31"}}}}},"title":"PatchTransactionSEP31"}]}}}},"method":"patch","path":"/transactions","jsonRequestBodyExample":{"records":[{"transaction":{"id":"string","sep":"24","status":"incomplete","amount_in":{"amount":"string","asset":"string"},"amount_out":{"amount":"string","asset":"string"},"amount_fee":{"amount":"string","asset":"string"},"started_at":"2023-06-15T21:06:05.618Z","updated_at":"2023-06-15T21:06:05.618Z","completed_at":"2023-06-15T21:06:05.618Z","transfer_received_at":"2023-06-15T21:06:05.618Z","external_transaction_id":"string","stellar_transactions":[{"id":"string","memo":"string","memo_type":"text","created_at":"2023-06-15T21:06:05.619Z","envelope":"string","payments":[{"id":"string","payment_type":"payment","source_account":"string","destination_account":"string","amount":{"amount":"string","asset":"string"}}]}],"memo":"string","memo_type":"text id hash","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-06-15T21:06:05.619Z","refunded_at":"2023-06-15T21:06:05.619Z"}]}}}]},"info":{"version":"2.0.0","title":"Platform API"},"postman":{"name":"Update Transactions Info","description":{"content":"Accepts one or more objects containing updated information on transactions. Note that requests containing invalid data for any transaction will result in a 400 Bad Request and no transactions will be updated. Importantly, this operation is NOT atomic. If one update fails, all previous updates would be applied, all subsequent updates would be discarded, and an error would be raised.","type":"text/plain"},"url":{"path":["transactions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"tags":["Transactions","SEP-24","SEP-31"],"operationId":"patchTransactions","description":"Accepts one or more objects containing updated information on transactions. Note that requests containing invalid data for any transaction will result in a 400 Bad Request and no transactions will be updated. Importantly, this operation is NOT atomic. If one update fails, all previous updates would be applied, all subsequent updates would be discarded, and an error would be raised.","responses":{"200":{"description":"Transaction(s) updated.","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":"Invalid request body. The error returned pertains to the transaction first determined to be invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"id":{"type":"string","description":"The `id` of the transaction first determined to be invalid."}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"transaction":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"sep":{"type":"string","enum":["24"]},"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_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"},"external_transaction_id":{"type":"string"},"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"}},"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"},"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"}},"title":"MutableTransactionSEP24"}}}}},"title":"PatchTransactionSEP24"},{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"transaction":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"sep":{"type":"string","enum":["31"]},"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_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"},"external_transaction_id":{"type":"string"},"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"}},"message":{"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"},"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"}},"title":"MutableTransactionSEP31"}}}}},"title":"PatchTransactionSEP31"}]}}}},"method":"patch","path":"/transactions","jsonRequestBodyExample":{"records":[{"transaction":{"id":"string","sep":"24","status":"incomplete","amount_in":{"amount":"string","asset":"string"},"amount_out":{"amount":"string","asset":"string"},"amount_fee":{"amount":"string","asset":"string"},"started_at":"2023-06-30T17:21:24.043Z","updated_at":"2023-06-30T17:21:24.043Z","completed_at":"2023-06-30T17:21:24.043Z","transfer_received_at":"2023-06-30T17:21:24.043Z","external_transaction_id":"string","stellar_transactions":[{"id":"string","memo":"string","memo_type":"text","created_at":"2023-06-30T17:21:24.043Z","envelope":"string","payments":[{"id":"string","payment_type":"payment","source_account":"string","destination_account":"string","amount":{"amount":"string","asset":"string"}}]}],"memo":"string","memo_type":"text id hash","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-06-30T17:21:24.043Z","refunded_at":"2023-06-30T17:21:24.043Z"}]}}}]},"info":{"version":"2.0.0","title":"Platform API"},"postman":{"name":"Update Transactions Info","description":{"content":"Accepts one or more objects containing updated information on transactions. Note that requests containing invalid data for any transaction will result in a 400 Bad Request and no transactions will be updated. Importantly, this operation is NOT atomic. If one update fails, all previous updates would be applied, all subsequent updates would be discarded, and an error would be raised.","type":"text/plain"},"url":{"path":["transactions"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "patch api-method" -info_path: api/resources/platform-api +info_path: api/anchor-platform/resources/platform-api custom_edit_url: null --- @@ -100,7 +100,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. -
  • ]
    • +
  • ]
    • Invalid request body. The error returned pertains to the transaction first determined to be invalid. diff --git a/api/anchor-platform/resources/sidebar.js b/api/anchor-platform/resources/sidebar.js new file mode 100644 index 000000000..0d3ff151c --- /dev/null +++ b/api/anchor-platform/resources/sidebar.js @@ -0,0 +1 @@ +module.exports = [{"type":"doc","id":"anchor-platform/resources/platform-api"},{"type":"category","label":"Transactions","link":{"type":"generated-index","title":"Transactions","slug":"/category/anchor-platform/resources/transactions"},"items":[{"type":"doc","id":"anchor-platform/resources/patch-transactions","label":"Update Transactions Info","className":"api-method patch"},{"type":"doc","id":"anchor-platform/resources/get-transactions","label":"Retrieve a List of Transactions","className":"api-method get"},{"type":"doc","id":"anchor-platform/resources/get-transaction","label":"Retrieve a Transaction","className":"api-method get"}]},{"type":"category","label":"SEP-24","link":{"type":"generated-index","title":"SEP-24","slug":"/category/anchor-platform/resources/sep-24"},"items":[{"type":"doc","id":"anchor-platform/resources/patch-transactions","label":"Update Transactions Info","className":"api-method patch"},{"type":"doc","id":"anchor-platform/resources/get-transactions","label":"Retrieve a List of Transactions","className":"api-method get"},{"type":"doc","id":"anchor-platform/resources/get-transaction","label":"Retrieve a Transaction","className":"api-method get"}]},{"type":"category","label":"SEP-31","link":{"type":"generated-index","title":"SEP-31","slug":"/category/anchor-platform/resources/sep-31"},"items":[{"type":"doc","id":"anchor-platform/resources/patch-transactions","label":"Update Transactions Info","className":"api-method patch"},{"type":"doc","id":"anchor-platform/resources/get-transactions","label":"Retrieve a List of Transactions","className":"api-method get"},{"type":"doc","id":"anchor-platform/resources/get-transaction","label":"Retrieve a Transaction","className":"api-method get"}]}]; \ No newline at end of file diff --git a/ap_api/resources/transactions/index.mdx b/api/anchor-platform/resources/transactions/index.mdx similarity index 86% rename from ap_api/resources/transactions/index.mdx rename to api/anchor-platform/resources/transactions/index.mdx index 396a5f12b..5d586fc1c 100644 --- a/ap_api/resources/transactions/index.mdx +++ b/api/anchor-platform/resources/transactions/index.mdx @@ -7,7 +7,7 @@ import {EndpointsTable} from "@site/src/components/EndpointsTable"; Transactions are representations of a SEP transaction. It holds information about the protocol being used, and all necessary information passed by an external party (such as wallet or an anchor). -Should not be confused with stellar [transactions](../../../docs/glossary/#transaction). +Should not be confused with stellar [transactions](/docs/glossary/#transaction). diff --git a/api/aggregations/_category_.json b/api/horizon/aggregations/_category_.json similarity index 100% rename from api/aggregations/_category_.json rename to api/horizon/aggregations/_category_.json diff --git a/api/aggregations/fee-stats/_category_.json b/api/horizon/aggregations/fee-stats/_category_.json similarity index 100% rename from api/aggregations/fee-stats/_category_.json rename to api/horizon/aggregations/fee-stats/_category_.json diff --git a/api/aggregations/fee-stats/index.mdx b/api/horizon/aggregations/fee-stats/index.mdx similarity index 100% rename from api/aggregations/fee-stats/index.mdx rename to api/horizon/aggregations/fee-stats/index.mdx diff --git a/api/aggregations/fee-stats/object.mdx b/api/horizon/aggregations/fee-stats/object.mdx similarity index 100% rename from api/aggregations/fee-stats/object.mdx rename to api/horizon/aggregations/fee-stats/object.mdx diff --git a/api/aggregations/fee-stats/single.mdx b/api/horizon/aggregations/fee-stats/single.mdx similarity index 100% rename from api/aggregations/fee-stats/single.mdx rename to api/horizon/aggregations/fee-stats/single.mdx diff --git a/api/aggregations/index.mdx b/api/horizon/aggregations/index.mdx similarity index 100% rename from api/aggregations/index.mdx rename to api/horizon/aggregations/index.mdx diff --git a/api/aggregations/order-books/_category_.json b/api/horizon/aggregations/order-books/_category_.json similarity index 100% rename from api/aggregations/order-books/_category_.json rename to api/horizon/aggregations/order-books/_category_.json diff --git a/api/aggregations/order-books/index.mdx b/api/horizon/aggregations/order-books/index.mdx similarity index 81% rename from api/aggregations/order-books/index.mdx rename to api/horizon/aggregations/order-books/index.mdx index 44a6e5097..b64b0334d 100644 --- a/api/aggregations/order-books/index.mdx +++ b/api/horizon/aggregations/order-books/index.mdx @@ -7,7 +7,7 @@ import { EndpointsTable } from "@site/src/components/EndpointsTable"; An order book is a collections of offers for a specific pair of assets. -Learn more about [order books](../../../docs/glossary/#decentralized-exchange). +Learn more about [order books](/docs/glossary/#decentralized-exchange). diff --git a/api/aggregations/order-books/object.mdx b/api/horizon/aggregations/order-books/object.mdx similarity index 100% rename from api/aggregations/order-books/object.mdx rename to api/horizon/aggregations/order-books/object.mdx diff --git a/api/aggregations/order-books/single.mdx b/api/horizon/aggregations/order-books/single.mdx similarity index 100% rename from api/aggregations/order-books/single.mdx rename to api/horizon/aggregations/order-books/single.mdx diff --git a/api/aggregations/paths/_category_.json b/api/horizon/aggregations/paths/_category_.json similarity index 100% rename from api/aggregations/paths/_category_.json rename to api/horizon/aggregations/paths/_category_.json diff --git a/api/aggregations/paths/index.mdx b/api/horizon/aggregations/paths/index.mdx similarity index 72% rename from api/aggregations/paths/index.mdx rename to api/horizon/aggregations/paths/index.mdx index 4b7c5afa5..b2b1936c6 100644 --- a/api/aggregations/paths/index.mdx +++ b/api/horizon/aggregations/paths/index.mdx @@ -7,7 +7,7 @@ import { EndpointsTable } from "@site/src/components/EndpointsTable"; Paths provide information about potential path payments. A path can be used to populate the necessary fields for a path payment operation. -Learn more about the two types of path payment: [`path payment strict send`](../../../docs/fundamentals-and-concepts/list-of-operations#path-payment-strict-send) and [`path payment strict receive`](../../../docs/fundamentals-and-concepts/list-of-operations#path-payment-strict-receive) +Learn more about the two types of path payment: [`path payment strict send`](/docs/fundamentals-and-concepts/list-of-operations#path-payment-strict-send) and [`path payment strict receive`](/docs/fundamentals-and-concepts/list-of-operations#path-payment-strict-receive) diff --git a/api/aggregations/paths/object.mdx b/api/horizon/aggregations/paths/object.mdx similarity index 100% rename from api/aggregations/paths/object.mdx rename to api/horizon/aggregations/paths/object.mdx diff --git a/api/aggregations/paths/strict-receive.mdx b/api/horizon/aggregations/paths/strict-receive.mdx similarity index 100% rename from api/aggregations/paths/strict-receive.mdx rename to api/horizon/aggregations/paths/strict-receive.mdx diff --git a/api/aggregations/paths/strict-send.mdx b/api/horizon/aggregations/paths/strict-send.mdx similarity index 100% rename from api/aggregations/paths/strict-send.mdx rename to api/horizon/aggregations/paths/strict-send.mdx diff --git a/api/aggregations/trade-aggregations/_category_.json b/api/horizon/aggregations/trade-aggregations/_category_.json similarity index 100% rename from api/aggregations/trade-aggregations/_category_.json rename to api/horizon/aggregations/trade-aggregations/_category_.json diff --git a/api/aggregations/trade-aggregations/index.mdx b/api/horizon/aggregations/trade-aggregations/index.mdx similarity index 100% rename from api/aggregations/trade-aggregations/index.mdx rename to api/horizon/aggregations/trade-aggregations/index.mdx diff --git a/api/aggregations/trade-aggregations/list.mdx b/api/horizon/aggregations/trade-aggregations/list.mdx similarity index 100% rename from api/aggregations/trade-aggregations/list.mdx rename to api/horizon/aggregations/trade-aggregations/list.mdx diff --git a/api/aggregations/trade-aggregations/object.mdx b/api/horizon/aggregations/trade-aggregations/object.mdx similarity index 100% rename from api/aggregations/trade-aggregations/object.mdx rename to api/horizon/aggregations/trade-aggregations/object.mdx diff --git a/api/errors/_category_.json b/api/horizon/errors/_category_.json similarity index 100% rename from api/errors/_category_.json rename to api/horizon/errors/_category_.json diff --git a/api/errors/http-status-codes/_category_.json b/api/horizon/errors/http-status-codes/_category_.json similarity index 100% rename from api/errors/http-status-codes/_category_.json rename to api/horizon/errors/http-status-codes/_category_.json diff --git a/api/errors/http-status-codes/horizon-specific/before-history.mdx b/api/horizon/errors/http-status-codes/horizon-specific/before-history.mdx similarity index 100% rename from api/errors/http-status-codes/horizon-specific/before-history.mdx rename to api/horizon/errors/http-status-codes/horizon-specific/before-history.mdx diff --git a/api/errors/http-status-codes/horizon-specific/index.mdx b/api/horizon/errors/http-status-codes/horizon-specific/index.mdx similarity index 100% rename from api/errors/http-status-codes/horizon-specific/index.mdx rename to api/horizon/errors/http-status-codes/horizon-specific/index.mdx diff --git a/api/errors/http-status-codes/horizon-specific/stale-history.mdx b/api/horizon/errors/http-status-codes/horizon-specific/stale-history.mdx similarity index 100% rename from api/errors/http-status-codes/horizon-specific/stale-history.mdx rename to api/horizon/errors/http-status-codes/horizon-specific/stale-history.mdx diff --git a/api/errors/http-status-codes/horizon-specific/timeout.mdx b/api/horizon/errors/http-status-codes/horizon-specific/timeout.mdx similarity index 100% rename from api/errors/http-status-codes/horizon-specific/timeout.mdx rename to api/horizon/errors/http-status-codes/horizon-specific/timeout.mdx diff --git a/api/errors/http-status-codes/horizon-specific/transaction-failed.mdx b/api/horizon/errors/http-status-codes/horizon-specific/transaction-failed.mdx similarity index 100% rename from api/errors/http-status-codes/horizon-specific/transaction-failed.mdx rename to api/horizon/errors/http-status-codes/horizon-specific/transaction-failed.mdx diff --git a/api/errors/http-status-codes/horizon-specific/transaction-malformed.mdx b/api/horizon/errors/http-status-codes/horizon-specific/transaction-malformed.mdx similarity index 100% rename from api/errors/http-status-codes/horizon-specific/transaction-malformed.mdx rename to api/horizon/errors/http-status-codes/horizon-specific/transaction-malformed.mdx diff --git a/api/errors/http-status-codes/index.mdx b/api/horizon/errors/http-status-codes/index.mdx similarity index 100% rename from api/errors/http-status-codes/index.mdx rename to api/horizon/errors/http-status-codes/index.mdx diff --git a/api/errors/http-status-codes/standard.mdx b/api/horizon/errors/http-status-codes/standard.mdx similarity index 100% rename from api/errors/http-status-codes/standard.mdx rename to api/horizon/errors/http-status-codes/standard.mdx diff --git a/api/errors/index.mdx b/api/horizon/errors/index.mdx similarity index 100% rename from api/errors/index.mdx rename to api/horizon/errors/index.mdx diff --git a/api/errors/response.mdx b/api/horizon/errors/response.mdx similarity index 100% rename from api/errors/response.mdx rename to api/horizon/errors/response.mdx diff --git a/api/errors/result-codes/_category_.json b/api/horizon/errors/result-codes/_category_.json similarity index 100% rename from api/errors/result-codes/_category_.json rename to api/horizon/errors/result-codes/_category_.json diff --git a/api/errors/result-codes/index.mdx b/api/horizon/errors/result-codes/index.mdx similarity index 100% rename from api/errors/result-codes/index.mdx rename to api/horizon/errors/result-codes/index.mdx diff --git a/api/errors/result-codes/operation-specific/account-merge.mdx b/api/horizon/errors/result-codes/operation-specific/account-merge.mdx similarity index 90% rename from api/errors/result-codes/operation-specific/account-merge.mdx rename to api/horizon/errors/result-codes/operation-specific/account-merge.mdx index 438cb9d69..da69e3116 100644 --- a/api/errors/result-codes/operation-specific/account-merge.mdx +++ b/api/horizon/errors/result-codes/operation-specific/account-merge.mdx @@ -8,7 +8,7 @@ import { AttributeTable } from "@site/src/components/AttributeTable"; These are result codes that communicate success (200) or failure (400) specific to the `Account Merge` operation. -Learn more about the [`Account Merge` operation](../../../../docs/fundamentals-and-concepts/list-of-operations#account-merge). +Learn more about the [`Account Merge` operation](/docs/fundamentals-and-concepts/list-of-operations#account-merge). diff --git a/api/errors/result-codes/operation-specific/allow-trust.mdx b/api/horizon/errors/result-codes/operation-specific/allow-trust.mdx similarity index 91% rename from api/errors/result-codes/operation-specific/allow-trust.mdx rename to api/horizon/errors/result-codes/operation-specific/allow-trust.mdx index d1b5858dd..447770ad9 100644 --- a/api/errors/result-codes/operation-specific/allow-trust.mdx +++ b/api/horizon/errors/result-codes/operation-specific/allow-trust.mdx @@ -8,7 +8,7 @@ import { AttributeTable } from "@site/src/components/AttributeTable"; These are result codes that communicate success (200) or failure (400) specific to the `Allow Trust` operation. -Learn more about the [`Allow Trust` operation](../../../../docs/fundamentals-and-concepts/list-of-operations#allow-trust). +Learn more about the [`Allow Trust` operation](/docs/fundamentals-and-concepts/list-of-operations#allow-trust). diff --git a/api/errors/result-codes/operation-specific/bump-sequence.mdx b/api/horizon/errors/result-codes/operation-specific/bump-sequence.mdx similarity index 83% rename from api/errors/result-codes/operation-specific/bump-sequence.mdx rename to api/horizon/errors/result-codes/operation-specific/bump-sequence.mdx index 01025a72a..a6f8b7fe7 100644 --- a/api/errors/result-codes/operation-specific/bump-sequence.mdx +++ b/api/horizon/errors/result-codes/operation-specific/bump-sequence.mdx @@ -8,7 +8,7 @@ import { AttributeTable } from "@site/src/components/AttributeTable"; These are result codes that communicate success (200) or failure (400) specific to the `Bump Sequence` operation. -Learn more about the [`Bump Sequence` operation](../../../../docs/fundamentals-and-concepts/list-of-operations#bump-sequence). +Learn more about the [`Bump Sequence` operation](/docs/fundamentals-and-concepts/list-of-operations#bump-sequence). diff --git a/api/errors/result-codes/operation-specific/category.json b/api/horizon/errors/result-codes/operation-specific/category.json similarity index 100% rename from api/errors/result-codes/operation-specific/category.json rename to api/horizon/errors/result-codes/operation-specific/category.json diff --git a/api/errors/result-codes/operation-specific/change-trust.mdx b/api/horizon/errors/result-codes/operation-specific/change-trust.mdx similarity index 90% rename from api/errors/result-codes/operation-specific/change-trust.mdx rename to api/horizon/errors/result-codes/operation-specific/change-trust.mdx index 734b7a79c..d2e8eae59 100644 --- a/api/errors/result-codes/operation-specific/change-trust.mdx +++ b/api/horizon/errors/result-codes/operation-specific/change-trust.mdx @@ -8,7 +8,7 @@ import { AttributeTable } from "@site/src/components/AttributeTable"; These are result codes that communicate success (200) or failure (400) specific to the `Change Trust` operation. -Learn more about the [`Change Trust` operation](../../../../docs/fundamentals-and-concepts/list-of-operations#change-trust) +Learn more about the [`Change Trust` operation](/docs/fundamentals-and-concepts/list-of-operations#change-trust) diff --git a/api/errors/result-codes/operation-specific/create-account.mdx b/api/horizon/errors/result-codes/operation-specific/create-account.mdx similarity index 89% rename from api/errors/result-codes/operation-specific/create-account.mdx rename to api/horizon/errors/result-codes/operation-specific/create-account.mdx index 193f1ae02..6d5c7e24f 100644 --- a/api/errors/result-codes/operation-specific/create-account.mdx +++ b/api/horizon/errors/result-codes/operation-specific/create-account.mdx @@ -8,7 +8,7 @@ import { AttributeTable } from "@site/src/components/AttributeTable"; These are result codes that communicate success (200) or failure (400) specific to the `Create Account` operation, which often fails because the new account does not meet the minimum reserve. -Learn more about the [`Create Account` operation](../../../../docs/fundamentals-and-concepts/list-of-operations#create-account). +Learn more about the [`Create Account` operation](/docs/fundamentals-and-concepts/list-of-operations#create-account). diff --git a/api/errors/result-codes/operation-specific/create-passive-sell-offer.mdx b/api/horizon/errors/result-codes/operation-specific/create-passive-sell-offer.mdx similarity index 94% rename from api/errors/result-codes/operation-specific/create-passive-sell-offer.mdx rename to api/horizon/errors/result-codes/operation-specific/create-passive-sell-offer.mdx index e0eab7fd9..855a4ea2b 100644 --- a/api/errors/result-codes/operation-specific/create-passive-sell-offer.mdx +++ b/api/horizon/errors/result-codes/operation-specific/create-passive-sell-offer.mdx @@ -8,7 +8,7 @@ import { AttributeTable } from "@site/src/components/AttributeTable"; These are result codes that communicate success (200) or failure (400) specific to the `Create Passive Sell Offer` operation. -Learn more about the [`Create Passive Sell Offer` operation](../../../../docs/fundamentals-and-concepts/list-of-operations#create-passive-sell-offer). +Learn more about the [`Create Passive Sell Offer` operation](/docs/fundamentals-and-concepts/list-of-operations#create-passive-sell-offer). diff --git a/api/errors/result-codes/operation-specific/index.mdx b/api/horizon/errors/result-codes/operation-specific/index.mdx similarity index 89% rename from api/errors/result-codes/operation-specific/index.mdx rename to api/horizon/errors/result-codes/operation-specific/index.mdx index 37a5ab963..eb13da3dc 100644 --- a/api/errors/result-codes/operation-specific/index.mdx +++ b/api/horizon/errors/result-codes/operation-specific/index.mdx @@ -29,4 +29,4 @@ Each of Stellar's operations have unique causes of failure, and these result cod -For operations that aren't in this list, you can usually refer to their corresponding entries in the [List of Operations](../../../../docs/fundamentals-and-concepts/list-of-operations) which will enumerate the failure cases and corresponding result codes. +For operations that aren't in this list, you can usually refer to their corresponding entries in the [List of Operations](/docs/fundamentals-and-concepts/list-of-operations) which will enumerate the failure cases and corresponding result codes. diff --git a/api/errors/result-codes/operation-specific/manage-buy-offer.mdx b/api/horizon/errors/result-codes/operation-specific/manage-buy-offer.mdx similarity index 94% rename from api/errors/result-codes/operation-specific/manage-buy-offer.mdx rename to api/horizon/errors/result-codes/operation-specific/manage-buy-offer.mdx index fb0237f27..e5f06676e 100644 --- a/api/errors/result-codes/operation-specific/manage-buy-offer.mdx +++ b/api/horizon/errors/result-codes/operation-specific/manage-buy-offer.mdx @@ -8,7 +8,7 @@ import { AttributeTable } from "@site/src/components/AttributeTable"; These are result codes that communicate success (200) or failure (400) specific to the `Manage Buy Offer` operation. -Learn more about the [`Manage Buy Offer` operation](../../../../docs/fundamentals-and-concepts/list-of-operations#manage-buy-offer). +Learn more about the [`Manage Buy Offer` operation](/docs/fundamentals-and-concepts/list-of-operations#manage-buy-offer). diff --git a/api/errors/result-codes/operation-specific/manage-data.mdx b/api/horizon/errors/result-codes/operation-specific/manage-data.mdx similarity index 91% rename from api/errors/result-codes/operation-specific/manage-data.mdx rename to api/horizon/errors/result-codes/operation-specific/manage-data.mdx index a5975f565..cfcceef9f 100644 --- a/api/errors/result-codes/operation-specific/manage-data.mdx +++ b/api/horizon/errors/result-codes/operation-specific/manage-data.mdx @@ -8,7 +8,7 @@ import { AttributeTable } from "@site/src/components/AttributeTable"; These are result codes that communicate success (200) or failure (400) specific to the `Manage Data` operation. -Learn more about the [`Manage Data` operation](../../../../docs/fundamentals-and-concepts/list-of-operations#manage-data). +Learn more about the [`Manage Data` operation](/docs/fundamentals-and-concepts/list-of-operations#manage-data). diff --git a/api/errors/result-codes/operation-specific/manage-sell-offer.mdx b/api/horizon/errors/result-codes/operation-specific/manage-sell-offer.mdx similarity index 94% rename from api/errors/result-codes/operation-specific/manage-sell-offer.mdx rename to api/horizon/errors/result-codes/operation-specific/manage-sell-offer.mdx index a22e500ee..6616a4c0f 100644 --- a/api/errors/result-codes/operation-specific/manage-sell-offer.mdx +++ b/api/horizon/errors/result-codes/operation-specific/manage-sell-offer.mdx @@ -8,7 +8,7 @@ import { AttributeTable } from "@site/src/components/AttributeTable"; These are result codes that communicate success (200) or failure (400) specific to the `Manage Sell Offer` operation. -Learn more about the [`Manage Sell Offer` operation](../../../../docs/fundamentals-and-concepts/list-of-operations#manage-sell-offer). +Learn more about the [`Manage Sell Offer` operation](/docs/fundamentals-and-concepts/list-of-operations#manage-sell-offer). diff --git a/api/errors/result-codes/operation-specific/path-payment-strict-receive.mdx b/api/horizon/errors/result-codes/operation-specific/path-payment-strict-receive.mdx similarity index 93% rename from api/errors/result-codes/operation-specific/path-payment-strict-receive.mdx rename to api/horizon/errors/result-codes/operation-specific/path-payment-strict-receive.mdx index c18b6e89d..29d5c7c6d 100644 --- a/api/errors/result-codes/operation-specific/path-payment-strict-receive.mdx +++ b/api/horizon/errors/result-codes/operation-specific/path-payment-strict-receive.mdx @@ -8,7 +8,7 @@ import { AttributeTable } from "@site/src/components/AttributeTable"; These are result codes that communicate success (200) or failure (400) specific to the `Path Payment Strict Receive` operation. -Learn more about the [`Path Payment Strict Receive` operation](../../../../docs/fundamentals-and-concepts/list-of-operations#path-payment-strict-receive). +Learn more about the [`Path Payment Strict Receive` operation](/docs/fundamentals-and-concepts/list-of-operations#path-payment-strict-receive). diff --git a/api/errors/result-codes/operation-specific/path-payment-strict-send.mdx b/api/horizon/errors/result-codes/operation-specific/path-payment-strict-send.mdx similarity index 93% rename from api/errors/result-codes/operation-specific/path-payment-strict-send.mdx rename to api/horizon/errors/result-codes/operation-specific/path-payment-strict-send.mdx index 6030ee82f..6615ecd55 100644 --- a/api/errors/result-codes/operation-specific/path-payment-strict-send.mdx +++ b/api/horizon/errors/result-codes/operation-specific/path-payment-strict-send.mdx @@ -8,7 +8,7 @@ import { AttributeTable } from "@site/src/components/AttributeTable"; These are result codes that communicate success (200) or failure (400) specific to the `Path Payment Strict Send` operation. -Learn more about the [`Path Payment Strict Send` operation](../../../../docs/fundamentals-and-concepts/list-of-operations#path-payment-strict-send). +Learn more about the [`Path Payment Strict Send` operation](/docs/fundamentals-and-concepts/list-of-operations#path-payment-strict-send). diff --git a/api/errors/result-codes/operation-specific/payment.mdx b/api/horizon/errors/result-codes/operation-specific/payment.mdx similarity index 93% rename from api/errors/result-codes/operation-specific/payment.mdx rename to api/horizon/errors/result-codes/operation-specific/payment.mdx index ae49b9cb0..6d58e301b 100644 --- a/api/errors/result-codes/operation-specific/payment.mdx +++ b/api/horizon/errors/result-codes/operation-specific/payment.mdx @@ -8,7 +8,7 @@ import { AttributeTable } from "@site/src/components/AttributeTable"; These are result codes that communicate success (200) or failure (400) specific to the `Payment` operation, which often fails because the receiving account does not trust the issuer of the asset being sent. -Learn more about the [`Payment` operation](../../../../docs/fundamentals-and-concepts/list-of-operations#payment)). +Learn more about the [`Payment` operation](/docs/fundamentals-and-concepts/list-of-operations#payment)). diff --git a/api/errors/result-codes/operation-specific/set-options.mdx b/api/horizon/errors/result-codes/operation-specific/set-options.mdx similarity index 93% rename from api/errors/result-codes/operation-specific/set-options.mdx rename to api/horizon/errors/result-codes/operation-specific/set-options.mdx index 89027fa7c..836ede302 100644 --- a/api/errors/result-codes/operation-specific/set-options.mdx +++ b/api/horizon/errors/result-codes/operation-specific/set-options.mdx @@ -8,7 +8,7 @@ import { AttributeTable } from "@site/src/components/AttributeTable"; These are result codes that communicate success (200) or failure (400) specific to the `Set Options` operation. -Learn more about the [`Set Options` operation](../../../../docs/fundamentals-and-concepts/list-of-operations#set-options). +Learn more about the [`Set Options` operation](/docs/fundamentals-and-concepts/list-of-operations#set-options). diff --git a/api/errors/result-codes/operations.mdx b/api/horizon/errors/result-codes/operations.mdx similarity index 100% rename from api/errors/result-codes/operations.mdx rename to api/horizon/errors/result-codes/operations.mdx diff --git a/api/errors/result-codes/transactions.mdx b/api/horizon/errors/result-codes/transactions.mdx similarity index 100% rename from api/errors/result-codes/transactions.mdx rename to api/horizon/errors/result-codes/transactions.mdx diff --git a/api/introduction/_category_.json b/api/horizon/introduction/_category_.json similarity index 100% rename from api/introduction/_category_.json rename to api/horizon/introduction/_category_.json diff --git a/api/introduction/index.mdx b/api/horizon/introduction/index.mdx similarity index 61% rename from api/introduction/index.mdx rename to api/horizon/introduction/index.mdx index 87e473989..29b65ce07 100644 --- a/api/introduction/index.mdx +++ b/api/horizon/introduction/index.mdx @@ -1,21 +1,22 @@ --- title: Horizon API Reference sidebar_position: 10 -slug: / +slug: /horizon +description: Horizon is an API for interacting with the Stellar network. --- import { MethodTable } from "@site/src/components/MethodTable"; Horizon is an API for interacting with the Stellar network. -This API serves the bridge between apps and [Stellar Core](../../docs/run-core-node). Projects like wallets, decentralized exchanges, and asset issuers use Horizon to submit transactions, query an account balance, or stream events like transactions to an account. +This API serves the bridge between apps and [Stellar Core](/docs/run-core-node). Projects like wallets, decentralized exchanges, and asset issuers use Horizon to submit transactions, query an account balance, or stream events like transactions to an account. -Horizon is a [RESTful API](https://en.wikipedia.org/wiki/Representational_state_transfer) and can be accessed via cURL, a browser, or one of the [Stellar SDKs](../../docs/tools-and-sdks). To reduce the complexity of your project, we recommend you use an SDK instead of making direct API calls. +Horizon is a [RESTful API](https://en.wikipedia.org/wiki/Representational_state_transfer) and can be accessed via cURL, a browser, or one of the [Stellar SDKs](/docs/tools-and-sdks). To reduce the complexity of your project, we recommend you use an SDK instead of making direct API calls. The Stellar Development Foundation (SDF) runs two instances of Horizon: - [https://horizon.stellar.org/](https://horizon.stellar.org/) for interacting with the public network -- [https://horizon-testnet.stellar.org/](https://horizon-testnet.stellar.org/) for interacting with the [testnet](../../docs/fundamentals-and-concepts/testnet-and-pubnet) +- [https://horizon-testnet.stellar.org/](https://horizon-testnet.stellar.org/) for interacting with the [testnet](/docs/fundamentals-and-concepts/testnet-and-pubnet) diff --git a/api/introduction/pagination/_category_.json b/api/horizon/introduction/pagination/_category_.json similarity index 100% rename from api/introduction/pagination/_category_.json rename to api/horizon/introduction/pagination/_category_.json diff --git a/api/introduction/pagination/index.mdx b/api/horizon/introduction/pagination/index.mdx similarity index 100% rename from api/introduction/pagination/index.mdx rename to api/horizon/introduction/pagination/index.mdx diff --git a/api/introduction/pagination/page-arguments.mdx b/api/horizon/introduction/pagination/page-arguments.mdx similarity index 100% rename from api/introduction/pagination/page-arguments.mdx rename to api/horizon/introduction/pagination/page-arguments.mdx diff --git a/api/introduction/rate-limiting.mdx b/api/horizon/introduction/rate-limiting.mdx similarity index 100% rename from api/introduction/rate-limiting.mdx rename to api/horizon/introduction/rate-limiting.mdx diff --git a/api/introduction/response-format.mdx b/api/horizon/introduction/response-format.mdx similarity index 100% rename from api/introduction/response-format.mdx rename to api/horizon/introduction/response-format.mdx diff --git a/api/introduction/streaming.mdx b/api/horizon/introduction/streaming.mdx similarity index 94% rename from api/introduction/streaming.mdx rename to api/horizon/introduction/streaming.mdx index f63c23fe1..602bc5536 100644 --- a/api/introduction/streaming.mdx +++ b/api/horizon/introduction/streaming.mdx @@ -9,7 +9,7 @@ Horizon provides a streaming mechanism for receiving events in near real time. I This reduces requests that return no data and allows near instantaneous updates client-side. -All attributes for the endpoints that allow streaming are the same as regular responses. A caller can initiate streaming by setting ‘Accept: text/event-stream’ in the HTTP header when making the request. Study an example of using streaming in the [Follow Received Payments tutorial](../../docs/tutorials/follow-received-payments). +All attributes for the endpoints that allow streaming are the same as regular responses. A caller can initiate streaming by setting ‘Accept: text/event-stream’ in the HTTP header when making the request. Study an example of using streaming in the [Follow Received Payments tutorial](/docs/tutorials/follow-received-payments). diff --git a/api/introduction/xdr.mdx b/api/horizon/introduction/xdr.mdx similarity index 100% rename from api/introduction/xdr.mdx rename to api/horizon/introduction/xdr.mdx diff --git a/api/resources/_category_.json b/api/horizon/resources/_category_.json similarity index 100% rename from api/resources/_category_.json rename to api/horizon/resources/_category_.json diff --git a/api/resources/accounts/index.mdx b/api/horizon/resources/accounts/index.mdx similarity index 95% rename from api/resources/accounts/index.mdx rename to api/horizon/resources/accounts/index.mdx index b5af0556e..371d108fa 100644 --- a/api/resources/accounts/index.mdx +++ b/api/horizon/resources/accounts/index.mdx @@ -7,7 +7,7 @@ import { EndpointsTable } from "@site/src/components/EndpointsTable"; Users interact with the Stellar network through accounts. Everything else in the ledger—assets, offers, trustlines, etc.—are owned by accounts, and accounts must authorize all changes to the ledger through signed transactions. -Learn more about [accounts](../../../docs/glossary/#account). +Learn more about [accounts](/docs/glossary/#account). diff --git a/api/resources/accounts/object.mdx b/api/horizon/resources/accounts/object.mdx similarity index 97% rename from api/resources/accounts/object.mdx rename to api/horizon/resources/accounts/object.mdx index 2292c9635..2e58918d1 100644 --- a/api/resources/accounts/object.mdx +++ b/api/horizon/resources/accounts/object.mdx @@ -24,10 +24,10 @@ When Horizon returns information about an account, it uses the following format: - This account's current sequence number. For use when submitting this account's next transaction. - sequence_ledger - number - - The unsigned 32-bit ledger number of the sequence number's [age](../../../docs/glossary/#sequence-time-and-ledger). + - The unsigned 32-bit ledger number of the sequence number's [age](/docs/glossary/#sequence-time-and-ledger). - sequence_time - string - - The unsigned 64-bit UNIX timestamp of the sequence number's [age](../../../docs/glossary/#sequence-time-and-ledger). + - The unsigned 64-bit UNIX timestamp of the sequence number's [age](/docs/glossary/#sequence-time-and-ledger). - subentry_count - number - The number of subentries on this account. @@ -72,7 +72,7 @@ When Horizon returns information about an account, it uses the following format: - If set to `true`, this account can freeze the balance of a holder of an asset issued by this account. - auth_clawback_enabled - boolean - - If set to `true`, trustlines created for assets issued by this account have [clawbacks](../../../docs/glossary#clawback) enabled. + - If set to `true`, trustlines created for assets issued by this account have [clawbacks](/docs/glossary#clawback) enabled. - balances - object - The assets this account holds. diff --git a/api/resources/assets/index.mdx b/api/horizon/resources/assets/index.mdx similarity index 86% rename from api/resources/assets/index.mdx rename to api/horizon/resources/assets/index.mdx index f35dd1038..adcc54ccb 100644 --- a/api/resources/assets/index.mdx +++ b/api/horizon/resources/assets/index.mdx @@ -7,7 +7,7 @@ import { EndpointsTable } from "@site/src/components/EndpointsTable"; Assets are representations of value issued on the Stellar network. An asset consists of a type, code, and issuer. -Learn more about [assets](../../../docs/glossary/#asset). +Learn more about [assets](/docs/glossary/#asset). diff --git a/api/resources/assets/object.mdx b/api/horizon/resources/assets/object.mdx similarity index 100% rename from api/resources/assets/object.mdx rename to api/horizon/resources/assets/object.mdx diff --git a/api/resources/cb-retrieve-related-operations.api.mdx b/api/horizon/resources/cb-retrieve-related-operations.api.mdx similarity index 99% rename from api/resources/cb-retrieve-related-operations.api.mdx rename to api/horizon/resources/cb-retrieve-related-operations.api.mdx index f34c02ea7..4e67e842e 100644 --- a/api/resources/cb-retrieve-related-operations.api.mdx +++ b/api/horizon/resources/cb-retrieve-related-operations.api.mdx @@ -7,7 +7,7 @@ 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}}]}]}}}}}}}},"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/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/cb-retrieve-related-transactions.api.mdx b/api/horizon/resources/cb-retrieve-related-transactions.api.mdx similarity index 99% rename from api/resources/cb-retrieve-related-transactions.api.mdx rename to api/horizon/resources/cb-retrieve-related-transactions.api.mdx index dbecb9f00..1ebac2bd9 100644 --- a/api/resources/cb-retrieve-related-transactions.api.mdx +++ b/api/horizon/resources/cb-retrieve-related-transactions.api.mdx @@ -7,7 +7,7 @@ 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"}}}]}}}}}}}},"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/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/claimablebalances/index.mdx b/api/horizon/resources/claimablebalances/index.mdx similarity index 100% rename from api/resources/claimablebalances/index.mdx rename to api/horizon/resources/claimablebalances/index.mdx diff --git a/api/resources/claimablebalances/object.mdx b/api/horizon/resources/claimablebalances/object.mdx similarity index 100% rename from api/resources/claimablebalances/object.mdx rename to api/horizon/resources/claimablebalances/object.mdx diff --git a/api/resources/effects/index.mdx b/api/horizon/resources/effects/index.mdx similarity index 100% rename from api/resources/effects/index.mdx rename to api/horizon/resources/effects/index.mdx diff --git a/api/resources/effects/types.mdx b/api/horizon/resources/effects/types.mdx similarity index 100% rename from api/resources/effects/types.mdx rename to api/horizon/resources/effects/types.mdx diff --git a/api/resources/get-all-offers.api.mdx b/api/horizon/resources/get-all-offers.api.mdx similarity index 99% rename from api/resources/get-all-offers.api.mdx rename to api/horizon/resources/get-all-offers.api.mdx index 24ef74f6e..a1d53746d 100644 --- a/api/resources/get-all-offers.api.mdx +++ b/api/horizon/resources/get-all-offers.api.mdx @@ -7,7 +7,7 @@ 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"}]}}}}}}}},"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/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/get-all-trades.api.mdx b/api/horizon/resources/get-all-trades.api.mdx similarity index 99% rename from api/resources/get-all-trades.api.mdx rename to api/horizon/resources/get-all-trades.api.mdx index 50fd97fbf..be13243b6 100644 --- a/api/resources/get-all-trades.api.mdx +++ b/api/horizon/resources/get-all-trades.api.mdx @@ -7,7 +7,7 @@ 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"}}]}}}}}}}},"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/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/get-data-by-account-id.api.mdx b/api/horizon/resources/get-data-by-account-id.api.mdx similarity index 99% rename from api/resources/get-data-by-account-id.api.mdx rename to api/horizon/resources/get-data-by-account-id.api.mdx index 136c7d177..c91e56f9f 100644 --- a/api/resources/get-data-by-account-id.api.mdx +++ b/api/horizon/resources/get-data-by-account-id.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"tags":["Accounts"],"description":"This endpoint represents a single data for a given account.","operationId":"GetDataByAccountId","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":"key","in":"path","required":true,"description":"The key name for this data.","schema":{"type":"string","example":"config.memo_required"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"string"}}},"examples":{"RetrieveAnAccountsData":{"value":{"value":"MQ=="}}}}}}},"method":"get","path":"/accounts/{account_id}/data/{key}","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 Data","description":{"content":"This endpoint represents a single data for a given account.","type":"text/plain"},"url":{"path":["accounts",":account_id","data",":key"],"host":["{{baseUrl}}"],"query":[],"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"},{"disabled":false,"description":{"content":"(Required) The key name for this data.","type":"text/plain"},"type":"any","value":"","key":"key"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" -info_path: api/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/get-effects-by-account-id.api.mdx b/api/horizon/resources/get-effects-by-account-id.api.mdx similarity index 99% rename from api/resources/get-effects-by-account-id.api.mdx rename to api/horizon/resources/get-effects-by-account-id.api.mdx index 537a99958..649126e93 100644 --- a/api/resources/get-effects-by-account-id.api.mdx +++ b/api/horizon/resources/get-effects-by-account-id.api.mdx @@ -7,7 +7,7 @@ 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"}]}}}}}}}},"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/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/get-offer-by-offer-id.api.mdx b/api/horizon/resources/get-offer-by-offer-id.api.mdx similarity index 99% rename from api/resources/get-offer-by-offer-id.api.mdx rename to api/horizon/resources/get-offer-by-offer-id.api.mdx index c4eb7f45d..6ad1d94a5 100644 --- a/api/resources/get-offer-by-offer-id.api.mdx +++ b/api/horizon/resources/get-offer-by-offer-id.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"tags":["Offers"],"description":"The single offer endpoint provides information on a specific offer.","operationId":"GetOfferByOfferId","parameters":[{"name":"offer_id","in":"path","required":true,"description":"A unique identifier for this offer."}],"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":{"GetOfferByOfferId":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/offers/165563085"},"offer_maker":{"href":"https://horizon.stellar.org/accounts/GCM4PT6XDZBWOOENDS6FOU22GJQLJPV2GC7VRVII4TFGZBA3ZXNM55SV"}},"id":165563085,"paging_token":"165563085","seller":"GCM4PT6XDZBWOOENDS6FOU22GJQLJPV2GC7VRVII4TFGZBA3ZXNM55SV","selling":{"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"},"buying":{"asset_type":"native"},"amount":"26.1075388","price_r":{"n":1449156725,"d":84642346},"price":"17.1209423","last_modified_ledger":28412042,"last_modified_time":null}}}}}}},"method":"get","path":"/offers/{offer_id}","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","description":{"content":"The single offer endpoint provides information on a specific offer.","type":"text/plain"},"url":{"path":["offers",":offer_id"],"host":["{{baseUrl}}"],"query":[],"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/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/get-offers-by-account-id.api.mdx b/api/horizon/resources/get-offers-by-account-id.api.mdx similarity index 99% rename from api/resources/get-offers-by-account-id.api.mdx rename to api/horizon/resources/get-offers-by-account-id.api.mdx index 3485b28ec..4947bbd20 100644 --- a/api/resources/get-offers-by-account-id.api.mdx +++ b/api/horizon/resources/get-offers-by-account-id.api.mdx @@ -7,7 +7,7 @@ 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"}]}}}}}}}},"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/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/get-operations-by-account-id.api.mdx b/api/horizon/resources/get-operations-by-account-id.api.mdx similarity index 99% rename from api/resources/get-operations-by-account-id.api.mdx rename to api/horizon/resources/get-operations-by-account-id.api.mdx index f411ea06d..b4d80bb1b 100644 --- a/api/resources/get-operations-by-account-id.api.mdx +++ b/api/horizon/resources/get-operations-by-account-id.api.mdx @@ -7,7 +7,7 @@ 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"}]}}}}}}}},"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/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/get-payments-by-account-id.api.mdx b/api/horizon/resources/get-payments-by-account-id.api.mdx similarity index 99% rename from api/resources/get-payments-by-account-id.api.mdx rename to api/horizon/resources/get-payments-by-account-id.api.mdx index 2d2a9e1ee..20cb0f467 100644 --- a/api/resources/get-payments-by-account-id.api.mdx +++ b/api/horizon/resources/get-payments-by-account-id.api.mdx @@ -7,7 +7,7 @@ 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"}]}}}}}}}},"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/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/get-trades-by-account-id.api.mdx b/api/horizon/resources/get-trades-by-account-id.api.mdx similarity index 99% rename from api/resources/get-trades-by-account-id.api.mdx rename to api/horizon/resources/get-trades-by-account-id.api.mdx index 52b04a7e5..ec288015f 100644 --- a/api/resources/get-trades-by-account-id.api.mdx +++ b/api/horizon/resources/get-trades-by-account-id.api.mdx @@ -7,7 +7,7 @@ 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"}}]}}}}}}}},"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/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/get-trades-by-offer-id.api.mdx b/api/horizon/resources/get-trades-by-offer-id.api.mdx similarity index 99% rename from api/resources/get-trades-by-offer-id.api.mdx rename to api/horizon/resources/get-trades-by-offer-id.api.mdx index 922dd7a21..4612db6bc 100644 --- a/api/resources/get-trades-by-offer-id.api.mdx +++ b/api/horizon/resources/get-trades-by-offer-id.api.mdx @@ -7,7 +7,7 @@ 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}}]}}}}}}}},"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/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/get-transactions-by-account-id.api.mdx b/api/horizon/resources/get-transactions-by-account-id.api.mdx similarity index 99% rename from api/resources/get-transactions-by-account-id.api.mdx rename to api/horizon/resources/get-transactions-by-account-id.api.mdx index 28ce87459..fca31e86a 100644 --- a/api/resources/get-transactions-by-account-id.api.mdx +++ b/api/horizon/resources/get-transactions-by-account-id.api.mdx @@ -7,7 +7,7 @@ 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=="]}]}}}}}}}},"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/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/index.mdx b/api/horizon/resources/index.mdx similarity index 100% rename from api/resources/index.mdx rename to api/horizon/resources/index.mdx diff --git a/api/resources/ledgers/index.mdx b/api/horizon/resources/ledgers/index.mdx similarity index 94% rename from api/resources/ledgers/index.mdx rename to api/horizon/resources/ledgers/index.mdx index 846d39f76..d719339c5 100644 --- a/api/resources/ledgers/index.mdx +++ b/api/horizon/resources/ledgers/index.mdx @@ -7,7 +7,7 @@ import { EndpointsTable } from "@site/src/components/EndpointsTable"; Each ledger stores the state of the network at a point in time and contains all the changes - transactions, operations, effects, etc. - to that state. -Learn more about [ledgers](../../../docs/glossary/#ledger). +Learn more about [ledgers](/docs/glossary/#ledger). diff --git a/api/resources/ledgers/object.mdx b/api/horizon/resources/ledgers/object.mdx similarity index 97% rename from api/resources/ledgers/object.mdx rename to api/horizon/resources/ledgers/object.mdx index fc7d89792..1bb2e9fc1 100644 --- a/api/resources/ledgers/object.mdx +++ b/api/horizon/resources/ledgers/object.mdx @@ -21,7 +21,7 @@ When Horizon returns information about a ledger, it uses the following format: - A cursor value for use in [pagination](../../introduction/pagination/index.mdx). - hash - string - - A hex-encoded SHA-256 hash of this ledger’s [XDR](../../../docs/encyclopedia/xdr)-encoded form. + - A hex-encoded SHA-256 hash of this ledger’s [XDR](/docs/encyclopedia/xdr)-encoded form. - prev_hash - string - The hash of the ledger immediately preceding this ledger. diff --git a/api/resources/liquiditypools/index.mdx b/api/horizon/resources/liquiditypools/index.mdx similarity index 100% rename from api/resources/liquiditypools/index.mdx rename to api/horizon/resources/liquiditypools/index.mdx diff --git a/api/resources/list-all-accounts.api.mdx b/api/horizon/resources/list-all-accounts.api.mdx similarity index 99% rename from api/resources/list-all-accounts.api.mdx rename to api/horizon/resources/list-all-accounts.api.mdx index af498bfe3..e1a64bd14 100644 --- a/api/resources/list-all-accounts.api.mdx +++ b/api/horizon/resources/list-all-accounts.api.mdx @@ -7,7 +7,7 @@ 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"}]}}}}}}}},"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/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/list-all-assets.api.mdx b/api/horizon/resources/list-all-assets.api.mdx similarity index 99% rename from api/resources/list-all-assets.api.mdx rename to api/horizon/resources/list-all-assets.api.mdx index bb19824d5..5ef28779f 100644 --- a/api/resources/list-all-assets.api.mdx +++ b/api/horizon/resources/list-all-assets.api.mdx @@ -7,7 +7,7 @@ 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"},"unathorized":{"type":"integer"}}},"num_claimable_balances":{"type":"integer"},"balances":{"type":"object","properties":{"authorized":{"type":"string"},"authorized_to_maintain_liabilities":{"type":"string"},"unathorized":{"type":"string"}}},"claimable_balances_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_liquidity_pools":0,"amount":"899996000000.0000000","accounts":{"authorized":10,"authorized_to_maintain_liabilities":0,"unauthorized":0},"claimable_balances_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_liquidity_pools":0,"amount":"1.0000000","accounts":{"authorized":43,"authorized_to_maintain_liabilities":0,"unauthorized":0},"claimable_balances_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_liquidity_pools":0,"amount":"65000000000.0000000","accounts":{"authorized":1,"authorized_to_maintain_liabilities":0,"unauthorized":0},"claimable_balances_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/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/list-all-claimable-balances.api.mdx b/api/horizon/resources/list-all-claimable-balances.api.mdx similarity index 99% rename from api/resources/list-all-claimable-balances.api.mdx rename to api/horizon/resources/list-all-claimable-balances.api.mdx index 21dc3d63b..391d430f1 100644 --- a/api/resources/list-all-claimable-balances.api.mdx +++ b/api/horizon/resources/list-all-claimable-balances.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"tags":["Claimable Balances"],"description":"This endpoint lists all available claimable balances.","operationId":"ListAllClaimableBalances","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":"claimant","in":"query","required":false,"description":"Account ID of the destination address. Only include claimable balances which can be claimed by the given account ID."},{"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}}],"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"},"operations":{"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"}},"required":["self","operations","transactions"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string"},"asset":{"type":"string"},"amount":{"type":"string"},"sponsor":{"type":"string"},"last_modified_ledger":{"type":"string"},"last_modified_time":{"type":"string"},"claimants":{"type":"array","items":{"type":"object","properties":{"destination":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"predicate":{"type":"object","properties":{"and":{"type":"array","items":{"type":"object","properties":{"or":{"type":"array","items":{"type":"object","properties":{"relBefore":{"type":"string"},"absBefore":{"type":"string"},"absBeforeEpoch":{"type":"string"}}}},"not":{"type":"object","properties":{"unconditional":{"type":"boolean"},"relBefore":{"type":"string"},"absBefore":{"type":"string"},"absBeforeEpoch":{"type":"string"}}}}}}}}}}},"flags":{"type":"integer"}},"required":["id","paging_token","asset","amount","last_modified_ledger","last_modified_time"]}}}}},"title":"ClaimableBalances"}]},"examples":{"ListAllClaimableBalances":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/claimable_balances?asset=native&cursor=&limit=10&order=asc"},"next":{"href":"https://horizon.stellar.org/claimable_balances?asset=native&cursor=35938300-0000000017b9a95e25aa60200b52cc04f75c496dca76dc19fec21c942dfb35cce23c3eba&limit=10&order=asc"},"prev":{"href":"https://horizon.stellar.org/claimable_balances?asset=native&cursor=33324106-00000000691787983bc3ea12361092fe49ae83cbbe37804ee1590fe2b9b3e3860fc8261f&limit=10&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/claimable_balances/00000000691787983bc3ea12361092fe49ae83cbbe37804ee1590fe2b9b3e3860fc8261f"},"transactions":{"href":"https://horizon.stellar.org/claimable_balances/00000000691787983bc3ea12361092fe49ae83cbbe37804ee1590fe2b9b3e3860fc8261f/transactions{?cursor,limit,order}","templated":true},"operations":{"href":"https://horizon.stellar.org/claimable_balances/00000000691787983bc3ea12361092fe49ae83cbbe37804ee1590fe2b9b3e3860fc8261f/operations{?cursor,limit,order}","templated":true}},"id":"00000000691787983bc3ea12361092fe49ae83cbbe37804ee1590fe2b9b3e3860fc8261f","asset":"native","amount":"0.1000000","sponsor":"GDOZMXWISPB57FITUQIGTFH2KNNW7QTFESXF5DZEAMZK6QHE3KVO5TRT","last_modified_ledger":33324106,"last_modified_time":"2020-12-30T23:02:56Z","claimants":[{"destination":"GCD3T6UIQLYZPGRCYVSE7LKQB5HYYNVT7ENY6RCSFRFQYR5JTBDCECO3","predicate":{"and":[{"abs_before":"2020-12-30T23:03:56Z","abs_before_epoch":"1609369436"},{"not":{"abs_before":"2020-12-30T23:05:56Z","abs_before_epoch":"1609369556"}}]}}],"flags":{"clawback_enabled":false},"paging_token":"33324106-00000000691787983bc3ea12361092fe49ae83cbbe37804ee1590fe2b9b3e3860fc8261f"},{"_links":{"self":{"href":"https://horizon.stellar.org/claimable_balances/000000003a9a08342ca45d96abc011278644d83d1718ab16e44209fa1952829b66017c28"},"transactions":{"href":"https://horizon.stellar.org/claimable_balances/000000003a9a08342ca45d96abc011278644d83d1718ab16e44209fa1952829b66017c28/transactions{?cursor,limit,order}","templated":true},"operations":{"href":"https://horizon.stellar.org/claimable_balances/000000003a9a08342ca45d96abc011278644d83d1718ab16e44209fa1952829b66017c28/operations{?cursor,limit,order}","templated":true}},"id":"000000003a9a08342ca45d96abc011278644d83d1718ab16e44209fa1952829b66017c28","asset":"native","amount":"1.0000000","sponsor":"GA5ACYSBFH5AFWMZ5T34FLT5W3X6Z4FT4PMN3NUDT3G2JCYJXYGD72EF","last_modified_ledger":33505955,"last_modified_time":"2021-01-12T21:02:00Z","claimants":[{"destination":"GCXAULI3NAFEUKIXUQTD3HXGCTTLM6KVGKTUBZIHVUDP6WXEF7RWJV67","predicate":{"unconditional":true}}],"flags":{"clawback_enabled":false},"paging_token":"33505955-000000003a9a08342ca45d96abc011278644d83d1718ab16e44209fa1952829b66017c28"},{"_links":{"self":{"href":"https://horizon.stellar.org/claimable_balances/0000000063036dcfa438cb51180bea16e36850e3699efc934577b07322c818157e4d5411"},"transactions":{"href":"https://horizon.stellar.org/claimable_balances/0000000063036dcfa438cb51180bea16e36850e3699efc934577b07322c818157e4d5411/transactions{?cursor,limit,order}","templated":true},"operations":{"href":"https://horizon.stellar.org/claimable_balances/0000000063036dcfa438cb51180bea16e36850e3699efc934577b07322c818157e4d5411/operations{?cursor,limit,order}","templated":true}},"id":"0000000063036dcfa438cb51180bea16e36850e3699efc934577b07322c818157e4d5411","asset":"native","amount":"0.0010000","sponsor":"GBIIQM26JJS774T7CSP3WBFVUXHUCTZCV5ZPGMKL57POWMFPMLYOKOZQ","last_modified_ledger":34254613,"last_modified_time":"2021-03-03T10:36:28Z","claimants":[{"destination":"GBIIQM26JJS774T7CSP3WBFVUXHUCTZCV5ZPGMKL57POWMFPMLYOKOZQ","predicate":{"unconditional":true}}],"flags":{"clawback_enabled":false},"paging_token":"34254613-0000000063036dcfa438cb51180bea16e36850e3699efc934577b07322c818157e4d5411"},{"_links":{"self":{"href":"https://horizon.stellar.org/claimable_balances/00000000d076fe2df3e6cc5e5c28e7bf257c11eb209d703a681c58bb867b78b67235c694"},"transactions":{"href":"https://horizon.stellar.org/claimable_balances/00000000d076fe2df3e6cc5e5c28e7bf257c11eb209d703a681c58bb867b78b67235c694/transactions{?cursor,limit,order}","templated":true},"operations":{"href":"https://horizon.stellar.org/claimable_balances/00000000d076fe2df3e6cc5e5c28e7bf257c11eb209d703a681c58bb867b78b67235c694/operations{?cursor,limit,order}","templated":true}},"id":"00000000d076fe2df3e6cc5e5c28e7bf257c11eb209d703a681c58bb867b78b67235c694","asset":"native","amount":"0.0010000","sponsor":"GANVXZ2DQ2FFLVCBSVMBBNVWSXS6YVEDP247EN4C3CM3I32XR4U3OU2I","last_modified_ledger":34255259,"last_modified_time":"2021-03-03T11:35:31Z","claimants":[{"destination":"GANVXZ2DQ2FFLVCBSVMBBNVWSXS6YVEDP247EN4C3CM3I32XR4U3OU2I","predicate":{"unconditional":true}}],"flags":{"clawback_enabled":false},"paging_token":"34255259-00000000d076fe2df3e6cc5e5c28e7bf257c11eb209d703a681c58bb867b78b67235c694"},{"_links":{"self":{"href":"https://horizon.stellar.org/claimable_balances/00000000da8ed8d0dccacce237c5395eb07bb845d2bb96425d18d168d535063316d99e7f"},"transactions":{"href":"https://horizon.stellar.org/claimable_balances/00000000da8ed8d0dccacce237c5395eb07bb845d2bb96425d18d168d535063316d99e7f/transactions{?cursor,limit,order}","templated":true},"operations":{"href":"https://horizon.stellar.org/claimable_balances/00000000da8ed8d0dccacce237c5395eb07bb845d2bb96425d18d168d535063316d99e7f/operations{?cursor,limit,order}","templated":true}},"id":"00000000da8ed8d0dccacce237c5395eb07bb845d2bb96425d18d168d535063316d99e7f","asset":"native","amount":"1.0000000","sponsor":"GB7OYQFQI7GH622CKCFWPH4WSZUGOXXNY2XWV5K27S3SW2JHOWCCWEJ4","last_modified_ledger":35023766,"last_modified_time":"2021-04-20T19:00:04Z","claimants":[{"destination":"GAV2USD4ELGLRWBT67V7N37QAJKOPLHUJL3AVFW5NHWDHVXL4EQPSWZ5","predicate":{"unconditional":true}}],"flags":{"clawback_enabled":false},"paging_token":"35023766-00000000da8ed8d0dccacce237c5395eb07bb845d2bb96425d18d168d535063316d99e7f"},{"_links":{"self":{"href":"https://horizon.stellar.org/claimable_balances/00000000c551a949d0fb5199b05cb8220b4ba7dad4cd7968c849ab0fb51f744daab864fe"},"transactions":{"href":"https://horizon.stellar.org/claimable_balances/00000000c551a949d0fb5199b05cb8220b4ba7dad4cd7968c849ab0fb51f744daab864fe/transactions{?cursor,limit,order}","templated":true},"operations":{"href":"https://horizon.stellar.org/claimable_balances/00000000c551a949d0fb5199b05cb8220b4ba7dad4cd7968c849ab0fb51f744daab864fe/operations{?cursor,limit,order}","templated":true}},"id":"00000000c551a949d0fb5199b05cb8220b4ba7dad4cd7968c849ab0fb51f744daab864fe","asset":"native","amount":"0.2091529","sponsor":"GA5WWLUYCR4XJKS4ZYKWATKC7E3AVM3FZLWXWSKOBZWAGDROF5MUQXAT","last_modified_ledger":35530330,"last_modified_time":"2021-05-22T17:04:31Z","claimants":[{"destination":"GCSZDAUKEX3IZXXUEEMERIYTVKHDTVTWK7LHXHELZE5B472QMGGXQLHD","predicate":{"unconditional":true}},{"destination":"GA5WWLUYCR4XJKS4ZYKWATKC7E3AVM3FZLWXWSKOBZWAGDROF5MUQXAT","predicate":{"unconditional":true}}],"flags":{"clawback_enabled":false},"paging_token":"35530330-00000000c551a949d0fb5199b05cb8220b4ba7dad4cd7968c849ab0fb51f744daab864fe"},{"_links":{"self":{"href":"https://horizon.stellar.org/claimable_balances/00000000d1f2ad9c1ff9124de62f9721ed5811f1f0d7705660c5a7daaa174ad5100c6b4d"},"transactions":{"href":"https://horizon.stellar.org/claimable_balances/00000000d1f2ad9c1ff9124de62f9721ed5811f1f0d7705660c5a7daaa174ad5100c6b4d/transactions{?cursor,limit,order}","templated":true},"operations":{"href":"https://horizon.stellar.org/claimable_balances/00000000d1f2ad9c1ff9124de62f9721ed5811f1f0d7705660c5a7daaa174ad5100c6b4d/operations{?cursor,limit,order}","templated":true}},"id":"00000000d1f2ad9c1ff9124de62f9721ed5811f1f0d7705660c5a7daaa174ad5100c6b4d","asset":"native","amount":"0.2091529","sponsor":"GA5WWLUYCR4XJKS4ZYKWATKC7E3AVM3FZLWXWSKOBZWAGDROF5MUQXAT","last_modified_ledger":35530330,"last_modified_time":"2021-05-22T17:04:31Z","claimants":[{"destination":"GBO4FL74OZTOCTABWFS2PH4LGI2CHFABDZ2LBPRH6UECXBAIU5LUIOF2","predicate":{"unconditional":true}},{"destination":"GA5WWLUYCR4XJKS4ZYKWATKC7E3AVM3FZLWXWSKOBZWAGDROF5MUQXAT","predicate":{"unconditional":true}}],"flags":{"clawback_enabled":false},"paging_token":"35530330-00000000d1f2ad9c1ff9124de62f9721ed5811f1f0d7705660c5a7daaa174ad5100c6b4d"},{"_links":{"self":{"href":"https://horizon.stellar.org/claimable_balances/000000001b53636a29ca25d28d1c5bb165f55280167d53cfefb0ce297d98032b32f772d0"},"transactions":{"href":"https://horizon.stellar.org/claimable_balances/000000001b53636a29ca25d28d1c5bb165f55280167d53cfefb0ce297d98032b32f772d0/transactions{?cursor,limit,order}","templated":true},"operations":{"href":"https://horizon.stellar.org/claimable_balances/000000001b53636a29ca25d28d1c5bb165f55280167d53cfefb0ce297d98032b32f772d0/operations{?cursor,limit,order}","templated":true}},"id":"000000001b53636a29ca25d28d1c5bb165f55280167d53cfefb0ce297d98032b32f772d0","asset":"native","amount":"4.2696061","sponsor":"GA5WWLUYCR4XJKS4ZYKWATKC7E3AVM3FZLWXWSKOBZWAGDROF5MUQXAT","last_modified_ledger":35686528,"last_modified_time":"2021-06-01T13:29:59Z","claimants":[{"destination":"GD54EZPKQCBZKPI6F4KKYYLGLDWBOVKPXBL3BLFGYNCLTBFGFZZGVMRT","predicate":{"unconditional":true}},{"destination":"GA5WWLUYCR4XJKS4ZYKWATKC7E3AVM3FZLWXWSKOBZWAGDROF5MUQXAT","predicate":{"unconditional":true}}],"flags":{"clawback_enabled":false},"paging_token":"35686528-000000001b53636a29ca25d28d1c5bb165f55280167d53cfefb0ce297d98032b32f772d0"},{"_links":{"self":{"href":"https://horizon.stellar.org/claimable_balances/00000000ff1bb4a01b1d4e62ba23bcfd4e2c2289c63fe5ae0368f85b79d74a2224f8ab6c"},"transactions":{"href":"https://horizon.stellar.org/claimable_balances/00000000ff1bb4a01b1d4e62ba23bcfd4e2c2289c63fe5ae0368f85b79d74a2224f8ab6c/transactions{?cursor,limit,order}","templated":true},"operations":{"href":"https://horizon.stellar.org/claimable_balances/00000000ff1bb4a01b1d4e62ba23bcfd4e2c2289c63fe5ae0368f85b79d74a2224f8ab6c/operations{?cursor,limit,order}","templated":true}},"id":"00000000ff1bb4a01b1d4e62ba23bcfd4e2c2289c63fe5ae0368f85b79d74a2224f8ab6c","asset":"native","amount":"29.8872425","sponsor":"GA5WWLUYCR4XJKS4ZYKWATKC7E3AVM3FZLWXWSKOBZWAGDROF5MUQXAT","last_modified_ledger":35686528,"last_modified_time":"2021-06-01T13:29:59Z","claimants":[{"destination":"GB2QQWOA32GRILAOZ57H5Z5MO52KNUO3WHJWVZZHWSN66LLDPXQMSILD","predicate":{"unconditional":true}},{"destination":"GA5WWLUYCR4XJKS4ZYKWATKC7E3AVM3FZLWXWSKOBZWAGDROF5MUQXAT","predicate":{"unconditional":true}}],"flags":{"clawback_enabled":false},"paging_token":"35686528-00000000ff1bb4a01b1d4e62ba23bcfd4e2c2289c63fe5ae0368f85b79d74a2224f8ab6c"},{"_links":{"self":{"href":"https://horizon.stellar.org/claimable_balances/0000000017b9a95e25aa60200b52cc04f75c496dca76dc19fec21c942dfb35cce23c3eba"},"transactions":{"href":"https://horizon.stellar.org/claimable_balances/0000000017b9a95e25aa60200b52cc04f75c496dca76dc19fec21c942dfb35cce23c3eba/transactions{?cursor,limit,order}","templated":true},"operations":{"href":"https://horizon.stellar.org/claimable_balances/0000000017b9a95e25aa60200b52cc04f75c496dca76dc19fec21c942dfb35cce23c3eba/operations{?cursor,limit,order}","templated":true}},"id":"0000000017b9a95e25aa60200b52cc04f75c496dca76dc19fec21c942dfb35cce23c3eba","asset":"native","amount":"0.0000400","sponsor":"GB6DNEWWSSPQAX7SR5MCWUTRVQPJBAERJTUQAZOVXXJDU2E6PIMKGMO2","last_modified_ledger":35938300,"last_modified_time":"2021-06-17T10:37:03Z","claimants":[{"destination":"GC2CMMOQ2BUFI33PPOLNJKMQYJGAXUP2KMZXEXE6TGE37JSXQPHI4UAE","predicate":{"and":[{"abs_before":"2021-07-16T21:00:00Z","abs_before_epoch":"1626469200"},{"abs_before":"2021-08-16T21:00:00Z","abs_before_epoch":"1629147600"}]}}],"flags":{"clawback_enabled":false},"paging_token":"35938300-0000000017b9a95e25aa60200b52cc04f75c496dca76dc19fec21c942dfb35cce23c3eba"}]}}}}}}}},"method":"get","path":"/claimable_balances","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 Claimable Balances","description":{"content":"This endpoint lists all available claimable balances.","type":"text/plain"},"url":{"path":["claimable_balances"],"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":""},{"description":{"content":"Account ID of the destination address. Only include claimable balances which can be claimed by the given account ID.","type":"text/plain"},"key":"claimant","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/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/list-all-effects.api.mdx b/api/horizon/resources/list-all-effects.api.mdx similarity index 99% rename from api/resources/list-all-effects.api.mdx rename to api/horizon/resources/list-all-effects.api.mdx index 0a50ea11e..345968977 100644 --- a/api/resources/list-all-effects.api.mdx +++ b/api/horizon/resources/list-all-effects.api.mdx @@ -7,7 +7,7 @@ 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"}]}}}}}}}},"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/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/list-all-ledgers.api.mdx b/api/horizon/resources/list-all-ledgers.api.mdx similarity index 99% rename from api/resources/list-all-ledgers.api.mdx rename to api/horizon/resources/list-all-ledgers.api.mdx index 7a387ea8d..9a70d460b 100644 --- a/api/resources/list-all-ledgers.api.mdx +++ b/api/horizon/resources/list-all-ledgers.api.mdx @@ -7,7 +7,7 @@ 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="}}}}}}}}},"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/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/list-all-operations.api.mdx b/api/horizon/resources/list-all-operations.api.mdx similarity index 99% rename from api/resources/list-all-operations.api.mdx rename to api/horizon/resources/list-all-operations.api.mdx index 81e30d650..2d0bd1db2 100644 --- a/api/resources/list-all-operations.api.mdx +++ b/api/horizon/resources/list-all-operations.api.mdx @@ -7,7 +7,7 @@ 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}]}}}}}}}},"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/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/list-all-payments.api.mdx b/api/horizon/resources/list-all-payments.api.mdx similarity index 99% rename from api/resources/list-all-payments.api.mdx rename to api/horizon/resources/list-all-payments.api.mdx index e7f8dc144..dd5b6566c 100644 --- a/api/resources/list-all-payments.api.mdx +++ b/api/horizon/resources/list-all-payments.api.mdx @@ -7,7 +7,7 @@ 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"}]}}}}}}}},"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/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/list-all-transactions.api.mdx b/api/horizon/resources/list-all-transactions.api.mdx similarity index 99% rename from api/resources/list-all-transactions.api.mdx rename to api/horizon/resources/list-all-transactions.api.mdx index 6c1050a91..c1409cb72 100644 --- a/api/resources/list-all-transactions.api.mdx +++ b/api/horizon/resources/list-all-transactions.api.mdx @@ -7,7 +7,7 @@ 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=="]}]}}}}}}}},"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/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/list-liquidity-pools.api.mdx b/api/horizon/resources/list-liquidity-pools.api.mdx similarity index 99% rename from api/resources/list-liquidity-pools.api.mdx rename to api/horizon/resources/list-liquidity-pools.api.mdx index fc6c2f5a5..295f7ab53 100644 --- a/api/resources/list-liquidity-pools.api.mdx +++ b/api/horizon/resources/list-liquidity-pools.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"tags":["Liquidity Pools"],"description":"This endpoint lists all available liquidity pools.","operationId":"ListLiquidityPools","parameters":[{"name":"reserves","in":"query","required":false,"description":"Comma-separated list of assets in canonical form (Code:IssuerAccountID), to only include liquidity pools which have reserves matching all listed assets."},{"name":"account","in":"query","required":false,"description":"A Stellar account ID, to only include liquidity pools in which this account is participating in (i.e. holds pool shares to)."},{"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}}],"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":{"id":{"type":"string","title":"id"},"paging_token":{"type":"string","title":"paging_token"},"fee_bp":{"type":"integer","format":"uint32"},"type":{"type":"string"},"total_trustlines":{"type":"string"},"total_shares":{"type":"string"},"reserves":{"type":"object","properties":{"asset":{"type":"string"},"amount":{"type":"string"}}},"last_modified_ledger":{"type":"string"},"last_modified_time":{"type":"string"}},"required":["id","paging_token","fee_bp","type","total_trustlines","total_shares","reserves","last_modified_ledger","last_modified_time"]}}}}},"title":"LiquidityPools"}]},"examples":{"ListLiquidityPools":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/liquidity_pools?cursor=&limit=10&order=asc"},"next":{"href":"https://horizon.stellar.org/liquidity_pools?cursor=66835-00000000c582697b67cbec7f9ce64f4dc67bfb2bfd26318bb9f964f4d70e3f41f650b1e6&limit=10&order=asc"},"prev":{"href":"https://horizon.stellar.org/liquidity_pools?cursor=38888-00000000929b20b72e5890ab51c24f1cc46fa01c4f318d8d33367d24dd614cfdf5491072&limit=10&order=desc"}},"_embedded":{"records":[{"id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9","paging_token":"113725249324879873","fee_bp":30,"type":"constant_product","total_trustlines":"300","total_shares":"5000","reserves":[{"amount":"1000.0000005","asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"},{"amount":"2000.0000000","asset":"PHP:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"}]},{"id":"14be5a5b3d3f5e1e74380ab0a3bf9c172b7246fdf7753b172cbacd4d66143c08","paging_token":"113725249324879874","fee_bp":30,"type":"constant_product","total_trustlines":"200","total_shares":"3500","reserves":[{"amount":"1000.0000005","asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"},{"amount":"1200.0000000","asset":"USDC:GC5W3BH2MQRQK2H4A6LP3SXDSAAY2W2W64OWKKVNQIAOVWSAHFDEUSDC"}]}]}}}}}}}},"method":"get","path":"/liquidity_pools","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 Liquidity Pools","description":{"content":"This endpoint lists all available liquidity pools.","type":"text/plain"},"url":{"path":["liquidity_pools"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"Comma-separated list of assets in canonical form (Code:IssuerAccountID), to only include liquidity pools which have reserves matching all listed assets.","type":"text/plain"},"key":"reserves","value":""},{"description":{"content":"A Stellar account ID, to only include liquidity pools in which this account is participating in (i.e. holds pool shares to).","type":"text/plain"},"key":"account","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/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/list-strict-receive-payment-paths.api.mdx b/api/horizon/resources/list-strict-receive-payment-paths.api.mdx similarity index 99% rename from api/resources/list-strict-receive-payment-paths.api.mdx rename to api/horizon/resources/list-strict-receive-payment-paths.api.mdx index a2be6bb56..f2faa9856 100644 --- a/api/resources/list-strict-receive-payment-paths.api.mdx +++ b/api/horizon/resources/list-strict-receive-payment-paths.api.mdx @@ -7,7 +7,7 @@ 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"}]}]}}}}}}}},"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/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/list-strict-send-payment-paths.api.mdx b/api/horizon/resources/list-strict-send-payment-paths.api.mdx similarity index 99% rename from api/resources/list-strict-send-payment-paths.api.mdx rename to api/horizon/resources/list-strict-send-payment-paths.api.mdx index c1f8cc4a4..06a02a78f 100644 --- a/api/resources/list-strict-send-payment-paths.api.mdx +++ b/api/horizon/resources/list-strict-send-payment-paths.api.mdx @@ -7,7 +7,7 @@ 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":[]}]}}}}}}}},"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/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/list-trade-aggregations.api.mdx b/api/horizon/resources/list-trade-aggregations.api.mdx similarity index 99% rename from api/resources/list-trade-aggregations.api.mdx rename to api/horizon/resources/list-trade-aggregations.api.mdx index 35371e6c9..ee80f0761 100644 --- a/api/resources/list-trade-aggregations.api.mdx +++ b/api/horizon/resources/list-trade-aggregations.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"tags":["Trade Aggregations"],"description":"This endpoint displays trade data based on filters set in the arguments.This is done by dividing a given time range into segments and aggregating statistics, for a given asset pair (base, counter) over each of these segments. The duration of the segments is specified with the resolution parameter. The start and end of the time range are given by startTime and endTime respectively, which are both rounded to the nearest multiple of resolution since epoch. The individual segments are also aligned with multiples of resolution since epoch. If you want to change this alignment, the segments can be offset by specifying the offset parameter.","operationId":"ListTradeAggregations","parameters":[{"name":"start_time","in":"query","required":false,"description":"The lower time boundary represented as milliseconds since epoch.","schema":{"type":"integer","format":"long"}},{"name":"end_time","in":"query","required":false,"description":"The upper time boundary represented as milliseconds since epoch.","schema":{"type":"integer","format":"long"}},{"name":"resolution","in":"query","required":false,"description":"The segment duration represented as milliseconds. Supported values are 1 minute (60000), 5 minutes (300000), 15 minutes (900000), 1 hour (3600000), 1 day (86400000) and 1 week (604800000).","schema":{"type":"integer","format":"long"}},{"name":"offset","in":"query","required":false,"description":"Segments can be offset using this parameter. Expressed in milliseconds. Can only be used if the resolution is greater than 1 hour. Value must be in whole hours, less than the provided resolution, and less than 24 hours.","schema":{"type":"number","format":"long"}},{"name":"base_asset_type","in":"path","required":true,"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":"path","required":true,"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":"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}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"timestamp":{"type":"string"},"trade_count":{"type":"string"},"base_volume":{"type":"string"},"counter_volume":{"type":"string"},"avg":{"type":"string"},"high":{"type":"string"},"high_r":{"type":"object","properties":{"n":{"type":"string"},"d":{"type":"string"}},"title":"tradePrice"},"low":{"type":"string"},"low_r":{"type":"object","properties":{"n":{"type":"string"},"d":{"type":"string"}},"title":"tradePrice"},"open":{"type":"string"},"open_r":{"type":"object","properties":{"n":{"type":"string"},"d":{"type":"string"}},"title":"tradePrice"},"close":{"type":"string"},"close_r":{"type":"object","properties":{"n":{"type":"string"},"d":{"type":"string"}},"title":"tradePrice"}}}}}}},"title":"TradeAggregation"},"examples":{"ListTradeAggregations":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/trade_aggregations?base_asset_type=native&counter_asset_code=EURT&counter_asset_issuer=GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S&counter_asset_type=credit_alphanum4&resolution=3600000&start_time=1582156800000&end_time=1582178400001"},"next":{"href":"https://horizon.stellar.org/trade_aggregations?base_asset_type=native&counter_asset_code=EURT&counter_asset_issuer=GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S&counter_asset_type=credit_alphanum4&end_time=1582178400001&resolution=3600000&start_time=1582171200000"},"prev":{"href":""}},"_embedded":{"records":[{"timestamp":1582164000000,"trade_count":3,"base_volume":"399.3873200","counter_volume":"25.5368082","avg":"0.0639400","high":"0.0652169","high_r":{"N":652169,"D":10000000},"low":"0.0638338","low_r":{"N":8107550,"D":127010393},"open":"0.0652169","open_r":{"N":652169,"D":10000000},"close":"0.0638338","close_r":{"N":8107550,"D":127010393}},{"timestamp":1582167600000,"trade_count":1,"base_volume":"149.8415320","counter_volume":"9.7149804","avg":"0.0648350","high":"0.0648350","high_r":{"N":5000000,"D":77118803},"low":"0.0648350","low_r":{"N":5000000,"D":77118803},"open":"0.0648350","open_r":{"N":5000000,"D":77118803},"close":"0.0648350","close_r":{"N":5000000,"D":77118803}}]}}}}}}}},"method":"get","path":"/trade_aggregations{base_asset_type}{counter_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/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/lp-retrieve-related-operations.api.mdx b/api/horizon/resources/lp-retrieve-related-operations.api.mdx similarity index 99% rename from api/resources/lp-retrieve-related-operations.api.mdx rename to api/horizon/resources/lp-retrieve-related-operations.api.mdx index 98a805f74..8469bafae 100644 --- a/api/resources/lp-retrieve-related-operations.api.mdx +++ b/api/horizon/resources/lp-retrieve-related-operations.api.mdx @@ -7,7 +7,7 @@ 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"}]}}}}}}}},"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/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/lp-retrieve-related-transactions.api.mdx b/api/horizon/resources/lp-retrieve-related-transactions.api.mdx similarity index 99% rename from api/resources/lp-retrieve-related-transactions.api.mdx rename to api/horizon/resources/lp-retrieve-related-transactions.api.mdx index 3043077da..16ae6a509 100644 --- a/api/resources/lp-retrieve-related-transactions.api.mdx +++ b/api/horizon/resources/lp-retrieve-related-transactions.api.mdx @@ -7,7 +7,7 @@ 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=="]}]}}}}}}}},"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/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/offers/index.mdx b/api/horizon/resources/offers/index.mdx similarity index 88% rename from api/resources/offers/index.mdx rename to api/horizon/resources/offers/index.mdx index 38fc775a4..bc80dfdc5 100644 --- a/api/resources/offers/index.mdx +++ b/api/horizon/resources/offers/index.mdx @@ -7,7 +7,7 @@ import { EndpointsTable } from "@site/src/components/EndpointsTable"; Offers are statements about how much of an asset an account wants to buy or sell. -Learn more about [offers](../../../docs/glossary/#decentralized-exchange). +Learn more about [offers](/docs/glossary/#decentralized-exchange). diff --git a/api/resources/offers/object.mdx b/api/horizon/resources/offers/object.mdx similarity index 100% rename from api/resources/offers/object.mdx rename to api/horizon/resources/offers/object.mdx diff --git a/api/resources/operations/index.mdx b/api/horizon/resources/operations/index.mdx similarity index 100% rename from api/resources/operations/index.mdx rename to api/horizon/resources/operations/index.mdx diff --git a/api/resources/operations/object/account-merge.mdx b/api/horizon/resources/operations/object/account-merge.mdx similarity index 100% rename from api/resources/operations/object/account-merge.mdx rename to api/horizon/resources/operations/object/account-merge.mdx diff --git a/api/resources/operations/object/allow-trust.mdx b/api/horizon/resources/operations/object/allow-trust.mdx similarity index 100% rename from api/resources/operations/object/allow-trust.mdx rename to api/horizon/resources/operations/object/allow-trust.mdx diff --git a/api/resources/operations/object/begin-sponsoring-future-reserves.mdx b/api/horizon/resources/operations/object/begin-sponsoring-future-reserves.mdx similarity index 100% rename from api/resources/operations/object/begin-sponsoring-future-reserves.mdx rename to api/horizon/resources/operations/object/begin-sponsoring-future-reserves.mdx diff --git a/api/resources/operations/object/bump-sequence.mdx b/api/horizon/resources/operations/object/bump-sequence.mdx similarity index 100% rename from api/resources/operations/object/bump-sequence.mdx rename to api/horizon/resources/operations/object/bump-sequence.mdx diff --git a/api/resources/operations/object/buy-offer.mdx b/api/horizon/resources/operations/object/buy-offer.mdx similarity index 100% rename from api/resources/operations/object/buy-offer.mdx rename to api/horizon/resources/operations/object/buy-offer.mdx diff --git a/api/resources/operations/object/change-trust.mdx b/api/horizon/resources/operations/object/change-trust.mdx similarity index 100% rename from api/resources/operations/object/change-trust.mdx rename to api/horizon/resources/operations/object/change-trust.mdx diff --git a/api/resources/operations/object/claim-claimable-balance.mdx b/api/horizon/resources/operations/object/claim-claimable-balance.mdx similarity index 100% rename from api/resources/operations/object/claim-claimable-balance.mdx rename to api/horizon/resources/operations/object/claim-claimable-balance.mdx diff --git a/api/resources/operations/object/create-account.mdx b/api/horizon/resources/operations/object/create-account.mdx similarity index 100% rename from api/resources/operations/object/create-account.mdx rename to api/horizon/resources/operations/object/create-account.mdx diff --git a/api/resources/operations/object/create-claimable-balance.mdx b/api/horizon/resources/operations/object/create-claimable-balance.mdx similarity index 100% rename from api/resources/operations/object/create-claimable-balance.mdx rename to api/horizon/resources/operations/object/create-claimable-balance.mdx diff --git a/api/resources/operations/object/end-sponsoring-future-reserves.mdx b/api/horizon/resources/operations/object/end-sponsoring-future-reserves.mdx similarity index 100% rename from api/resources/operations/object/end-sponsoring-future-reserves.mdx rename to api/horizon/resources/operations/object/end-sponsoring-future-reserves.mdx diff --git a/api/resources/operations/object/index.mdx b/api/horizon/resources/operations/object/index.mdx similarity index 100% rename from api/resources/operations/object/index.mdx rename to api/horizon/resources/operations/object/index.mdx diff --git a/api/resources/operations/object/liquidity-pool-deposit.mdx b/api/horizon/resources/operations/object/liquidity-pool-deposit.mdx similarity index 94% rename from api/resources/operations/object/liquidity-pool-deposit.mdx rename to api/horizon/resources/operations/object/liquidity-pool-deposit.mdx index 4357dd1d9..bb50252dc 100644 --- a/api/resources/operations/object/liquidity-pool-deposit.mdx +++ b/api/horizon/resources/operations/object/liquidity-pool-deposit.mdx @@ -8,7 +8,7 @@ import { AttributeTable } from "@site/src/components/AttributeTable"; Deposit asset reserves into a liquidity pool. -See the [`Liquidity Pool Deposit` operation](../../../../docs/fundamentals-and-concepts/list-of-operations#liquidity-pool-deposit) for parameters, errors, etc. +See the [`Liquidity Pool Deposit` operation](/docs/fundamentals-and-concepts/list-of-operations#liquidity-pool-deposit) for parameters, errors, etc. diff --git a/api/resources/operations/object/liquidity-pool-withdraw.mdx b/api/horizon/resources/operations/object/liquidity-pool-withdraw.mdx similarity index 93% rename from api/resources/operations/object/liquidity-pool-withdraw.mdx rename to api/horizon/resources/operations/object/liquidity-pool-withdraw.mdx index e7edfec1d..3da3da7f0 100644 --- a/api/resources/operations/object/liquidity-pool-withdraw.mdx +++ b/api/horizon/resources/operations/object/liquidity-pool-withdraw.mdx @@ -8,7 +8,7 @@ import { AttributeTable } from "@site/src/components/AttributeTable"; Withdraws asset reserves from a liquidity pool by redeeming pool shares. -See the [`Liquidity Pool Withdraw` operation](../../../../../docs/fundamentals-and-concepts/list-of-operations#liquidity-pool-withdraw) for parameters, errors, etc. +See the [`Liquidity Pool Withdraw` operation](/docs/fundamentals-and-concepts/list-of-operations#liquidity-pool-withdraw) for parameters, errors, etc. diff --git a/api/resources/operations/object/manage-data.mdx b/api/horizon/resources/operations/object/manage-data.mdx similarity index 100% rename from api/resources/operations/object/manage-data.mdx rename to api/horizon/resources/operations/object/manage-data.mdx diff --git a/api/resources/operations/object/passive-sell-offer.mdx b/api/horizon/resources/operations/object/passive-sell-offer.mdx similarity index 100% rename from api/resources/operations/object/passive-sell-offer.mdx rename to api/horizon/resources/operations/object/passive-sell-offer.mdx diff --git a/api/resources/operations/object/path-payment-strict-receive.mdx b/api/horizon/resources/operations/object/path-payment-strict-receive.mdx similarity index 100% rename from api/resources/operations/object/path-payment-strict-receive.mdx rename to api/horizon/resources/operations/object/path-payment-strict-receive.mdx diff --git a/api/resources/operations/object/path-payment-strict-send.mdx b/api/horizon/resources/operations/object/path-payment-strict-send.mdx similarity index 100% rename from api/resources/operations/object/path-payment-strict-send.mdx rename to api/horizon/resources/operations/object/path-payment-strict-send.mdx diff --git a/api/resources/operations/object/payment.mdx b/api/horizon/resources/operations/object/payment.mdx similarity index 100% rename from api/resources/operations/object/payment.mdx rename to api/horizon/resources/operations/object/payment.mdx diff --git a/api/resources/operations/object/revoke-sponsorship.mdx b/api/horizon/resources/operations/object/revoke-sponsorship.mdx similarity index 100% rename from api/resources/operations/object/revoke-sponsorship.mdx rename to api/horizon/resources/operations/object/revoke-sponsorship.mdx diff --git a/api/resources/operations/object/sell-offer.mdx b/api/horizon/resources/operations/object/sell-offer.mdx similarity index 100% rename from api/resources/operations/object/sell-offer.mdx rename to api/horizon/resources/operations/object/sell-offer.mdx diff --git a/api/resources/operations/object/set-options.mdx b/api/horizon/resources/operations/object/set-options.mdx similarity index 100% rename from api/resources/operations/object/set-options.mdx rename to api/horizon/resources/operations/object/set-options.mdx diff --git a/api/resources/retrieve-a-claimable-balance.api.mdx b/api/horizon/resources/retrieve-a-claimable-balance.api.mdx similarity index 99% rename from api/resources/retrieve-a-claimable-balance.api.mdx rename to api/horizon/resources/retrieve-a-claimable-balance.api.mdx index f3a148c19..36a724620 100644 --- a/api/resources/retrieve-a-claimable-balance.api.mdx +++ b/api/horizon/resources/retrieve-a-claimable-balance.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"tags":["Claimable Balances"],"description":"The single claimable balance endpoint provides information on a claimable balance.","operationId":"RetrieveAClaimableBalance","parameters":[{"name":"claimable_balance_id","in":"path","required":true,"description":"A unique identifier for this claimable balance.","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"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"},"transactions":{"type":"object","properties":{"href":{"type":"string","format":"link"},"templated":{"type":"boolean"}},"required":["href"],"title":"link"}},"required":["self","operations","transactions"]},"id":{"type":"string","title":"id"},"asset":{"type":"string"},"amount":{"type":"string"},"sponsor":{"type":"string"},"last_modified_ledger":{"type":"string"},"last_modified_time":{"type":"string"},"claimants":{"type":"array","items":{"type":"object","properties":{"destination":{"type":"string","pattern":"G[A-Z0-9]{55}","title":"address"},"predicate":{"type":"object","properties":{"and":{"type":"array","items":{"type":"object","properties":{"or":{"type":"array","items":{"type":"object","properties":{"relBefore":{"type":"string"},"absBefore":{"type":"string"},"absBeforeEpoch":{"type":"string"}}}},"not":{"type":"object","properties":{"unconditional":{"type":"boolean"},"relBefore":{"type":"string"},"absBefore":{"type":"string"},"absBeforeEpoch":{"type":"string"}}}}}}}}}}},"flags":{"type":"integer"},"paging_token":{"type":"string"}},"required":["id","paging_token","asset","amount","last_modified_ledger","last_modified_time"],"title":"ClaimableBalance"},"examples":{"RetrieveAClaimableBalance":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/claimable_balances/000000000102030000000000000000000000000000000000000000000000000000000000"},"operations":{"href":"https://horizon.stellar.org/claimable_balances/000000000102030000000000000000000000000000000000000000000000000000000000/operations{?cursor,limit,order}","templated":true},"transactions":{"href":"https://horizon.stellar.org/claimable_balances/000000000102030000000000000000000000000000000000000000000000000000000000/transactions{?cursor,limit,order}","templated":true}},"id":"000000000102030000000000000000000000000000000000000000000000000000000000","paging_token":"000000000102030000000000000000000000000000000000000000000000000000000000","asset":"native","amount":"10.0000000","claimants":[{"destination":"GC3C4AKRBQLHOJ45U4XG35ESVWRDECWO5XLDGYADO6DPR3L7KIDVUMML","predicate":{"and":[{"or":[{"relBefore":"12"},{"absBefore":"2020-08-26T11:15:39Z","absBeforeEpoch":"1598440539"}]},{"not":{"unconditional":true}}]}}],"last_modified_ledger":28411995,"last_modified_time":"2020-02-26T19:29:16Z"}}}}}}},"method":"get","path":"/claimable_balances/{claimable_balance_id}","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 a Claimable Balance","description":{"content":"The single claimable balance endpoint provides information on a claimable balance.","type":"text/plain"},"url":{"path":["claimable_balances",":claimable_balance_id"],"host":["{{baseUrl}}"],"query":[],"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/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/retrieve-a-ledger.api.mdx b/api/horizon/resources/retrieve-a-ledger.api.mdx similarity index 99% rename from api/resources/retrieve-a-ledger.api.mdx rename to api/horizon/resources/retrieve-a-ledger.api.mdx index 68dfa52ee..7f964f242 100644 --- a/api/resources/retrieve-a-ledger.api.mdx +++ b/api/horizon/resources/retrieve-a-ledger.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"tags":["Ledgers"],"description":"The single ledger endpoint provides information on a specific ledger.","operationId":"RetrieveALedger","parameters":[{"name":"sequence","in":"path","required":true,"description":"The sequence number of a specific ledger.","schema":{"type":"integer","example":0}}],"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":{"RetrieveALedger":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/ledgers/27146933"},"transactions":{"href":"https://horizon.stellar.org/ledgers/27146933/transactions{?cursor,limit,order}","templated":true},"operations":{"href":"https://horizon.stellar.org/ledgers/27146933/operations{?cursor,limit,order}","templated":true},"payments":{"href":"https://horizon.stellar.org/ledgers/27146933/payments{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/ledgers/27146933/effects{?cursor,limit,order}","templated":true}},"id":"e1218a337cecda05526fba902c61d3d7130baa58d8db41f544bf563f779b6329","paging_token":"116595189421703168","hash":"e1218a337cecda05526fba902c61d3d7130baa58d8db41f544bf563f779b6329","prev_hash":"9eac16fecd885147067b58b7684f60d216f931b813f651265bbc97de4cea313d","sequence":27146933,"successful_transaction_count":26,"failed_transaction_count":9,"operation_count":67,"closed_at":"2019-12-06T22:39:32Z","total_coins":"105443902087.3472865","fee_pool":"1807264.7509661","base_fee_in_stroops":100,"base_reserve_in_stroops":5000000,"max_tx_set_size":1000,"protocol_version":12,"header_xdr":"AAAADJ6sFv7NiFFHBntYt2hPYNIW+TG4E/ZRJlu8l95M6jE9bsvzId+Gtul2mNMW4UZQ+KqSb/nbN8F1CTxAfQsyUy8AAAAAXerYpAAAAAAAAAAAXQNpS8daKGZUeY5quYUcIiJZBMB7LiLsZJsEx9qw79fx99Bu/lk+sIePNUNcuOC2euthzfhLuWJ1nZBuoQFDjgGeOrUOoh6z7HlbYQAAEG/dvCadAAABFgAAAAAIOwAqAAAAZABMS0AAAAPooSNtHXJNJKKWlBtgkAM1LBxzlzYjIlS0xwpjP+uCi76fQj59wgTy0+xtx7O1qTb+W6zcI2zWZnrUU/8v8RZHFBfoo20QYKh95+wWr348yZAexZpdrjhyCxbChxlVTZOX6nZfIgcYBMnZRkOTCLdPO76yeqpDhqu9KrPe3YPTO3wAAAAA"}}}}}}},"method":"get","path":"/ledgers/{sequence}","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 a Ledger","description":{"content":"The single ledger endpoint provides information on a specific ledger.","type":"text/plain"},"url":{"path":["ledgers",":sequence"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The sequence number of a specific ledger.","type":"text/plain"},"type":"any","value":"","key":"sequence"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" -info_path: api/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/retrieve-a-ledgers-effects.api.mdx b/api/horizon/resources/retrieve-a-ledgers-effects.api.mdx similarity index 99% rename from api/resources/retrieve-a-ledgers-effects.api.mdx rename to api/horizon/resources/retrieve-a-ledgers-effects.api.mdx index 0ec4265ce..adc3545ec 100644 --- a/api/resources/retrieve-a-ledgers-effects.api.mdx +++ b/api/horizon/resources/retrieve-a-ledgers-effects.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"tags":["Ledgers"],"description":"This endpoint returns the effects of a specific ledger.","operationId":"RetrieveALedgersEffects","parameters":[{"name":"sequence","in":"path","required":true,"description":"The sequence number of a specific ledger.","schema":{"type":"integer","example":0}},{"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}}],"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":{"RetrieveALedgersEffects":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/ledgers/0/effects?cursor=&limit=10&order=asc"},"next":{"href":"https://horizon.stellar.org/ledgers/0/effects?cursor=33676838572034-1&limit=10&order=asc"},"prev":{"href":"https://horizon.stellar.org/ledgers/0/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"}]}}}}}}}},"method":"get","path":"/ledgers/{sequence}/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 a Ledgers's Effects","description":{"content":"This endpoint returns the effects of a specific ledger.","type":"text/plain"},"url":{"path":["ledgers",":sequence","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) The sequence number of a specific ledger.","type":"text/plain"},"type":"any","value":"","key":"sequence"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" -info_path: api/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/retrieve-a-ledgers-operations.api.mdx b/api/horizon/resources/retrieve-a-ledgers-operations.api.mdx similarity index 99% rename from api/resources/retrieve-a-ledgers-operations.api.mdx rename to api/horizon/resources/retrieve-a-ledgers-operations.api.mdx index c1f3cf54e..2a5bd87bc 100644 --- a/api/resources/retrieve-a-ledgers-operations.api.mdx +++ b/api/horizon/resources/retrieve-a-ledgers-operations.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"tags":["Ledgers"],"description":"This endpoint returns successful operations in a specific ledger.","operationId":"RetrieveALedgersOperations","parameters":[{"name":"sequence","in":"path","required":true,"description":"The sequence number of a specific ledger.","schema":{"type":"integer","example":0}},{"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."}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"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":{"RetrieveALedgersOperations":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/ledgers/27147222/operations?cursor=&limit=2&order=asc"},"next":{"href":"https://horizon.stellar.org/ledgers/27147222/operations?cursor=116596430667259905&limit=2&order=asc"},"prev":{"href":"https://horizon.stellar.org/ledgers/27147222/operations?cursor=116596430667255809&limit=2&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/operations/116596430667255809"},"transaction":{"href":"https://horizon.stellar.org/transactions/3a644389bbec63dd2b107a03c16711563fc549daa7b7f56f951a2e470f81f2e0"},"effects":{"href":"https://horizon.stellar.org/operations/116596430667255809/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=116596430667255809"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=116596430667255809"}},"id":"116596430667255809","paging_token":"116596430667255809","transaction_successful":true,"source_account":"GDQWI6FKB72DPOJE4CGYCFQZKRPQQIOYXRMZ5KEVGXMG6UUTGJMBCASH","type":"payment","type_i":1,"created_at":"2019-12-06T23:05:38Z","transaction_hash":"3a644389bbec63dd2b107a03c16711563fc549daa7b7f56f951a2e470f81f2e0","asset_type":"credit_alphanum4","asset_code":"NODL","asset_issuer":"GB2Y3AWXVROM2BHFQKQPTWKIOI3TZEBBD3LTKTVQTKEPXGOBE742NODL","from":"GDQWI6FKB72DPOJE4CGYCFQZKRPQQIOYXRMZ5KEVGXMG6UUTGJMBCASH","to":"GAD35Y7AEQYS4WNZND5OV7HQ6ALBDDNTNFO2TN2CM4ERE7ZV4FJBNXZ6","amount":"0.0000077"},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/116596430667259905"},"transaction":{"href":"https://horizon.stellar.org/transactions/83eabfa824b57436eda49bb9ac28675285f6d945325f69db41792078a83d3479"},"effects":{"href":"https://horizon.stellar.org/operations/116596430667259905/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=116596430667259905"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=116596430667259905"}},"id":"116596430667259905","paging_token":"116596430667259905","transaction_successful":true,"source_account":"GBE63IHPHXHKQHIF7L5P5MGOV4MMDYE6RGZCJYWJPBRQZDJ5MOAPOX7A","type":"manage_offer","type_i":3,"created_at":"2019-12-06T23:05:38Z","transaction_hash":"83eabfa824b57436eda49bb9ac28675285f6d945325f69db41792078a83d3479","amount":"0.0000023","price":"0.0484621","price_r":{"n":484621,"d":10000000},"buying_asset_type":"native","selling_asset_type":"credit_alphanum4","selling_asset_code":"RMT","selling_asset_issuer":"GDEGOXPCHXWFYY234D2YZSPEJ24BX42ESJNVHY5H7TWWQSYRN5ZKZE3N","offer_id":0}]}}}}}}}},"method":"get","path":"/ledgers/{sequence}/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 a Ledger's Operations","description":{"content":"This endpoint returns successful operations in a specific ledger.","type":"text/plain"},"url":{"path":["ledgers",":sequence","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) The sequence number of a specific ledger.","type":"text/plain"},"type":"any","value":"","key":"sequence"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" -info_path: api/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/retrieve-a-ledgers-payments.api.mdx b/api/horizon/resources/retrieve-a-ledgers-payments.api.mdx similarity index 99% rename from api/resources/retrieve-a-ledgers-payments.api.mdx rename to api/horizon/resources/retrieve-a-ledgers-payments.api.mdx index 178dd32af..a57401165 100644 --- a/api/resources/retrieve-a-ledgers-payments.api.mdx +++ b/api/horizon/resources/retrieve-a-ledgers-payments.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"tags":["Ledgers"],"description":"This endpoint returns all payment-related operations in a specific ledger. Operation types that can be returned by this endpoint include: create_account, payment, path_payment, and account_merge.","operationId":"RetrieveALedgersPayments","parameters":[{"name":"sequence","in":"path","required":true,"description":"The sequence number of a specific ledger.","schema":{"type":"integer","example":0}},{"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."}],"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":{"RetrieveALedgersPayments":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/ledgers/27521176/payments?cursor=&limit=1&order=asc"},"next":{"href":"https://horizon.stellar.org/ledgers/27521176/payments?cursor=118202550867476481&limit=1&order=asc"},"prev":{"href":"https://horizon.stellar.org/ledgers/27521176/payments?cursor=118202550867476481&limit=1&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/operations/118202550867476481"},"transaction":{"href":"https://horizon.stellar.org/transactions/971454b84a82baa38afa975e9eb4ff2632821b5a3e7f7993a7e20bbd9d7633ea"},"effects":{"href":"https://horizon.stellar.org/operations/118202550867476481/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=118202550867476481"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=118202550867476481"}},"id":"118202550867476481","paging_token":"118202550867476481","transaction_successful":true,"source_account":"GDQWI6FKB72DPOJE4CGYCFQZKRPQQIOYXRMZ5KEVGXMG6UUTGJMBCASH","type":"payment","type_i":1,"created_at":"2019-12-30T22:35:49Z","transaction_hash":"971454b84a82baa38afa975e9eb4ff2632821b5a3e7f7993a7e20bbd9d7633ea","asset_type":"credit_alphanum4","asset_code":"NODL","asset_issuer":"GB2Y3AWXVROM2BHFQKQPTWKIOI3TZEBBD3LTKTVQTKEPXGOBE742NODL","from":"GDQWI6FKB72DPOJE4CGYCFQZKRPQQIOYXRMZ5KEVGXMG6UUTGJMBCASH","to":"GDGJS7AXAUFDZARIRDVZ5V7CFW6XY47WSBE2OVLCCGCDWOE7INKYN3PS","amount":"0.0000017"}]}}}}}}}},"method":"get","path":"/ledgers/{sequence}/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 a Ledger's Payments","description":{"content":"This endpoint returns all payment-related operations in a specific ledger. Operation types that can be returned by this endpoint include: create_account, payment, path_payment, and account_merge.","type":"text/plain"},"url":{"path":["ledgers",":sequence","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) The sequence number of a specific ledger.","type":"text/plain"},"type":"any","value":"","key":"sequence"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" -info_path: api/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/retrieve-a-ledgers-transactions.api.mdx b/api/horizon/resources/retrieve-a-ledgers-transactions.api.mdx similarity index 99% rename from api/resources/retrieve-a-ledgers-transactions.api.mdx rename to api/horizon/resources/retrieve-a-ledgers-transactions.api.mdx index 7c1463cad..c03bdacf4 100644 --- a/api/resources/retrieve-a-ledgers-transactions.api.mdx +++ b/api/horizon/resources/retrieve-a-ledgers-transactions.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"tags":["Ledgers"],"description":"This endpoint represents successful transactions in a given ledger.","operationId":"RetrieveALedgersTransactions","parameters":[{"name":"sequence","in":"path","required":true,"description":"The sequence number of a specific ledger.","schema":{"type":"integer","example":0}},{"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]}}],"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":{"RetrieveALedgersTransactions":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/ledgers/27147222/transactions?cursor=&limit=2&order=asc"},"next":{"href":"https://horizon.stellar.org/ledgers/27147222/transactions?cursor=116596430667259904&limit=2&order=asc"},"prev":{"href":"https://horizon.stellar.org/ledgers/27147222/transactions?cursor=116596430667255808&limit=2&order=desc"}},"_embedded":{"records":[{"memo":"FadBcV0owHrsLQif/V2TxZKGA2YiX+MoifI7oB/UjJM=","_links":{"self":{"href":"https://horizon.stellar.org/transactions/3a644389bbec63dd2b107a03c16711563fc549daa7b7f56f951a2e470f81f2e0"},"account":{"href":"https://horizon.stellar.org/accounts/GBKTEASNXABG2NC4TY6N3IA5UFC6YW53Y4KTIKY3CUEKQ2W5EIYRMYVB"},"ledger":{"href":"https://horizon.stellar.org/ledgers/27147222"},"operations":{"href":"https://horizon.stellar.org/transactions/3a644389bbec63dd2b107a03c16711563fc549daa7b7f56f951a2e470f81f2e0/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/3a644389bbec63dd2b107a03c16711563fc549daa7b7f56f951a2e470f81f2e0/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=116596430667255808"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=116596430667255808"}},"id":"3a644389bbec63dd2b107a03c16711563fc549daa7b7f56f951a2e470f81f2e0","paging_token":"116596430667255808","successful":true,"hash":"3a644389bbec63dd2b107a03c16711563fc549daa7b7f56f951a2e470f81f2e0","ledger":27147222,"created_at":"2019-12-06T23:05:38Z","source_account":"GBKTEASNXABG2NC4TY6N3IA5UFC6YW53Y4KTIKY3CUEKQ2W5EIYRMYVB","source_account_sequence":"113943107245989112","fee_charged":100,"max_fee":100,"operation_count":1,"envelope_xdr":"AAAAAFUyAk24Am00XJ483aAdoUXsW7vHFTQrGxUIqGrdIjEWAAAAZAGUzqcAAFz4AAAAAQAAAAAAAAAAAAAAAAAAAAAAAAADFadBcV0owHrsLQif/V2TxZKGA2YiX+MoifI7oB/UjJMAAAABAAAAAQAAAADhZHiqD/Q3uSTgjYEWGVRfCCHYvFmeqJU12G9SkzJYEQAAAAEAAAAAB77j4CQxLlm5aPrq/PDwFhGNs2ldqbdCZwkSfzXhUhYAAAABTk9ETAAAAAB1jYLXrFzNBOWCoPnZSHI3PJAhHtc1TrCaiPuZwSf5pgAAAAAAAABNAAAAAAAAAALw9Tl2AAAAQLSLnL3XT3F6dq5m2WHZ7tH3HBrK/e+p2G7Hrl3WXQToUsgxKIRH6bhHT/mIWwnrfLZ9nlVjMCFoZPqVKrI2lgLdIjEWAAAAQCrZ9IbjDAB408VgQaqNpwX8hXr/OUsoEexkWGkN9PjcBG2nf4bKWdbjiaqHZ+LrvM+DdmhxtA3L9bzmCie8NgA=","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAABAAAAAAAAAAA=","result_meta_xdr":"AAAAAQAAAAIAAAADAZ471gAAAAAAAAAAVTICTbgCbTRcnjzdoB2hRexbu8cVNCsbFQioat0iMRYAAAAAB5tToAGUzqcAAFz3AAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAZ471gAAAAAAAAAAVTICTbgCbTRcnjzdoB2hRexbu8cVNCsbFQioat0iMRYAAAAAB5tToAGUzqcAAFz4AAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAABAAAAAMBnju+AAAAAQAAAAAHvuPgJDEuWblo+ur88PAWEY2zaV2pt0JnCRJ/NeFSFgAAAAFOT0RMAAAAAHWNgtesXM0E5YKg+dlIcjc8kCEe1zVOsJqI+5nBJ/mmAAAAAAAIP38ASptjhEiAAAAAAAEAAAAAAAAAAAAAAAEBnjvWAAAAAQAAAAAHvuPgJDEuWblo+ur88PAWEY2zaV2pt0JnCRJ/NeFSFgAAAAFOT0RMAAAAAHWNgtesXM0E5YKg+dlIcjc8kCEe1zVOsJqI+5nBJ/mmAAAAAAAIP8wASptjhEiAAAAAAAEAAAAAAAAAAAAAAAMBnjvVAAAAAQAAAADhZHiqD/Q3uSTgjYEWGVRfCCHYvFmeqJU12G9SkzJYEQAAAAFOT0RMAAAAAHWNgtesXM0E5YKg+dlIcjc8kCEe1zVOsJqI+5nBJ/mmAAAALEhqMpZ//////////wAAAAEAAAAAAAAAAAAAAAEBnjvWAAAAAQAAAADhZHiqD/Q3uSTgjYEWGVRfCCHYvFmeqJU12G9SkzJYEQAAAAFOT0RMAAAAAHWNgtesXM0E5YKg+dlIcjc8kCEe1zVOsJqI+5nBJ/mmAAAALEhqMkl//////////wAAAAEAAAAAAAAAAA==","fee_meta_xdr":"AAAAAgAAAAMBnjvKAAAAAAAAAABVMgJNuAJtNFyePN2gHaFF7Fu7xxU0KxsVCKhq3SIxFgAAAAAHm1QEAZTOpwAAXPcAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBnjvWAAAAAAAAAABVMgJNuAJtNFyePN2gHaFF7Fu7xxU0KxsVCKhq3SIxFgAAAAAHm1OgAZTOpwAAXPcAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"hash","signatures":["tIucvddPcXp2rmbZYdnu0fccGsr976nYbseuXdZdBOhSyDEohEfpuEdP+YhbCet8tn2eVWMwIWhk+pUqsjaWAg==","Ktn0huMMAHjTxWBBqo2nBfyFev85SygR7GRYaQ30+NwEbad/hspZ1uOJqodn4uu8z4N2aHG0Dcv1vOYKJ7w2AA=="],"valid_after":"1970-01-01T00:00:00Z"},{"_links":{"self":{"href":"https://horizon.stellar.org/transactions/83eabfa824b57436eda49bb9ac28675285f6d945325f69db41792078a83d3479"},"account":{"href":"https://horizon.stellar.org/accounts/GDUHYA43LEQWXLJ5GQGNDJHZY6TZN2OK3KA4YQXQ47BRMRDRIUUC4IU5"},"ledger":{"href":"https://horizon.stellar.org/ledgers/27147222"},"operations":{"href":"https://horizon.stellar.org/transactions/83eabfa824b57436eda49bb9ac28675285f6d945325f69db41792078a83d3479/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/83eabfa824b57436eda49bb9ac28675285f6d945325f69db41792078a83d3479/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=116596430667259904"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=116596430667259904"}},"id":"83eabfa824b57436eda49bb9ac28675285f6d945325f69db41792078a83d3479","paging_token":"116596430667259904","successful":true,"hash":"83eabfa824b57436eda49bb9ac28675285f6d945325f69db41792078a83d3479","ledger":27147222,"created_at":"2019-12-06T23:05:38Z","source_account":"GDUHYA43LEQWXLJ5GQGNDJHZY6TZN2OK3KA4YQXQ47BRMRDRIUUC4IU5","source_account_sequence":"113383696345604336","fee_charged":100,"max_fee":100,"operation_count":1,"envelope_xdr":"AAAAAOh8A5tZIWutPTQM0aT5x6eW6cragcxC8OfDFkRxRSguAAAAZAGS0d8AACDwAAAAAQAAAAAAAAAAAAAAAF3q3zYAAAAAAAAAAQAAAAEAAAAASe2g7z3OqB0F+vr+sM6vGMHgnomyJOLJeGMMjT1jgPcAAAADAAAAAVJNVAAAAAAAyGdd4j3sXGNb4PWMyeROuBvzRJJbU+On/O1oSxFvcqwAAAAAAAAAAAAAABcAB2UNAJiWgAAAAAAAAAAAAAAAAAAAAAJxRSguAAAAQG/ksOk2naI/PrA/6qes3c0IhoOpnBghd038S62rayiophPSs3HyUbgbOEpYQCkJezrf1bP+s2fFXVCEXbgveQk9Y4D3AAAAQAINPdxGV1VIeQ1OUDDlqtrSy8FrWQ/+CtRxqVHcHg98SYh5co/gd83R4IGDxukCByTbYapkrUOD0XDJKC/hcg4=","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAADAAAAAAAAAAAAAAACAAAAAA==","result_meta_xdr":"AAAAAQAAAAIAAAADAZ471gAAAAAAAAAA6HwDm1kha609NAzRpPnHp5bpytqBzELw58MWRHFFKC4AAAAAAKovMAGS0d8AACDvAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAZ471gAAAAAAAAAA6HwDm1kha609NAzRpPnHp5bpytqBzELw58MWRHFFKC4AAAAAAKovMAGS0d8AACDwAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAAAA==","fee_meta_xdr":"AAAAAgAAAAMBnjukAAAAAAAAAADofAObWSFrrT00DNGk+cenlunK2oHMQvDnwxZEcUUoLgAAAAAAqi+UAZLR3wAAIO8AAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEBnjvWAAAAAAAAAADofAObWSFrrT00DNGk+cenlunK2oHMQvDnwxZEcUUoLgAAAAAAqi8wAZLR3wAAIO8AAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"none","signatures":["b+Sw6Tadoj8+sD/qp6zdzQiGg6mcGCF3TfxLratrKKimE9KzcfJRuBs4SlhAKQl7Ot/Vs/6zZ8VdUIRduC95CQ==","Ag093EZXVUh5DU5QMOWq2tLLwWtZD/4K1HGpUdweD3xJiHlyj+B3zdHggYPG6QIHJNthqmStQ4PRcMkoL+FyDg=="],"valid_after":"1970-01-01T00:00:00Z","valid_before":"2019-12-06T23:07:34Z"}]}}}}}}}},"method":"get","path":"/ledgers/{sequence}/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 a Ledger's Transactions","description":{"content":"This endpoint represents successful transactions in a given ledger.","type":"text/plain"},"url":{"path":["ledgers",":sequence","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) The sequence number of a specific ledger.","type":"text/plain"},"type":"any","value":"","key":"sequence"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" -info_path: api/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/retrieve-a-liquidity-pool.api.mdx b/api/horizon/resources/retrieve-a-liquidity-pool.api.mdx similarity index 99% rename from api/resources/retrieve-a-liquidity-pool.api.mdx rename to api/horizon/resources/retrieve-a-liquidity-pool.api.mdx index cd18c1ff0..f777461d7 100644 --- a/api/resources/retrieve-a-liquidity-pool.api.mdx +++ b/api/horizon/resources/retrieve-a-liquidity-pool.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"tags":["Liquidity Pools"],"description":"The single liquidity pool endpoint provides information on a liquidity pool.","operationId":"RetrieveALiquidityPool","parameters":[{"name":"liquidity_pool_id","in":"path","required":true,"description":"A unique identifier for this liquidity pool."}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"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"}},"required":["self","operations","transactions"]},"id":{"type":"string","title":"id"},"paging_token":{"type":"string","title":"paging_token"},"fee_bp":{"type":"integer","format":"uint32"},"type":{"type":"string"},"total_trustlines":{"type":"string"},"total_shares":{"type":"string"},"reserves":{"type":"object","properties":{"asset":{"type":"string"},"amount":{"type":"string"}}},"last_modified_ledger":{"type":"string"},"last_modified_time":{"type":"string"}},"required":["id","paging_token","fee_bp","type","total_trustlines","total_shares","reserves","last_modified_ledger","last_modified_time"],"title":"LiquidityPool"},"examples":{"RetrieveALiquidityPool":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/liquidity_pools/67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9"},"effects":{"href":"https://horizon.stellar.org/liquidity_pools/67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9/effects{?cursor,limit,order}","templated":true},"operations":{"href":"https://horizon.stellar.org/liquidity_pools/67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9/operations{?cursor,limit,order}","templated":true},"transactions":{"href":"https://horizon.stellar.org/liquidity_pools/67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9/transactions{?cursor,limit,order}","templated":true}},"id":"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9","paging_token":"113725249324879873","fee_bp":30,"type":"constant_product","total_trustlines":"300","total_shares":"5000","reserves":[{"amount":"1000.0000005","asset":"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"},{"amount":"2000.0000000","asset":"PHP:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"}]}}}}}}},"method":"get","path":"/liquidity_pools/{liquidity_pool_id}","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 a Liquidity Pool","description":{"content":"The single liquidity pool endpoint provides information on a liquidity pool.","type":"text/plain"},"url":{"path":["liquidity_pools",":liquidity_pool_id"],"host":["{{baseUrl}}"],"query":[],"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/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/retrieve-a-transaction.api.mdx b/api/horizon/resources/retrieve-a-transaction.api.mdx similarity index 99% rename from api/resources/retrieve-a-transaction.api.mdx rename to api/horizon/resources/retrieve-a-transaction.api.mdx index 3348026ff..7fc33b1fd 100644 --- a/api/resources/retrieve-a-transaction.api.mdx +++ b/api/horizon/resources/retrieve-a-transaction.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"tags":["Transactions"],"description":"The single transaction endpoint provides information on a specific transaction.","operationId":"RetrieveATransaction","parameters":[{"name":"transaction_hash","in":"path","required":true,"description":"Transactions are commands that modify the ledger state and consist of one or more operations.","schema":{"type":"string","example":"5ebd5c0af4385500b53dd63b0ef5f6e8feef1a7e1c86989be3cdcce825f3c0cc"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"_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"}},"required":["self","account","ledger","operations","effects","precedes","succeeds"]},"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"}},"title":"schemas-Transaction"},"examples":{"RetrieveATransaction":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/transactions/5ebd5c0af4385500b53dd63b0ef5f6e8feef1a7e1c86989be3cdcce825f3c0cc"},"account":{"href":"https://horizon.stellar.org/accounts/GDI5EK4HNMBHJJQGP3GUXQJIIOHU2CJO3LABPWD6WYSPJZP5NP67TMNN"},"ledger":{"href":"https://horizon.stellar.org/ledgers/27963785"},"operations":{"href":"https://horizon.stellar.org/transactions/5ebd5c0af4385500b53dd63b0ef5f6e8feef1a7e1c86989be3cdcce825f3c0cc/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/transactions/5ebd5c0af4385500b53dd63b0ef5f6e8feef1a7e1c86989be3cdcce825f3c0cc/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon.stellar.org/transactions?order=asc&cursor=120103542047408128"},"succeeds":{"href":"https://horizon.stellar.org/transactions?order=desc&cursor=120103542047408128"}},"id":"5ebd5c0af4385500b53dd63b0ef5f6e8feef1a7e1c86989be3cdcce825f3c0cc","paging_token":"120103542047408128","successful":true,"hash":"5ebd5c0af4385500b53dd63b0ef5f6e8feef1a7e1c86989be3cdcce825f3c0cc","ledger":27963785,"created_at":"2020-01-28T10:03:33Z","source_account":"GDI5EK4HNMBHJJQGP3GUXQJIIOHU2CJO3LABPWD6WYSPJZP5NP67TMNN","source_account_sequence":"65046128646685383","fee_charged":100,"max_fee":100,"operation_count":1,"envelope_xdr":"AAAAANHSK4drAnSmBn7NS8EoQ49NCS7awBfYfrYk9OX9a/35AAAAZADnFxwAAALHAAAAAAAAAAAAAAABAAAAAQAAAADR0iuHawJ0pgZ+zUvBKEOPTQku2sAX2H62JPTl/Wv9+QAAAAEAAAAA+qpaPAsU/CGcSeS4KnvqE9y+Bcjhyr1l6jiwixRsvu8AAAABTkdOVAAAAAAs4YIuYne69wMuNtfiZ64gb7E3qnTR7A4yD4jZDSS8AQAAAdGpSiAAAAAAAAAAAAH9a/35AAAAQM5LSBiFRQKtFYRPpNabwVuvIhZSVRDaajf0KzYaqJmgaXAlFaTOYyYc11YuxUM1Fzl1VT4UEbI22BvO/8HzUgQ=","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAABAAAAAAAAAAA=","result_meta_xdr":"AAAAAQAAAAIAAAADAaqxiQAAAAAAAAAA0dIrh2sCdKYGfs1LwShDj00JLtrAF9h+tiT05f1r/fkAAAAAAhWQlADnFxwAAALGAAAAAQAAAAEAAAAAhD8BLsZFQEF33rKS6YopQUT3b6iLBG4nspe68/DBNBYAAAAAAAAAAAEAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEBqrGJAAAAAAAAAADR0iuHawJ0pgZ+zUvBKEOPTQku2sAX2H62JPTl/Wv9+QAAAAACFZCUAOcXHAAAAscAAAABAAAAAQAAAACEPwEuxkVAQXfespLpiilBRPdvqIsEbieyl7rz8ME0FgAAAAAAAAAAAQAAAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAQAAAADAan62gAAAAEAAAAA+qpaPAsU/CGcSeS4KnvqE9y+Bcjhyr1l6jiwixRsvu8AAAABTkdOVAAAAAAs4YIuYne69wMuNtfiZ64gb7E3qnTR7A4yD4jZDSS8AQAAAAAAAAALf/////////8AAAABAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEBqrGJAAAAAQAAAAD6qlo8CxT8IZxJ5Lgqe+oT3L4FyOHKvWXqOLCLFGy+7wAAAAFOR05UAAAAACzhgi5id7r3Ay421+JnriBvsTeqdNHsDjIPiNkNJLwBAAAB0alKIAt//////////wAAAAEAAAABAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAwGp+6EAAAABAAAAANHSK4drAnSmBn7NS8EoQ49NCS7awBfYfrYk9OX9a/35AAAAAU5HTlQAAAAALOGCLmJ3uvcDLjbX4meuIG+xN6p00ewOMg+I2Q0kvAEAAAkQQwRXzX//////////AAAAAQAAAAEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAaqxiQAAAAEAAAAA0dIrh2sCdKYGfs1LwShDj00JLtrAF9h+tiT05f1r/fkAAAABTkdOVAAAAAAs4YIuYne69wMuNtfiZ64gb7E3qnTR7A4yD4jZDSS8AQAABz6ZujfNf/////////8AAAABAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA==","fee_meta_xdr":"AAAAAgAAAAMBqfuhAAAAAAAAAADR0iuHawJ0pgZ+zUvBKEOPTQku2sAX2H62JPTl/Wv9+QAAAAACFZD4AOcXHAAAAsYAAAABAAAAAQAAAACEPwEuxkVAQXfespLpiilBRPdvqIsEbieyl7rz8ME0FgAAAAAAAAAAAQAAAAAAAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQGqsYkAAAAAAAAAANHSK4drAnSmBn7NS8EoQ49NCS7awBfYfrYk9OX9a/35AAAAAAIVkJQA5xccAAACxgAAAAEAAAABAAAAAIQ/AS7GRUBBd96ykumKKUFE92+oiwRuJ7KXuvPwwTQWAAAAAAAAAAABAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=","memo_type":"none","signatures":["zktIGIVFAq0VhE+k1pvBW68iFlJVENpqN/QrNhqomaBpcCUVpM5jJhzXVi7FQzUXOXVVPhQRsjbYG87/wfNSBA=="]}}}}}}},"method":"get","path":"/transactions/{transaction_hash}","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 a Transaction","description":{"content":"The single transaction endpoint provides information on a specific transaction.","type":"text/plain"},"url":{"path":["transactions",":transaction_hash"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) Transactions are commands that modify the ledger state and consist of one or more operations.","type":"text/plain"},"type":"any","value":"","key":"transaction_hash"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" -info_path: api/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/retrieve-a-transactions-effects.api.mdx b/api/horizon/resources/retrieve-a-transactions-effects.api.mdx similarity index 99% rename from api/resources/retrieve-a-transactions-effects.api.mdx rename to api/horizon/resources/retrieve-a-transactions-effects.api.mdx index 7bf434132..4233c0e7b 100644 --- a/api/resources/retrieve-a-transactions-effects.api.mdx +++ b/api/horizon/resources/retrieve-a-transactions-effects.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"tags":["Transactions"],"description":"This endpoint returns the effects of a specific transaction.","operationId":"RetrieveATransactionsEffects","parameters":[{"name":"transaction_hash","in":"path","required":true,"description":"Transactions are commands that modify the ledger state and consist of one or more operations.","schema":{"type":"string","example":"5ebd5c0af4385500b53dd63b0ef5f6e8feef1a7e1c86989be3cdcce825f3c0cc"}},{"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}}],"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":{"RetrieveATransactionsEffects":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/transactions/512a9946bc7ff4a363299f14f79e0beb9b9cdbd0103e3a69a44446a0aa6471a8/effects?cursor=&limit=10&order=asc"},"next":{"href":"https://horizon.stellar.org/transactions/512a9946bc7ff4a363299f14f79e0beb9b9cdbd0103e3a69a44446a0aa6471a8/effects?cursor=121628667754319873-2&limit=10&order=asc"},"prev":{"href":"https://horizon.stellar.org/transactions/512a9946bc7ff4a363299f14f79e0beb9b9cdbd0103e3a69a44446a0aa6471a8/effects?cursor=121628667754319873-1&limit=10&order=desc"}},"_embedded":{"records":[{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/121628667754319873"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=121628667754319873-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=121628667754319873-1"}},"id":"0121628667754319873-0000000001","paging_token":"121628667754319873-1","account":"GAHK7EEG2WWHVKDNT4CEQFZGKF2LGDSW2IVM4S5DP42RBW3K6BTODB4A","type":"account_credited","type_i":2,"created_at":"2020-02-20T21:18:33Z","asset_type":"native","amount":"1573.5112616"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/121628667754319873"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=121628667754319873-2"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=121628667754319873-2"}},"id":"0121628667754319873-0000000002","paging_token":"121628667754319873-2","account":"GA2XP4KMY4KWNPW4KUCUKYUF2J7Y6HO5HLPUEA3VPVSMYCM3TGNEZP5S","type":"account_debited","type_i":3,"created_at":"2020-02-20T21:18:33Z","asset_type":"native","amount":"1573.5112616"}]}}}}}}}},"method":"get","path":"/transactions/{transaction_hash}/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 a Transaction's Effects","description":{"content":"This endpoint returns the effects of a specific transaction.","type":"text/plain"},"url":{"path":["transactions",":transaction_hash","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) Transactions are commands that modify the ledger state and consist of one or more operations.","type":"text/plain"},"type":"any","value":"","key":"transaction_hash"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" -info_path: api/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/retrieve-a-transactions-operations.api.mdx b/api/horizon/resources/retrieve-a-transactions-operations.api.mdx similarity index 99% rename from api/resources/retrieve-a-transactions-operations.api.mdx rename to api/horizon/resources/retrieve-a-transactions-operations.api.mdx index 479053c14..c0b28e513 100644 --- a/api/resources/retrieve-a-transactions-operations.api.mdx +++ b/api/horizon/resources/retrieve-a-transactions-operations.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"tags":["Transactions"],"description":"This endpoint returns Successful operations for a specific transaction.","operationId":"RetrieveATransactionsOperations","parameters":[{"name":"transaction_hash","in":"path","required":true,"description":"Transactions are commands that modify the ledger state and consist of one or more operations.","schema":{"type":"string","example":"5ebd5c0af4385500b53dd63b0ef5f6e8feef1a7e1c86989be3cdcce825f3c0cc"}},{"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."}],"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":{"RetrieveATransactionsOperations":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/transactions/6b983a4e0dc3c04f4bd6b9037c55f70a09c434dfd01492be1077cf7ea68c2e4a/operations?cursor=&limit=10&order=asc"},"next":{"href":"https://horizon.stellar.org/transactions/6b983a4e0dc3c04f4bd6b9037c55f70a09c434dfd01492be1077cf7ea68c2e4a/operations?cursor=120133379185221636&limit=10&order=asc"},"prev":{"href":"https://horizon.stellar.org/transactions/6b983a4e0dc3c04f4bd6b9037c55f70a09c434dfd01492be1077cf7ea68c2e4a/operations?cursor=120133379185221633&limit=10&order=desc"}},"_embedded":{"records":[{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120133379185221633"},"transaction":{"href":"https://horizon.stellar.org/transactions/6b983a4e0dc3c04f4bd6b9037c55f70a09c434dfd01492be1077cf7ea68c2e4a"},"effects":{"href":"https://horizon.stellar.org/operations/120133379185221633/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120133379185221633"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120133379185221633"}},"id":"120133379185221633","paging_token":"120133379185221633","transaction_successful":true,"source_account":"GDJX67SFY2N73H72TWMKKBQP5UPBNKBNUMNE2IGFKNES43S4327X6DHG","type":"manage_buy_offer","type_i":12,"created_at":"2020-01-28T21:14:59Z","transaction_hash":"6b983a4e0dc3c04f4bd6b9037c55f70a09c434dfd01492be1077cf7ea68c2e4a","amount":"0.0000000","price":"0.0001000","price_r":{"n":1,"d":10000},"buying_asset_type":"native","selling_asset_type":"credit_alphanum4","selling_asset_code":"ETH","selling_asset_issuer":"GBDEVU63Y6NTHJQQZIKVTC23NWLQVP3WJ2RI2OTSJTNYOIGICST6DUXR","offer_id":149983118},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120133379185221634"},"transaction":{"href":"https://horizon.stellar.org/transactions/6b983a4e0dc3c04f4bd6b9037c55f70a09c434dfd01492be1077cf7ea68c2e4a"},"effects":{"href":"https://horizon.stellar.org/operations/120133379185221634/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120133379185221634"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120133379185221634"}},"id":"120133379185221634","paging_token":"120133379185221634","transaction_successful":true,"source_account":"GDJX67SFY2N73H72TWMKKBQP5UPBNKBNUMNE2IGFKNES43S4327X6DHG","type":"manage_buy_offer","type_i":12,"created_at":"2020-01-28T21:14:59Z","transaction_hash":"6b983a4e0dc3c04f4bd6b9037c55f70a09c434dfd01492be1077cf7ea68c2e4a","amount":"0.0000000","price":"0.0001000","price_r":{"n":1,"d":10000},"buying_asset_type":"native","selling_asset_type":"credit_alphanum4","selling_asset_code":"ETH","selling_asset_issuer":"GBDEVU63Y6NTHJQQZIKVTC23NWLQVP3WJ2RI2OTSJTNYOIGICST6DUXR","offer_id":149983119},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120133379185221635"},"transaction":{"href":"https://horizon.stellar.org/transactions/6b983a4e0dc3c04f4bd6b9037c55f70a09c434dfd01492be1077cf7ea68c2e4a"},"effects":{"href":"https://horizon.stellar.org/operations/120133379185221635/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120133379185221635"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120133379185221635"}},"id":"120133379185221635","paging_token":"120133379185221635","transaction_successful":true,"source_account":"GDJX67SFY2N73H72TWMKKBQP5UPBNKBNUMNE2IGFKNES43S4327X6DHG","type":"manage_offer","type_i":3,"created_at":"2020-01-28T21:14:59Z","transaction_hash":"6b983a4e0dc3c04f4bd6b9037c55f70a09c434dfd01492be1077cf7ea68c2e4a","amount":"98.5005752","price":"0.0003494","price_r":{"n":17471,"d":50000000},"buying_asset_type":"credit_alphanum4","buying_asset_code":"ETH","buying_asset_issuer":"GBDEVU63Y6NTHJQQZIKVTC23NWLQVP3WJ2RI2OTSJTNYOIGICST6DUXR","selling_asset_type":"native","offer_id":0},{"_links":{"self":{"href":"https://horizon.stellar.org/operations/120133379185221636"},"transaction":{"href":"https://horizon.stellar.org/transactions/6b983a4e0dc3c04f4bd6b9037c55f70a09c434dfd01492be1077cf7ea68c2e4a"},"effects":{"href":"https://horizon.stellar.org/operations/120133379185221636/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=120133379185221636"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=120133379185221636"}},"id":"120133379185221636","paging_token":"120133379185221636","transaction_successful":true,"source_account":"GDJX67SFY2N73H72TWMKKBQP5UPBNKBNUMNE2IGFKNES43S4327X6DHG","type":"manage_buy_offer","type_i":12,"created_at":"2020-01-28T21:14:59Z","transaction_hash":"6b983a4e0dc3c04f4bd6b9037c55f70a09c434dfd01492be1077cf7ea68c2e4a","amount":"291.8057980","price":"0.0002565","price_r":{"n":250039,"d":975000000},"buying_asset_type":"native","selling_asset_type":"credit_alphanum4","selling_asset_code":"ETH","selling_asset_issuer":"GBDEVU63Y6NTHJQQZIKVTC23NWLQVP3WJ2RI2OTSJTNYOIGICST6DUXR","offer_id":0}]}}}}}}}},"method":"get","path":"/transactions/{transaction_hash}/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 a Transaction's Operations","description":{"content":"This endpoint returns Successful operations for a specific transaction.","type":"text/plain"},"url":{"path":["transactions",":transaction_hash","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) Transactions are commands that modify the ledger state and consist of one or more operations.","type":"text/plain"},"type":"any","value":"","key":"transaction_hash"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" -info_path: api/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/retrieve-an-account.api.mdx b/api/horizon/resources/retrieve-an-account.api.mdx similarity index 99% rename from api/resources/retrieve-an-account.api.mdx rename to api/horizon/resources/retrieve-an-account.api.mdx index 07cc6f9d5..e3e6a0bd6 100644 --- a/api/resources/retrieve-an-account.api.mdx +++ b/api/horizon/resources/retrieve-an-account.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"tags":["Accounts"],"description":"The single account endpoint provides information on a specific account. The balances section in the response will also list all the trustlines this account has established, including trustlines that haven’t been authorized yet.","operationId":"RetrieveAnAccount","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"}}],"responses":{"200":{"description":"Returns details like balances, sponserships etc. about an account.","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":{"RetrieveAnAccount":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/accounts/GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA"},"transactions":{"href":"https://horizon.stellar.org/accounts/GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA/transactions{?cursor,limit,order}","templated":true},"operations":{"href":"https://horizon.stellar.org/accounts/GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA/operations{?cursor,limit,order}","templated":true},"payments":{"href":"https://horizon.stellar.org/accounts/GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA/payments{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon.stellar.org/accounts/GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA/effects{?cursor,limit,order}","templated":true},"offers":{"href":"https://horizon.stellar.org/accounts/GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA/offers{?cursor,limit,order}","templated":true},"trades":{"href":"https://horizon.stellar.org/accounts/GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA/trades{?cursor,limit,order}","templated":true},"data":{"href":"https://horizon.stellar.org/accounts/GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA/data/{key}","templated":true}},"id":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA","account_id":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA","sequence":"120192344791187470","subentry_count":5,"last_modified_ledger":28105812,"num_sponsoring":0,"num_sponsored":0,"thresholds":{"low_threshold":0,"med_threshold":0,"high_threshold":0},"flags":{"auth_required":false,"auth_revocable":false,"auth_immutable":false,"auth_clawback_enabled":false},"balances":[{"balance":"3.0000000","limit":"922337203685.4775807","buying_liabilities":"0.0000000","selling_liabilities":"0.0000000","last_modified_ledger":27984507,"is_authorized":true,"is_clawback_enabled":false,"asset_type":"credit_alphanum4","asset_code":"EURT","asset_issuer":"GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S"},{"balance":"4.0000000","limit":"922337203685.4775807","buying_liabilities":"0.0000000","selling_liabilities":"0.0000000","last_modified_ledger":27985131,"is_authorized":true,"is_clawback_enabled":true,"asset_type":"credit_alphanum4","asset_code":"USD","asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX"},{"balance":"72.8563792","buying_liabilities":"0.0000000","selling_liabilities":"0.0000000","asset_type":"native"}],"signers":[{"weight":1,"key":"GAYOLLLUIZE4DZMBB2ZBKGBUBZLIOYU6XFLW37GBP2VZD3ABNXCW4BVA","type":"ed25519_public_key"}],"data":{},"paging_token":""}}}}}}},"method":"get","path":"/accounts/{account_id}","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","description":{"content":"The single account endpoint provides information on a specific account. The balances section in the response will also list all the trustlines this account has established, including trustlines that haven’t been authorized yet.","type":"text/plain"},"url":{"path":["accounts",":account_id"],"host":["{{baseUrl}}"],"query":[],"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/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/retrieve-an-operation.api.mdx b/api/horizon/resources/retrieve-an-operation.api.mdx similarity index 99% rename from api/resources/retrieve-an-operation.api.mdx rename to api/horizon/resources/retrieve-an-operation.api.mdx index 8517cb93a..2cef1d7fc 100644 --- a/api/resources/retrieve-an-operation.api.mdx +++ b/api/horizon/resources/retrieve-an-operation.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"tags":["Operations"],"description":"The single operation endpoint provides information about a specific operation.","operationId":"RetrieveAnOperation","parameters":[{"name":"id","in":"path","required":true,"description":"The ID number for this operation.","schema":{"type":"string","example":121692259040116740}},{"name":"join","in":"query","required":false,"description":"Set to transactions to include the transactions which created each of the operations in the response."}],"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":{"RetrieveAnOperation":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/operations/121692259040116737"},"transaction":{"href":"https://horizon.stellar.org/transactions/f92a9648c1084d1de0fd786faac5d5e1637d4127c60841d2366c70d2e7f77b85"},"effects":{"href":"https://horizon.stellar.org/operations/121692259040116737/effects"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=121692259040116737"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=121692259040116737"}},"id":"121692259040116737","paging_token":"121692259040116737","transaction_successful":true,"source_account":"GBDVKE33GVVMBXX73OHIBRP6RAHKHHW2P4PQVV6UNOKQCOXU7GNUM4QI","type":"manage_offer","type_i":3,"created_at":"2020-02-21T20:10:21Z","transaction_hash":"f92a9648c1084d1de0fd786faac5d5e1637d4127c60841d2366c70d2e7f77b85","amount":"10000.0000000","price":"0.0704336","price_r":{"n":44021,"d":625000},"buying_asset_type":"credit_alphanum4","buying_asset_code":"USD","buying_asset_issuer":"GDUKMGUGDZQK6YHYA5Z6AY2G4XDSZPSZ3SW5UN3ARVMO6QSRDWP5YLEX","selling_asset_type":"native","offer_id":161536436}}}}}}},"method":"get","path":"/operations/{id}","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 Operation","description":{"content":"The single operation endpoint provides information about a specific operation.","type":"text/plain"},"url":{"path":["operations",":id"],"host":["{{baseUrl}}"],"query":[{"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) The ID number for this operation.","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/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/retrieve-an-operations-effects.api.mdx b/api/horizon/resources/retrieve-an-operations-effects.api.mdx similarity index 99% rename from api/resources/retrieve-an-operations-effects.api.mdx rename to api/horizon/resources/retrieve-an-operations-effects.api.mdx index f81efcf60..1dd9cad67 100644 --- a/api/resources/retrieve-an-operations-effects.api.mdx +++ b/api/horizon/resources/retrieve-an-operations-effects.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"tags":["Operations"],"description":"This endpoint returns the effects of a specific operation.","operationId":"RetrieveAnOperationsEffects","parameters":[{"name":"id","in":"path","required":true,"description":"The ID number for this operation.","schema":{"type":"string","example":121692259040116740}},{"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}}],"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":{"RetrieveAnOperationsEffects":{"value":{"_links":{"self":{"href":"https://horizon.stellar.org/operations/121693057904021505/effects?cursor=&limit=10&order=asc"},"next":{"href":"https://horizon.stellar.org/operations/121693057904021505/effects?cursor=121693057904021505-2&limit=10&order=asc"},"prev":{"href":"https://horizon.stellar.org/operations/121693057904021505/effects?cursor=121693057904021505-1&limit=10&order=desc"}},"_embedded":{"records":[{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/121693057904021505"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=121693057904021505-1"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=121693057904021505-1"}},"id":"0121693057904021505-0000000001","paging_token":"121693057904021505-1","account":"GALSPNVKGNRJ3VIOQ26QKPZBDCTVJK7XPLSPF3UVZV3JJXCKVCHNSPCK","type":"account_credited","type_i":2,"created_at":"2020-02-21T20:27:30Z","asset_type":"credit_alphanum4","asset_code":"NODL","asset_issuer":"GB2Y3AWXVROM2BHFQKQPTWKIOI3TZEBBD3LTKTVQTKEPXGOBE742NODL","amount":"0.0000027"},{"_links":{"operation":{"href":"https://horizon.stellar.org/operations/121693057904021505"},"succeeds":{"href":"https://horizon.stellar.org/effects?order=desc&cursor=121693057904021505-2"},"precedes":{"href":"https://horizon.stellar.org/effects?order=asc&cursor=121693057904021505-2"}},"id":"0121693057904021505-0000000002","paging_token":"121693057904021505-2","account":"GDQWI6FKB72DPOJE4CGYCFQZKRPQQIOYXRMZ5KEVGXMG6UUTGJMBCASH","type":"account_debited","type_i":3,"created_at":"2020-02-21T20:27:30Z","asset_type":"credit_alphanum4","asset_code":"NODL","asset_issuer":"GB2Y3AWXVROM2BHFQKQPTWKIOI3TZEBBD3LTKTVQTKEPXGOBE742NODL","amount":"0.0000027"}]}}}}}}}},"method":"get","path":"/operations/{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 Operation's Effects","description":{"content":"This endpoint returns the effects of a specific operation.","type":"text/plain"},"url":{"path":["operations",":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) The ID number for this operation.","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/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/retrieve-an-order-book.api.mdx b/api/horizon/resources/retrieve-an-order-book.api.mdx similarity index 99% rename from api/resources/retrieve-an-order-book.api.mdx rename to api/horizon/resources/retrieve-an-order-book.api.mdx index 270803b58..6228b3dd8 100644 --- a/api/resources/retrieve-an-order-book.api.mdx +++ b/api/horizon/resources/retrieve-an-order-book.api.mdx @@ -7,7 +7,7 @@ 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"}}}}}}}},"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/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/retrieve-fee-stats.api.mdx b/api/horizon/resources/retrieve-fee-stats.api.mdx similarity index 99% rename from api/resources/retrieve-fee-stats.api.mdx rename to api/horizon/resources/retrieve-fee-stats.api.mdx index 15548ea9e..aa1d72737 100644 --- a/api/resources/retrieve-fee-stats.api.mdx +++ b/api/horizon/resources/retrieve-fee-stats.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"tags":["Fee Stats"],"description":"The fee stats endpoint provides information about per-operation fee stats over the last 5 ledgers.","operationId":"RetrieveFeeStats","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"last_ledger":{"type":"string"},"last_ledger_base_fee":{"type":"string"},"ledger_capacity_usage":{"type":"string"},"fee_charged":{"type":"object","properties":{"max":{"type":"string"},"min":{"type":"string"},"mode":{"type":"string"},"p10":{"type":"string"},"p20":{"type":"string"},"p30":{"type":"string"},"p40":{"type":"string"},"p50":{"type":"string"},"p60":{"type":"string"},"p70":{"type":"string"},"p80":{"type":"string"},"p90":{"type":"string"},"p95":{"type":"string"},"p99":{"type":"string"}},"title":"FeeDistribution"},"max_fee":{"type":"object","properties":{"max":{"type":"string"},"min":{"type":"string"},"mode":{"type":"string"},"p10":{"type":"string"},"p20":{"type":"string"},"p30":{"type":"string"},"p40":{"type":"string"},"p50":{"type":"string"},"p60":{"type":"string"},"p70":{"type":"string"},"p80":{"type":"string"},"p90":{"type":"string"},"p95":{"type":"string"},"p99":{"type":"string"}},"title":"FeeDistribution"}},"title":"FeeStats"},"examples":{"RetrieveFeeStats":{"value":{"last_ledger":"43277313","last_ledger_base_fee":"100","ledger_capacity_usage":"1","fee_charged":{"max":"5500","min":"5000","mode":"5000","p10":"5000","p20":"5000","p30":"5000","p40":"5000","p50":"5001","p60":"5001","p70":"5066","p80":"5066","p90":"5500","p95":"5500","p99":"5500"},"max_fee":{"max":"616065406","min":"5000","mode":"10003","p10":"10000","p20":"10003","p30":"10003","p40":"20005","p50":"20005","p60":"50020","p70":"50020","p80":"150000","p90":"500000","p95":"500000","p99":"1490000"}}}}}}}},"method":"get","path":"/fee_stats","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 Fee Stats","description":{"content":"The fee stats endpoint provides information about per-operation fee stats over the last 5 ledgers.","type":"text/plain"},"url":{"path":["fee_stats"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" -info_path: api/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/retrieve-related-effects.api.mdx b/api/horizon/resources/retrieve-related-effects.api.mdx similarity index 99% rename from api/resources/retrieve-related-effects.api.mdx rename to api/horizon/resources/retrieve-related-effects.api.mdx index 3a3a5481d..f0257f5cf 100644 --- a/api/resources/retrieve-related-effects.api.mdx +++ b/api/horizon/resources/retrieve-related-effects.api.mdx @@ -7,7 +7,7 @@ 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"}]}}}}}}}},"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/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/retrieve-related-trades.api.mdx b/api/horizon/resources/retrieve-related-trades.api.mdx similarity index 99% rename from api/resources/retrieve-related-trades.api.mdx rename to api/horizon/resources/retrieve-related-trades.api.mdx index 64198b495..1c818b19a 100644 --- a/api/resources/retrieve-related-trades.api.mdx +++ b/api/horizon/resources/retrieve-related-trades.api.mdx @@ -7,7 +7,7 @@ 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"}]}}}}}}}},"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/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/horizon/resources/sidebar.js b/api/horizon/resources/sidebar.js new file mode 100644 index 000000000..02544f8fd --- /dev/null +++ b/api/horizon/resources/sidebar.js @@ -0,0 +1 @@ +module.exports = [{"type":"doc","id":"horizon/resources/horizon"},{"type":"category","label":"Accounts","link":{"type":"generated-index","title":"Accounts","slug":"/category/horizon/resources/accounts"},"items":[{"type":"doc","id":"horizon/resources/list-all-accounts","label":"List all Accounts","className":"api-method get"},{"type":"doc","id":"horizon/resources/retrieve-an-account","label":"Retrieve an Account","className":"api-method get"},{"type":"doc","id":"horizon/resources/get-transactions-by-account-id","label":"Retrieve an Account's Transactions","className":"api-method get"},{"type":"doc","id":"horizon/resources/get-operations-by-account-id","label":"Retrieve an Account's Operations","className":"api-method get"},{"type":"doc","id":"horizon/resources/get-payments-by-account-id","label":"Retrieve an Account's Payments","className":"api-method get"},{"type":"doc","id":"horizon/resources/get-effects-by-account-id","label":"Retrieve an Account's Effects","className":"api-method get"},{"type":"doc","id":"horizon/resources/get-offers-by-account-id","label":"Retrieve an Account's Offers","className":"api-method get"},{"type":"doc","id":"horizon/resources/get-trades-by-account-id","label":"Retrieve an Account's Trades","className":"api-method get"},{"type":"doc","id":"horizon/resources/get-data-by-account-id","label":"Retrieve an Account's Data","className":"api-method get"}]},{"type":"category","label":"Assets","link":{"type":"generated-index","title":"Assets","slug":"/category/horizon/resources/assets"},"items":[{"type":"doc","id":"horizon/resources/list-all-assets","label":"List all Assets","className":"api-method get"}]},{"type":"category","label":"Claimable Balances","link":{"type":"generated-index","title":"Claimable Balances","slug":"/category/horizon/resources/claimable-balances"},"items":[{"type":"doc","id":"horizon/resources/list-all-claimable-balances","label":"List All Claimable Balances","className":"api-method get"},{"type":"doc","id":"horizon/resources/retrieve-a-claimable-balance","label":"Retrieve a Claimable Balance","className":"api-method get"},{"type":"doc","id":"horizon/resources/cb-retrieve-related-transactions","label":"Retrieve Related Transactions","className":"api-method get"},{"type":"doc","id":"horizon/resources/cb-retrieve-related-operations","label":"Retrieve Related Operations","className":"api-method get"}]},{"type":"category","label":"Effects","link":{"type":"generated-index","title":"Effects","slug":"/category/horizon/resources/effects"},"items":[{"type":"doc","id":"horizon/resources/list-all-effects","label":"List All Effects","className":"api-method get"}]},{"type":"category","label":"Fee Stats","link":{"type":"generated-index","title":"Fee Stats","slug":"/category/horizon/resources/fee-stats"},"items":[{"type":"doc","id":"horizon/resources/retrieve-fee-stats","label":"Retrieve Fee Stats","className":"api-method get"}]},{"type":"category","label":"Liquidity Pools","link":{"type":"generated-index","title":"Liquidity Pools","slug":"/category/horizon/resources/liquidity-pools"},"items":[{"type":"doc","id":"horizon/resources/list-liquidity-pools","label":"List Liquidity Pools","className":"api-method get"},{"type":"doc","id":"horizon/resources/retrieve-a-liquidity-pool","label":"Retrieve a Liquidity Pool","className":"api-method get"},{"type":"doc","id":"horizon/resources/retrieve-related-effects","label":"Retrieve Related Effects","className":"api-method get"},{"type":"doc","id":"horizon/resources/retrieve-related-trades","label":"Retrieve Related Trades","className":"api-method get"},{"type":"doc","id":"horizon/resources/lp-retrieve-related-transactions","label":"Retrieve Related Transactions","className":"api-method get"},{"type":"doc","id":"horizon/resources/lp-retrieve-related-operations","label":"Retrieve Related Operations","className":"api-method get"}]},{"type":"category","label":"Ledgers","link":{"type":"generated-index","title":"Ledgers","slug":"/category/horizon/resources/ledgers"},"items":[{"type":"doc","id":"horizon/resources/retrieve-a-ledger","label":"Retrieve a Ledger","className":"api-method get"},{"type":"doc","id":"horizon/resources/retrieve-a-ledgers-transactions","label":"Retrieve a Ledger's Transactions","className":"api-method get"},{"type":"doc","id":"horizon/resources/retrieve-a-ledgers-payments","label":"Retrieve a Ledger's Payments","className":"api-method get"},{"type":"doc","id":"horizon/resources/retrieve-a-ledgers-operations","label":"Retrieve a Ledger's Operations","className":"api-method get"},{"type":"doc","id":"horizon/resources/retrieve-a-ledgers-effects","label":"Retrieve a Ledgers's Effects","className":"api-method get"},{"type":"doc","id":"horizon/resources/list-all-ledgers","label":"List All Ledgers","className":"api-method get"}]},{"type":"category","label":"Offers","link":{"type":"generated-index","title":"Offers","slug":"/category/horizon/resources/offers"},"items":[{"type":"doc","id":"horizon/resources/get-all-offers","label":"List All Offers","className":"api-method get"},{"type":"doc","id":"horizon/resources/get-offer-by-offer-id","label":"Retrieve an Offer","className":"api-method get"},{"type":"doc","id":"horizon/resources/get-trades-by-offer-id","label":"Retrieve an Offer's Trades","className":"api-method get"}]},{"type":"category","label":"Order Books","link":{"type":"generated-index","title":"Order Books","slug":"/category/horizon/resources/order-books"},"items":[{"type":"doc","id":"horizon/resources/retrieve-an-order-book","label":"Retrieve an Order Book","className":"api-method get"}]},{"type":"category","label":"Trade Aggregations","link":{"type":"generated-index","title":"Trade Aggregations","slug":"/category/horizon/resources/trade-aggregations"},"items":[{"type":"doc","id":"horizon/resources/list-trade-aggregations","label":"List Trade Aggregations","className":"api-method get"}]},{"type":"category","label":"Trades","link":{"type":"generated-index","title":"Trades","slug":"/category/horizon/resources/trades"},"items":[{"type":"doc","id":"horizon/resources/get-all-trades","label":"List All Trades","className":"api-method get"}]},{"type":"category","label":"Transactions","link":{"type":"generated-index","title":"Transactions","slug":"/category/horizon/resources/transactions"},"items":[{"type":"doc","id":"horizon/resources/retrieve-a-transaction","label":"Retrieve a Transaction","className":"api-method get"},{"type":"doc","id":"horizon/resources/retrieve-a-transactions-operations","label":"Retrieve a Transaction's Operations","className":"api-method get"},{"type":"doc","id":"horizon/resources/retrieve-a-transactions-effects","label":"Retrieve a Transaction's Effects","className":"api-method get"},{"type":"doc","id":"horizon/resources/list-all-transactions","label":"List All Transactions","className":"api-method get"},{"type":"doc","id":"horizon/resources/submit-a-transaction","label":"Submit a Transaction","className":"api-method post"}]},{"type":"category","label":"Operations","link":{"type":"generated-index","title":"Operations","slug":"/category/horizon/resources/operations"},"items":[{"type":"doc","id":"horizon/resources/retrieve-an-operation","label":"Retrieve an Operation","className":"api-method get"},{"type":"doc","id":"horizon/resources/retrieve-an-operations-effects","label":"Retrieve an Operation's Effects","className":"api-method get"},{"type":"doc","id":"horizon/resources/list-all-operations","label":"List All Operations","className":"api-method get"},{"type":"doc","id":"horizon/resources/list-all-payments","label":"List All Payments","className":"api-method get"}]},{"type":"category","label":"Paths","link":{"type":"generated-index","title":"Paths","slug":"/category/horizon/resources/paths"},"items":[{"type":"doc","id":"horizon/resources/list-strict-receive-payment-paths","label":"List Strict Receive Payment Paths","className":"api-method get"},{"type":"doc","id":"horizon/resources/list-strict-send-payment-paths","label":"List Strict Send Payment Paths","className":"api-method get"}]}]; \ No newline at end of file diff --git a/api/resources/submit-a-transaction.api.mdx b/api/horizon/resources/submit-a-transaction.api.mdx similarity index 99% rename from api/resources/submit-a-transaction.api.mdx rename to api/horizon/resources/submit-a-transaction.api.mdx index 82f7eb085..65c22708e 100644 --- a/api/resources/submit-a-transaction.api.mdx +++ b/api/horizon/resources/submit-a-transaction.api.mdx @@ -7,7 +7,7 @@ hide_title: true hide_table_of_contents: true api: {"tags":["Transactions"],"description":"This endpoint actually submits a transaction to the Stellar network. It only takes a single, required parameter: the signed transaction. Refer to the Transactions page for details on how to craft a proper one. If you submit a transaction that has already been included in a ledger, this endpoint will return the same response as would’ve been returned for the original transaction submission. This allows for safe resubmission of transactions in error scenarios, as highlighted in the error-handling guide.","operationId":"SubmitATransaction","parameters":[{"in":"query","name":"tx","schema":{"type":"string","description":"The base64-encoded XDR of the transaction."},"required":true}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"_embedded":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"memo":{"type":"string"},"memo_bytes":{"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":"SubmitTransaction"},"examples":{"SubmitaTransaction":{"value":{"memo":"Test Transaction","memo_bytes":"VGVzdCBUcmFuc2FjdGlvbg==","_links":{"self":{"href":"https://horizon-testnet.stellar.org/transactions/8ef0c6d60357bf91b0b0d7800b747ff02bf73117d3e017690cbff641ca67f124"},"account":{"href":"https://horizon-testnet.stellar.org/accounts/GCIHAQVWZH2AB5BB5NP63FBSIREG77LQZZNUVKD2LN2IOCLOT6N72MJN"},"ledger":{"href":"https://horizon-testnet.stellar.org/ledgers/139575"},"operations":{"href":"https://horizon-testnet.stellar.org/transactions/8ef0c6d60357bf91b0b0d7800b747ff02bf73117d3e017690cbff641ca67f124/operations{?cursor,limit,order}","templated":true},"effects":{"href":"https://horizon-testnet.stellar.org/transactions/8ef0c6d60357bf91b0b0d7800b747ff02bf73117d3e017690cbff641ca67f124/effects{?cursor,limit,order}","templated":true},"precedes":{"href":"https://horizon-testnet.stellar.org/transactions?order=asc&cursor=599470060347392"},"succeeds":{"href":"https://horizon-testnet.stellar.org/transactions?order=desc&cursor=599470060347392"},"transaction":{"href":"https://horizon-testnet.stellar.org/transactions/8ef0c6d60357bf91b0b0d7800b747ff02bf73117d3e017690cbff641ca67f124"}},"id":"8ef0c6d60357bf91b0b0d7800b747ff02bf73117d3e017690cbff641ca67f124","paging_token":"599470060347392","successful":true,"hash":"8ef0c6d60357bf91b0b0d7800b747ff02bf73117d3e017690cbff641ca67f124","ledger":139575,"created_at":"2021-03-25T21:14:11Z","source_account":"GCIHAQVWZH2AB5BB5NP63FBSIREG77LQZZNUVKD2LN2IOCLOT6N72MJN","source_account_sequence":"599336916353025","fee_account":"GCIHAQVWZH2AB5BB5NP63FBSIREG77LQZZNUVKD2LN2IOCLOT6N72MJN","fee_charged":"100","max_fee":"100","operation_count":1,"envelope_xdr":"AAAAAgAAAACQcEK2yfQA9CHrX+2UMkRIb/1wzltKqHpbdIcJbp+b/QAAAGQAAiEYAAAAAQAAAAEAAAAAAAAAAAAAAABgXP3QAAAAAQAAABBUZXN0IFRyYW5zYWN0aW9uAAAAAQAAAAAAAAABAAAAAJBwQrbJ9AD0Ietf7ZQyREhv/XDOW0qoelt0hwlun5v9AAAAAAAAAAAF9eEAAAAAAAAAAAFun5v9AAAAQKdJnG8QRiv9xGp1Oq7ACv/xR2BnNqjfUHrGNua7m4tWbrun3+GmAj6ca3xz+4ZppWRTbvTUcCxvpbHERZ85QgY=","result_xdr":"AAAAAAAAAGQAAAAAAAAAAQAAAAAAAAABAAAAAAAAAAA=","result_meta_xdr":"AAAAAgAAAAIAAAADAAIhNwAAAAAAAAAAkHBCtsn0APQh61/tlDJESG/9cM5bSqh6W3SHCW6fm/0AAAAXSHbnnAACIRgAAAAAAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAIhNwAAAAAAAAAAkHBCtsn0APQh61/tlDJESG/9cM5bSqh6W3SHCW6fm/0AAAAXSHbnnAACIRgAAAABAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAABAAAAAAAAAAA=","fee_meta_xdr":"AAAAAgAAAAMAAiEYAAAAAAAAAACQcEK2yfQA9CHrX+2UMkRIb/1wzltKqHpbdIcJbp+b/QAAABdIdugAAAIhGAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAEAAiE3AAAAAAAAAACQcEK2yfQA9CHrX+2UMkRIb/1wzltKqHpbdIcJbp+b/QAAABdIduecAAIhGAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAA==","memo_type":"text","signatures":["p0mcbxBGK/3EanU6rsAK//FHYGc2qN9QesY25rubi1Zuu6ff4aYCPpxrfHP7hmmlZFNu9NRwLG+lscRFnzlCBg=="],"valid_after":"1970-01-01T00:00:00Z","valid_before":"2021-03-25T21:17:04Z"}}}}}}},"method":"post","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":"Submit a Transaction","description":{"content":"This endpoint actually submits a transaction to the Stellar network. It only takes a single, required parameter: the signed transaction. Refer to the Transactions page for details on how to craft a proper one. If you submit a transaction that has already been included in a ledger, this endpoint will return the same response as would’ve been returned for the original transaction submission. This allows for safe resubmission of transactions in error scenarios, as highlighted in the error-handling guide.","type":"text/plain"},"url":{"path":["transactions"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"key":"tx","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"}} sidebar_class_name: "post api-method" -info_path: api/resources/horizon +info_path: api/horizon/resources/horizon custom_edit_url: null --- diff --git a/api/resources/trades/index.mdx b/api/horizon/resources/trades/index.mdx similarity index 88% rename from api/resources/trades/index.mdx rename to api/horizon/resources/trades/index.mdx index bb4f02dba..d53dcf01e 100644 --- a/api/resources/trades/index.mdx +++ b/api/horizon/resources/trades/index.mdx @@ -9,7 +9,7 @@ When an offer is fully or partially fulfilled, a trade happens. Trades can also A trade occurs between two parties—`base` and `counter`. Which is which is either arbitrary or determined by the calling query. -Learn more about [trades](../../../docs/glossary/#decentralized-exchange). +Learn more about [trades](/docs/glossary/#decentralized-exchange). diff --git a/api/resources/trades/object.mdx b/api/horizon/resources/trades/object.mdx similarity index 100% rename from api/resources/trades/object.mdx rename to api/horizon/resources/trades/object.mdx diff --git a/api/resources/transactions/index.mdx b/api/horizon/resources/transactions/index.mdx similarity index 92% rename from api/resources/transactions/index.mdx rename to api/horizon/resources/transactions/index.mdx index 71c57d6cb..a84d71fbe 100644 --- a/api/resources/transactions/index.mdx +++ b/api/horizon/resources/transactions/index.mdx @@ -7,7 +7,7 @@ import { EndpointsTable } from "@site/src/components/EndpointsTable"; Transactions are commands that modify the ledger state and consist of one or more operations. -Learn more about [transactions](../../../docs/glossary/#transaction). +Learn more about [transactions](/docs/glossary/#transaction). diff --git a/api/resources/transactions/object.mdx b/api/horizon/resources/transactions/object.mdx similarity index 94% rename from api/resources/transactions/object.mdx rename to api/horizon/resources/transactions/object.mdx index 2a12ce539..4adbf9dad 100644 --- a/api/resources/transactions/object.mdx +++ b/api/horizon/resources/transactions/object.mdx @@ -24,7 +24,7 @@ When Horizon returns information about a transaction, it uses the following form - Indicates if this transaction was successful or not. - hash - string - - A hex-encoded SHA-256 hash of this transaction’s [XDR](../../../docs/encyclopedia/xdr)-encoded form. + - A hex-encoded SHA-256 hash of this transaction’s [XDR](/docs/encyclopedia/xdr)-encoded form. - ledger - number - The sequence number of the ledger that this transaction was included in. @@ -39,10 +39,10 @@ When Horizon returns information about a transaction, it uses the following form - The source account's sequence number that this transaction consumed. - fee_charged - number - - The fee (in [stroops](../../../docs/issuing-assets/anatomy-of-an-asset#lumens-xlm)) paid by the source account to apply this transaction to the ledger. + - The fee (in [stroops](/docs/issuing-assets/anatomy-of-an-asset#lumens-xlm)) paid by the source account to apply this transaction to the ledger. - max_fee - number - - The maximum fee (in [stroops](../../../docs/issuing-assets/anatomy-of-an-asset#lumens-xlm)) that the source account was willing to pay. + - The maximum fee (in [stroops](/docs/issuing-assets/anatomy-of-an-asset#lumens-xlm)) that the source account was willing to pay. - operation_count - number - The number of operations contained within this transaction. diff --git a/api/index.mdx b/api/index.mdx new file mode 100644 index 000000000..84844ad7a --- /dev/null +++ b/api/index.mdx @@ -0,0 +1,26 @@ +--- +title: 'APIs Overview' +slug: / +--- + +We have lots of amazing APIs. Go ahead, check 'em out! + +## Horizon + +Horizon is an API for interacting with the Stellar network. + +This API serves the bridge between apps and Stellar Core. Projects like wallets, +decentralized exchanges, and asset issuers use Horizon to submit transactions, +query an account balance, or stream events like transactions to an account. + +[Learn more about the Horizon API here!](/api/horizon) + +## Anchor Platform + +The Anchor Platform is a set of tools and APIs that enable developers and +businesses to build their own on and off-ramp services for the Stellar network. +It provides a standardized interface, including the implementation of several +Stellar Ecosystem Proposals (SEPs), to make it easy for businesses to integrate +with Stellar-based wallets and exchanges. + +[Learn more about the Anchor Platform API here!](/api/anchor-platform) diff --git a/api/resources/sidebar.js b/api/resources/sidebar.js deleted file mode 100644 index f1e6ca625..000000000 --- a/api/resources/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"doc","id":"resources/horizon"},{"type":"category","label":"Accounts","link":{"type":"generated-index","title":"Accounts","slug":"/category/resources/accounts"},"items":[{"type":"doc","id":"resources/list-all-accounts","label":"List all Accounts","className":"api-method get"},{"type":"doc","id":"resources/retrieve-an-account","label":"Retrieve an Account","className":"api-method get"},{"type":"doc","id":"resources/get-transactions-by-account-id","label":"Retrieve an Account's Transactions","className":"api-method get"},{"type":"doc","id":"resources/get-operations-by-account-id","label":"Retrieve an Account's Operations","className":"api-method get"},{"type":"doc","id":"resources/get-payments-by-account-id","label":"Retrieve an Account's Payments","className":"api-method get"},{"type":"doc","id":"resources/get-effects-by-account-id","label":"Retrieve an Account's Effects","className":"api-method get"},{"type":"doc","id":"resources/get-offers-by-account-id","label":"Retrieve an Account's Offers","className":"api-method get"},{"type":"doc","id":"resources/get-trades-by-account-id","label":"Retrieve an Account's Trades","className":"api-method get"},{"type":"doc","id":"resources/get-data-by-account-id","label":"Retrieve an Account's Data","className":"api-method get"}]},{"type":"category","label":"Assets","link":{"type":"generated-index","title":"Assets","slug":"/category/resources/assets"},"items":[{"type":"doc","id":"resources/list-all-assets","label":"List all Assets","className":"api-method get"}]},{"type":"category","label":"Claimable Balances","link":{"type":"generated-index","title":"Claimable Balances","slug":"/category/resources/claimable-balances"},"items":[{"type":"doc","id":"resources/list-all-claimable-balances","label":"List All Claimable Balances","className":"api-method get"},{"type":"doc","id":"resources/retrieve-a-claimable-balance","label":"Retrieve a Claimable Balance","className":"api-method get"},{"type":"doc","id":"resources/cb-retrieve-related-transactions","label":"Retrieve Related Transactions","className":"api-method get"},{"type":"doc","id":"resources/cb-retrieve-related-operations","label":"Retrieve Related Operations","className":"api-method get"}]},{"type":"category","label":"Effects","link":{"type":"generated-index","title":"Effects","slug":"/category/resources/effects"},"items":[{"type":"doc","id":"resources/list-all-effects","label":"List All Effects","className":"api-method get"}]},{"type":"category","label":"Fee Stats","link":{"type":"generated-index","title":"Fee Stats","slug":"/category/resources/fee-stats"},"items":[{"type":"doc","id":"resources/retrieve-fee-stats","label":"Retrieve Fee Stats","className":"api-method get"}]},{"type":"category","label":"Liquidity Pools","link":{"type":"generated-index","title":"Liquidity Pools","slug":"/category/resources/liquidity-pools"},"items":[{"type":"doc","id":"resources/list-liquidity-pools","label":"List Liquidity Pools","className":"api-method get"},{"type":"doc","id":"resources/retrieve-a-liquidity-pool","label":"Retrieve a Liquidity Pool","className":"api-method get"},{"type":"doc","id":"resources/retrieve-related-effects","label":"Retrieve Related Effects","className":"api-method get"},{"type":"doc","id":"resources/retrieve-related-trades","label":"Retrieve Related Trades","className":"api-method get"},{"type":"doc","id":"resources/lp-retrieve-related-transactions","label":"Retrieve Related Transactions","className":"api-method get"},{"type":"doc","id":"resources/lp-retrieve-related-operations","label":"Retrieve Related Operations","className":"api-method get"}]},{"type":"category","label":"Ledgers","link":{"type":"generated-index","title":"Ledgers","slug":"/category/resources/ledgers"},"items":[{"type":"doc","id":"resources/retrieve-a-ledger","label":"Retrieve a Ledger","className":"api-method get"},{"type":"doc","id":"resources/retrieve-a-ledgers-transactions","label":"Retrieve a Ledger's Transactions","className":"api-method get"},{"type":"doc","id":"resources/retrieve-a-ledgers-payments","label":"Retrieve a Ledger's Payments","className":"api-method get"},{"type":"doc","id":"resources/retrieve-a-ledgers-operations","label":"Retrieve a Ledger's Operations","className":"api-method get"},{"type":"doc","id":"resources/retrieve-a-ledgers-effects","label":"Retrieve a Ledgers's Effects","className":"api-method get"},{"type":"doc","id":"resources/list-all-ledgers","label":"List All Ledgers","className":"api-method get"}]},{"type":"category","label":"Offers","link":{"type":"generated-index","title":"Offers","slug":"/category/resources/offers"},"items":[{"type":"doc","id":"resources/get-all-offers","label":"List All Offers","className":"api-method get"},{"type":"doc","id":"resources/get-offer-by-offer-id","label":"Retrieve an Offer","className":"api-method get"},{"type":"doc","id":"resources/get-trades-by-offer-id","label":"Retrieve an Offer's Trades","className":"api-method get"}]},{"type":"category","label":"Order Books","link":{"type":"generated-index","title":"Order Books","slug":"/category/resources/order-books"},"items":[{"type":"doc","id":"resources/retrieve-an-order-book","label":"Retrieve an Order Book","className":"api-method get"}]},{"type":"category","label":"Trade Aggregations","link":{"type":"generated-index","title":"Trade Aggregations","slug":"/category/resources/trade-aggregations"},"items":[{"type":"doc","id":"resources/list-trade-aggregations","label":"List Trade Aggregations","className":"api-method get"}]},{"type":"category","label":"Trades","link":{"type":"generated-index","title":"Trades","slug":"/category/resources/trades"},"items":[{"type":"doc","id":"resources/get-all-trades","label":"List All Trades","className":"api-method get"}]},{"type":"category","label":"Transactions","link":{"type":"generated-index","title":"Transactions","slug":"/category/resources/transactions"},"items":[{"type":"doc","id":"resources/retrieve-a-transaction","label":"Retrieve a Transaction","className":"api-method get"},{"type":"doc","id":"resources/retrieve-a-transactions-operations","label":"Retrieve a Transaction's Operations","className":"api-method get"},{"type":"doc","id":"resources/retrieve-a-transactions-effects","label":"Retrieve a Transaction's Effects","className":"api-method get"},{"type":"doc","id":"resources/list-all-transactions","label":"List All Transactions","className":"api-method get"},{"type":"doc","id":"resources/submit-a-transaction","label":"Submit a Transaction","className":"api-method post"}]},{"type":"category","label":"Operations","link":{"type":"generated-index","title":"Operations","slug":"/category/resources/operations"},"items":[{"type":"doc","id":"resources/retrieve-an-operation","label":"Retrieve an Operation","className":"api-method get"},{"type":"doc","id":"resources/retrieve-an-operations-effects","label":"Retrieve an Operation's Effects","className":"api-method get"},{"type":"doc","id":"resources/list-all-operations","label":"List All Operations","className":"api-method get"},{"type":"doc","id":"resources/list-all-payments","label":"List All Payments","className":"api-method get"}]},{"type":"category","label":"Paths","link":{"type":"generated-index","title":"Paths","slug":"/category/resources/paths"},"items":[{"type":"doc","id":"resources/list-strict-receive-payment-paths","label":"List Strict Receive Payment Paths","className":"api-method get"},{"type":"doc","id":"resources/list-strict-send-payment-paths","label":"List Strict Send Payment Paths","className":"api-method get"}]}]; \ No newline at end of file diff --git a/docs/anchoring-assets/anchor-platform/architecture.mdx b/docs/anchoring-assets/anchor-platform/architecture.mdx index b417bc2a5..0ee9efbdd 100644 --- a/docs/anchoring-assets/anchor-platform/architecture.mdx +++ b/docs/anchoring-assets/anchor-platform/architecture.mdx @@ -70,5 +70,5 @@ The event service is a new component that will push events to both the client an The custody server is a new component that allows businesses to connect to a custodial service (such as Fireblocks) to send and receive payments on the Stellar network. When used in self-custodial mode, this service is a next generation of the existing Stellar Observer. [seps]: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/README.md -[platform-api]: /ap_api -[callback-api]: /ap_api/callbacks +[platform-api]: /api/anchor-platform +[callback-api]: /api/anchor-platform/callbacks diff --git a/docs/anchoring-assets/anchor-platform/sep31/configuration.mdx b/docs/anchoring-assets/anchor-platform/sep31/configuration.mdx index 4b5dcc4c4..17c59458c 100644 --- a/docs/anchoring-assets/anchor-platform/sep31/configuration.mdx +++ b/docs/anchoring-assets/anchor-platform/sep31/configuration.mdx @@ -374,4 +374,4 @@ We'll define the server that implements the endpoints defined in the Callback AP [sep1-ap]: /docs/category/stellar-info-file [sep38]: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0038.md [sep38-post-quote]: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0038.md#post-quote -[platform-api-kyc]: /ap_api/callbacks/customer +[platform-api-kyc]: /api/anchor-platform/callbacks/customer diff --git a/docs/anchoring-assets/anchor-platform/sep31/integration.mdx b/docs/anchoring-assets/anchor-platform/sep31/integration.mdx index 2e1ba1a99..fb13c9a44 100644 --- a/docs/anchoring-assets/anchor-platform/sep31/integration.mdx +++ b/docs/anchoring-assets/anchor-platform/sep31/integration.mdx @@ -277,18 +277,18 @@ This endpoint may be removed in future major version updates of the Anchor Platf ::: -[ap-api]: /ap_api +[ap-api]: /api/anchor-platform [ap-sep10]: /docs/category/stellar-authentication [sep12]: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md [demo-wallet]: https://demo-wallet.stellar.org [indicative]: https://www.investopedia.com/terms/i/indicativequote.asp [firm]: https://www.investopedia.com/terms/f/firmquote.asp -[get-unique-address]: /ap_api/callbacks/gen-address -[get-customer]: /ap_api/callbacks/get-customer -[put-customer]: /ap_api/callbacks/put-customer -[get-rate]: /ap_api/callbacks/get-rates -[patch-transactions]: /ap_api/resources/patch-transactions -[get-fee]: /ap_api/callbacks/get-fee -[get-unique-address]: /ap_api/callbacks/gen-address -[put-customer-callback]: /ap_api/callbacks/put-customer-callback -[delete-customer]: /ap_api/callbacks/del-customer +[get-unique-address]: /api/anchor-platform/callbacks/gen-address +[get-customer]: /api/anchor-platform/callbacks/get-customer +[put-customer]: /api/anchor-platform/callbacks/put-customer +[get-rate]: /api/anchor-platform/callbacks/get-rates +[patch-transactions]: /api/anchor-platform/resources/patch-transactions +[get-fee]: /api/anchor-platform/callbacks/get-fee +[get-unique-address]: /api/anchor-platform/callbacks/gen-address +[put-customer-callback]: /api/anchor-platform/callbacks/put-customer-callback +[delete-customer]: /api/anchor-platform/callbacks/del-customer diff --git a/docusaurus.config.js b/docusaurus.config.js index 3a6b7b9d6..e2763f34f 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -37,24 +37,24 @@ const config = { id: "openapi", docsPluginId: "api", config: { - api: { - specPath: "openapi/bundled.yml", // Path to designated spec file - outputDir: "api/resources", // Output directory for generated .mdx docs + horizon: { + specPath: "openapi/horizon/bundled.yml", // Path to designated spec file + outputDir: "api/horizon/resources", // Output directory for generated .mdx docs sidebarOptions: { groupPathsBy: "tag", }, }, - ap_api: { - specPath: "openapi/ap/bundled.yml", // Path to designated spec file - outputDir: "ap_api/resources", // Output directory for generated .mdx docs + anchor_platform_api: { + specPath: "openapi/anchor-platform/bundled.yml", // Path to designated spec file + outputDir: "api/anchor-platform/resources", // Output directory for generated .mdx docs sidebarOptions: { groupPathsBy: "tag", }, template: "src/template.mustache", // Customize API MDX with mustache template }, - ap_callbacks: { - specPath: "openapi/ap/bundled_callback.yml", // Path to designated spec file - outputDir: "ap_api/callbacks", // Output directory for generated .mdx docs + anchor_platform_callbacks: { + specPath: "openapi/anchor-platform/bundled_callback.yml", // Path to designated spec file + outputDir: "api/anchor-platform/callbacks", // Output directory for generated .mdx docs sidebarOptions: { groupPathsBy: "tag", }, @@ -68,19 +68,7 @@ const config = { { id: "api", path: "api", - routeBasePath: "api", - docLayoutComponent: "@theme/DocPage", - docItemComponent: "@theme/ApiItem", - sidebarPath: require.resolve("./sidebarsApi.js"), - sidebarItemsGenerator: require("./src/sidebar-api-generator"), - }, - ], - [ - "@docusaurus/plugin-content-docs", - { - id: "ap_api", - path: "ap_api", - routeBasePath: "ap_api", + routeBasePath: "/api", docLayoutComponent: "@theme/DocPage", docItemComponent: "@theme/ApiItem", sidebarPath: require.resolve("./sidebarsApi.js"), @@ -142,14 +130,19 @@ const config = { position: "left", }, { - to: "/api", - label: "Horizon API", - position: "left", - }, - { - to: "/ap_api", - label: "Anchor Platform API", + type: "dropdown", + label: "APIs", position: "left", + items: [ + { + to: "/api/horizon", + label: "Horizon", + }, + { + to: "/api/anchor-platform", + label: "Anchor Platform", + }, + ] }, { href: "https://github.com/stellar/stellar-docs", diff --git a/nginx/includes/redirects.conf b/nginx/includes/redirects.conf index 268e34143..b76dc09c2 100644 --- a/nginx/includes/redirects.conf +++ b/nginx/includes/redirects.conf @@ -27,3 +27,7 @@ rewrite ^/docs/start/list-of-operations$ "/docs/fundamentals-and-concepts/list-o rewrite ^/docs/start/stellar-stack$ "/docs/fundamentals-and-concepts/stellar-stack" redirect; rewrite ^/docs/tutorials/handling-errors$ "/docs/encyclopedia/error-handling" redirect; rewrite ^/docs/tutorials/securing-projects$ "/docs/encyclopedia/securing-web-based-projects" redirect; +# moving /api/* locations to /api/horizon (leaving /api intact for the "overview page") +rewrite ^/api(/(?!horizon|anchor-platform).+)$ /api/horizon$1 redirect; +# moving /ap_api locations to /api/anchor-platform +rewrite ^/ap_api(/.*)?$ /api/anchor-platform$1 redirect; diff --git a/openapi/ap/Callbacks API.yml b/openapi/anchor-platform/Callbacks API.yml similarity index 90% rename from openapi/ap/Callbacks API.yml rename to openapi/anchor-platform/Callbacks API.yml index 2f28e006f..37bdd8315 100644 --- a/openapi/ap/Callbacks API.yml +++ b/openapi/anchor-platform/Callbacks API.yml @@ -3,8 +3,8 @@ info: version: "2.0.0" description: | The Synchronous Callbacks API specification for the Stellar Anchor Platform project. - - The Synchronous Callbacks API defines requests made by the Platform while it is processing a request from a client application. The + + The Synchronous Callbacks API defines requests made by the Platform while it is processing a request from a client application. The anchor's responses to these requests affect the Platform responses to the client application. title: Synchronous Callbacks API tags: @@ -16,21 +16,21 @@ tags: description: "Requests containing data that can be used to provide exchange rates between on & off-chain assets." - name: "Customers" description: | - [SEP-12](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md) requests made from client + [SEP-12](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md) requests made from client applications. paths: /unique_address: get: description: | - If the platform is configured with `depositInfoGeneratorType: api`, the Platform make this request to + If the platform is configured with `depositInfoGeneratorType: api`, the Platform make this request to the Anchor backend every time a transaction is initiated by a client application. The Anchor must guarantee that the memo returned in this request is unique, so it can be mapped 1-to-1 to a Platform resource such as a [SEP-31](https://stellar.org/protocol/sep-31) transaction. - + Here is how this flow would be used for Receiving Anchors that need to create their unique `(account, memo)` pairs outside the platform, using Circle: - + [![](https://mermaid.ink/img/pako:eNqlVctu2zAQ_JUFTy1iOwhyE9AUhuu0ORQ1YvdmIKDJVUSYIlWSihEY_veuRMuPhHaTVCc9VjPD4exyzYSVyDLm8U-NRuA3xR8dL-cG6AoqaMxgOp70r69g5rjxXARlDdxqu4KVCgXM2VpwrRdcLIeTu81lbRQhPXApHXo_ZxGp4i4ooSpuAkwDas1d4gMaqcwjDI0obOL7p3sUqJ6o5DNMNA-5deX5qlNII-WExvj-mLV_c3OR4slg8ms6g7XH6vpqcxn2XvgIYyuCJSPgnB2w4B4lkIGhQKi22CCsydVj7XiDF-GaK6WD9KXlTfkTwoGsf8JcvDYqg-_j2dkFfD1geFDyS5plb2U0mnDRIC0PgcNCW7EUBVcGtqCDPUqs79Ov_ZS8ewy1Mx4MriAKo_z5mKdOYlZiaeeM9lu5wVl9L1n2Zn6Qh5IUb5KWn9y6W2WUL5DSUSvdZrFJx7brDgyPDdd8e4emU1L6x7nfrznNPTjRLNtmzuAnX2LX2sT_XKIJ3U_xbf9Mb3WdIDGgCJ5i8gIKCl5VFCIJte8c-l8Xjvej82GnxdNaGyUHc2_81EjZbcPhRLwzuU2Q7YxKUjkrEIlkh0jyA9i8vc9pxvZaFd2COy-CbR93iDDSam93uhNPGD-cjX7AuptEbcenE1dJal-ZSqUPPNR-8JHk_25RW4KTiG-dz-3oSozny0zJxjFRoFi2VBG-s_l1yN_ZMq_kK9P80Q7zAeuxEulBSTpk1w3-nFF9iXOW0a3EnNc6NMfkhkqjy2OpgnUsy7n22GO8Dnb6bATLgquxK9oe1NuqzV8v2LI1)](https://mermaid.live/edit#pako:eNqlVctu2zAQ_JUFTy1iOwhyE9AUhuu0ORQ1YvdmIKDJVUSYIlWSihEY_veuRMuPhHaTVCc9VjPD4exyzYSVyDLm8U-NRuA3xR8dL-cG6AoqaMxgOp70r69g5rjxXARlDdxqu4KVCgXM2VpwrRdcLIeTu81lbRQhPXApHXo_ZxGp4i4ooSpuAkwDas1d4gMaqcwjDI0obOL7p3sUqJ6o5DNMNA-5deX5qlNII-WExvj-mLV_c3OR4slg8ms6g7XH6vpqcxn2XvgIYyuCJSPgnB2w4B4lkIGhQKi22CCsydVj7XiDF-GaK6WD9KXlTfkTwoGsf8JcvDYqg-_j2dkFfD1geFDyS5plb2U0mnDRIC0PgcNCW7EUBVcGtqCDPUqs79Ov_ZS8ewy1Mx4MriAKo_z5mKdOYlZiaeeM9lu5wVl9L1n2Zn6Qh5IUb5KWn9y6W2WUL5DSUSvdZrFJx7brDgyPDdd8e4emU1L6x7nfrznNPTjRLNtmzuAnX2LX2sT_XKIJ3U_xbf9Mb3WdIDGgCJ5i8gIKCl5VFCIJte8c-l8Xjvej82GnxdNaGyUHc2_81EjZbcPhRLwzuU2Q7YxKUjkrEIlkh0jyA9i8vc9pxvZaFd2COy-CbR93iDDSam93uhNPGD-cjX7AuptEbcenE1dJal-ZSqUPPNR-8JHk_25RW4KTiG-dz-3oSozny0zJxjFRoFi2VBG-s_l1yN_ZMq_kK9P80Q7zAeuxEulBSTpk1w3-nFF9iXOW0a3EnNc6NMfkhkqjy2OpgnUsy7n22GO8Dnb6bATLgquxK9oe1NuqzV8v2LI1) summary: Generate Unique Address operationId: genAddress @@ -41,8 +41,8 @@ paths: - in: query name: transaction_id description: | - The platform server will save the posted transaction and pass the `transaction_id` through this endpoint. - If the anchor wishes to return transaction-dependent unique_address, the anchor may query the [`GET /transactions` endpoint of the Platform API](/ap_api/resources/get-transaction). + The platform server will save the posted transaction and pass the `transaction_id` through this endpoint. + If the anchor wishes to return transaction-dependent unique_address, the anchor may query the [`GET /transactions` endpoint of the Platform API](/api/anchor-platform/resources/get-transaction). schema: type: string required: true @@ -102,7 +102,7 @@ paths: - in: query name: send_asset description: | - The asset the client application will send to the anchor in exchange for `receive_asset` in + The asset the client application will send to the anchor in exchange for `receive_asset` in [Asset Identification Format](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0038.md#asset-identification-format). schema: type: string @@ -110,7 +110,7 @@ paths: - in: query name: receive_asset description: | - The asset the that the anchor will send in exchange for `send_asset` in + The asset the that the anchor will send in exchange for `send_asset` in [Asset Identification Format](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0038.md#asset-identification-format). schema: type: string @@ -118,16 +118,16 @@ paths: - in: query name: send_amount description: | - The amount of `send_asset` the client application will send in exchange for `receive_asset`. One of `send_amount` - or `receive_amount` will always be included in the request. If the client application specified a `quote_id` in + The amount of `send_asset` the client application will send in exchange for `receive_asset`. One of `send_amount` + or `receive_amount` will always be included in the request. If the client application specified a `quote_id` in its transaction creation request, both amounts specified in the referenced quote will be passed. schema: type: string - in: query name: receive_amount description: | - The amount of `receive_asset` the anchor will send in exchange for `send_asset`. One of `send_amount` or - `receive_amount` will always be included in the request. If the client application specified a `quote_id` in its + The amount of `receive_asset` the anchor will send in exchange for `send_asset`. One of `send_amount` or + `receive_amount` will always be included in the request. If the client application specified a `quote_id` in its transaction creation request, both amounts specified in the referenced quote will be passed. schema: type: string @@ -162,10 +162,10 @@ paths: $ref: './schemas.yml#/components/schemas/FeeResponse' '422': description: | - Unprocessable Entity. This status should be returned when the anchor understood the request but cannot - return a success response. An example for when this response code would be appropriate is if the sender - and/or receiver is not permitted to initiate a transaction with the specified amounts. In these cases, - the Platform will respond to the client application's request with a `400 Bad Request` and include the + Unprocessable Entity. This status should be returned when the anchor understood the request but cannot + return a success response. An example for when this response code would be appropriate is if the sender + and/or receiver is not permitted to initiate a transaction with the specified amounts. In these cases, + the Platform will respond to the client application's request with a `400 Bad Request` and include the error message provided by the anchor in the response body. content: application/json: @@ -180,17 +180,17 @@ paths: /rate: get: description: | - Transactions that involve two non-equivalent on & off-chain assets (such as USDC on Stellar and fiat EUR) must + Transactions that involve two non-equivalent on & off-chain assets (such as USDC on Stellar and fiat EUR) must use exchange rates that are communicated to the client application requesting the transaction. When clients make requests to the Platform for these exchange rates, the Platform sends this request to the anchor to fetch it. - - Rates can be [indicative](https://www.investopedia.com/terms/i/indicativequote.asp) or - [firm](https://www.investopedia.com/terms/f/firmquote.asp). The anchor must provide an ID and expiration if the + + Rates can be [indicative](https://www.investopedia.com/terms/i/indicativequote.asp) or + [firm](https://www.investopedia.com/terms/f/firmquote.asp). The anchor must provide an ID and expiration if the client requests a firm rate. - - Anchors can provide discounted rates specific client applications. The Platform includes the `client_id` parameter + + Anchors can provide discounted rates specific client applications. The Platform includes the `client_id` parameter for this reason. - + Either `sell_amount` or `buy_amount` will be included in requests as parameters, but never both. In the same way, either `sell_delivery_method` and `buy_delivery_method` may be included in requests, but never both, since either `sell_asset` or `buy_asset` is a Stellar asset. @@ -217,14 +217,14 @@ paths: Client IDs will be the Stellar public key the public key used to authenticate via SEP-10. Anchors must ensure that the public key specified in the request matches a public key known to belong to the sending anchor. - This parameter will only be specified if the client is authenticated via SEP-10. Anchors can define whether or not + This parameter will only be specified if the client is authenticated via SEP-10. Anchors can define whether or not authentication is required for fetching indicative rates. Firm rates always require authentication. 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 + The asset the client application will send to the anchor in exchange for `buy_asset` in [Asset Identification Format](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0038.md#asset-identification-format). schema: type: string @@ -232,7 +232,7 @@ paths: - in: query name: buy_asset description: | - The asset the that the anchor will send in exchange for `sell_asset` in + The asset the that the anchor will send in exchange for `sell_asset` in [Asset Identification Format](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0038.md#asset-identification-format). schema: type: string @@ -255,7 +255,7 @@ paths: 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. - Anchors should expect this parameter to be provided if one of the assets of the buy/sell pair is fiat and it + Anchors should expect this parameter to be provided if one of the assets of the buy/sell pair is fiat and it is available in two or more countries. schema: type: string @@ -270,7 +270,7 @@ paths: - 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 + The method the client or user will use to deliver `sell_asset` to the Anchor. This value may affect the expiration and price provided. The values used for this parameter is defined in the application's configuration. Will not be used in conjuction with `buy_delivery_method`. schema: @@ -278,7 +278,7 @@ paths: - 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 + The method the client or user wants used to receive `buy_asset` from the Anchor. This value may affect the expiration and price provided. The values used for this parameter is defined in the application's configuration. Will not be used in conjuction with `sell_delivery_method`. schema: @@ -292,9 +292,9 @@ paths: $ref: './schemas.yml#/components/schemas/RateResponse' '422': description: | - Unprocessable Entity. This status should be returned when the anchor understood the request but cannot + Unprocessable Entity. This status should be returned when the anchor understood the request but cannot return a success response. - In these cases, the Platform will respond to the client application's request with a `400 Bad Request` + In these cases, the Platform will respond to the client application's request with a `400 Bad Request` and include the error message provided by the anchor in the response body. content: application/json: @@ -309,21 +309,21 @@ paths: /customer: get: description: | - The request and response for this endpoint is identical to the - [`GET /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-get) + The request and response for this endpoint is identical to the + [`GET /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-get) request and response defined in SEP-12. - + This endpoint allows clients to: - 1. Fetch the fields the server requires in order to register a new customer via a SEP-12 + 1. Fetch the fields the server requires in order to register a new customer via a SEP-12 [`PUT /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-put) request - - If the server does not have a customer registered for the parameters sent in the request, it should return the + + If the server does not have a customer registered for the parameters sent in the request, it should return the fields required in the response. The same response should be returned when no parameters are sent. 2. Check the status of a customer that may already be registered - - This allows clients to check whether the customers information was accepted, rejected, or still needs more info. + + This allows clients to check whether the customers information was accepted, rejected, or still needs more info. If the server still needs more info, or the server needs updated information, it should return the fields required. tags: - Customers @@ -359,7 +359,7 @@ paths: - in: query name: type description: | - The type of action the customer is being KYCd for. See the + The type of action the customer is being KYCd for. See the [Type Specification](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#type-specification) documented in SEP-12. schema: @@ -367,15 +367,15 @@ paths: - in: query name: lang description: | - Defaults to `en`. Language code specified using ISO 639-1. Human readable descriptions, choices, and + Defaults to `en`. Language code specified using ISO 639-1. Human readable descriptions, choices, and messages should be in this language. schema: type: string responses: '200': description: | - Valid request. Customer either already exists or the customer identified by the parameters is new and must - provide the field values described in the response body. Response bodies are identical to the schema defined + Valid request. Customer either already exists or the customer identified by the parameters is new and must + provide the field values described in the response body. Response bodies are identical to the schema defined in [SEP-12](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-get). content: application/json: @@ -404,12 +404,12 @@ paths: - SEP-31 description: | **The Anchor Platform does not persist any customer KYC data.** - - The request and response for this endpoint are identical to the - [`PUT /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-put) + + The request and response for this endpoint are identical to the + [`PUT /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-put) request and response defined in SEP-12. - - Client applications make requests with the following request body, which is forwarded to the anchor. Anchors + + Client applications make requests with the following request body, which is forwarded to the anchor. Anchors must validate and persist the data passed, and return the customer's `id`. summary: Create or Update Customer Info operationId: putCustomer @@ -444,10 +444,10 @@ paths: - SEP-12 - SEP-31 description: | - The request for this endpoint is identical to the - [`DELETE /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-delete) + The request for this endpoint is identical to the + [`DELETE /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-delete) request defined in SEP-12. - + Delete the customer's data or queue the customers data for deletion. summary: Delete Customer Data operationId: delCustomer diff --git a/openapi/ap/Events Schema.yml b/openapi/anchor-platform/Events Schema.yml similarity index 100% rename from openapi/ap/Events Schema.yml rename to openapi/anchor-platform/Events Schema.yml diff --git a/openapi/ap/Platform API.yml b/openapi/anchor-platform/Platform API.yml similarity index 100% rename from openapi/ap/Platform API.yml rename to openapi/anchor-platform/Platform API.yml diff --git a/openapi/ap/bundled.yml b/openapi/anchor-platform/bundled.yml similarity index 100% rename from openapi/ap/bundled.yml rename to openapi/anchor-platform/bundled.yml diff --git a/openapi/ap/bundled_callback.yml b/openapi/anchor-platform/bundled_callback.yml similarity index 93% rename from openapi/ap/bundled_callback.yml rename to openapi/anchor-platform/bundled_callback.yml index 04ea5cc72..1091fcb52 100644 --- a/openapi/ap/bundled_callback.yml +++ b/openapi/anchor-platform/bundled_callback.yml @@ -4,7 +4,7 @@ info: description: | The Synchronous Callbacks API specification for the Stellar Anchor Platform project. - The Synchronous Callbacks API defines requests made by the Platform while it is processing a request from a client application. The + The Synchronous Callbacks API defines requests made by the Platform while it is processing a request from a client application. The anchor's responses to these requests affect the Platform responses to the client application. title: Synchronous Callbacks API tags: @@ -16,13 +16,13 @@ tags: description: Requests containing data that can be used to provide exchange rates between on & off-chain assets. - name: Customers description: | - [SEP-12](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md) requests made from client + [SEP-12](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md) requests made from client applications. paths: /unique_address: get: description: | - If the platform is configured with `depositInfoGeneratorType: api`, the Platform make this request to + If the platform is configured with `depositInfoGeneratorType: api`, the Platform make this request to the Anchor backend every time a transaction is initiated by a client application. The Anchor must guarantee that the memo returned in this request is unique, so it can be mapped 1-to-1 to a Platform @@ -41,8 +41,8 @@ paths: - in: query name: transaction_id description: | - The platform server will save the posted transaction and pass the `transaction_id` through this endpoint. - If the anchor wishes to return transaction-dependent unique_address, the anchor may query the [`GET /transactions` endpoint of the Platform API](/ap_api/resources/get-transaction). + The platform server will save the posted transaction and pass the `transaction_id` through this endpoint. + If the anchor wishes to return transaction-dependent unique_address, the anchor may query the [`GET /transactions` endpoint of the Platform API](/api/anchor-platform/resources/get-transaction). schema: type: string required: true @@ -101,7 +101,7 @@ paths: - in: query name: send_asset description: | - The asset the client application will send to the anchor in exchange for `receive_asset` in + The asset the client application will send to the anchor in exchange for `receive_asset` in [Asset Identification Format](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0038.md#asset-identification-format). schema: type: string @@ -109,7 +109,7 @@ paths: - in: query name: receive_asset description: | - The asset the that the anchor will send in exchange for `send_asset` in + The asset the that the anchor will send in exchange for `send_asset` in [Asset Identification Format](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0038.md#asset-identification-format). schema: type: string @@ -117,16 +117,16 @@ paths: - in: query name: send_amount description: | - The amount of `send_asset` the client application will send in exchange for `receive_asset`. One of `send_amount` - or `receive_amount` will always be included in the request. If the client application specified a `quote_id` in + The amount of `send_asset` the client application will send in exchange for `receive_asset`. One of `send_amount` + or `receive_amount` will always be included in the request. If the client application specified a `quote_id` in its transaction creation request, both amounts specified in the referenced quote will be passed. schema: type: string - in: query name: receive_amount description: | - The amount of `receive_asset` the anchor will send in exchange for `send_asset`. One of `send_amount` or - `receive_amount` will always be included in the request. If the client application specified a `quote_id` in its + The amount of `receive_asset` the anchor will send in exchange for `send_asset`. One of `send_amount` or + `receive_amount` will always be included in the request. If the client application specified a `quote_id` in its transaction creation request, both amounts specified in the referenced quote will be passed. schema: type: string @@ -161,10 +161,10 @@ paths: $ref: '#/components/schemas/FeeResponse' '422': description: | - Unprocessable Entity. This status should be returned when the anchor understood the request but cannot - return a success response. An example for when this response code would be appropriate is if the sender - and/or receiver is not permitted to initiate a transaction with the specified amounts. In these cases, - the Platform will respond to the client application's request with a `400 Bad Request` and include the + Unprocessable Entity. This status should be returned when the anchor understood the request but cannot + return a success response. An example for when this response code would be appropriate is if the sender + and/or receiver is not permitted to initiate a transaction with the specified amounts. In these cases, + the Platform will respond to the client application's request with a `400 Bad Request` and include the error message provided by the anchor in the response body. content: application/json: @@ -179,15 +179,15 @@ paths: /rate: get: description: | - Transactions that involve two non-equivalent on & off-chain assets (such as USDC on Stellar and fiat EUR) must + Transactions that involve two non-equivalent on & off-chain assets (such as USDC on Stellar and fiat EUR) must use exchange rates that are communicated to the client application requesting the transaction. When clients make requests to the Platform for these exchange rates, the Platform sends this request to the anchor to fetch it. - Rates can be [indicative](https://www.investopedia.com/terms/i/indicativequote.asp) or - [firm](https://www.investopedia.com/terms/f/firmquote.asp). The anchor must provide an ID and expiration if the + Rates can be [indicative](https://www.investopedia.com/terms/i/indicativequote.asp) or + [firm](https://www.investopedia.com/terms/f/firmquote.asp). The anchor must provide an ID and expiration if the client requests a firm rate. - Anchors can provide discounted rates specific client applications. The Platform includes the `client_id` parameter + Anchors can provide discounted rates specific client applications. The Platform includes the `client_id` parameter for this reason. Either `sell_amount` or `buy_amount` will be included in requests as parameters, but never both. In the same way, @@ -216,14 +216,14 @@ paths: Client IDs will be the Stellar public key the public key used to authenticate via SEP-10. Anchors must ensure that the public key specified in the request matches a public key known to belong to the sending anchor. - This parameter will only be specified if the client is authenticated via SEP-10. Anchors can define whether or not + This parameter will only be specified if the client is authenticated via SEP-10. Anchors can define whether or not authentication is required for fetching indicative rates. Firm rates always require authentication. 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 + The asset the client application will send to the anchor in exchange for `buy_asset` in [Asset Identification Format](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0038.md#asset-identification-format). schema: type: string @@ -231,7 +231,7 @@ paths: - in: query name: buy_asset description: | - The asset the that the anchor will send in exchange for `sell_asset` in + The asset the that the anchor will send in exchange for `sell_asset` in [Asset Identification Format](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0038.md#asset-identification-format). schema: type: string @@ -254,7 +254,7 @@ paths: 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. - Anchors should expect this parameter to be provided if one of the assets of the buy/sell pair is fiat and it + Anchors should expect this parameter to be provided if one of the assets of the buy/sell pair is fiat and it is available in two or more countries. schema: type: string @@ -269,7 +269,7 @@ paths: - 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 + The method the client or user will use to deliver `sell_asset` to the Anchor. This value may affect the expiration and price provided. The values used for this parameter is defined in the application's configuration. Will not be used in conjuction with `buy_delivery_method`. schema: @@ -277,7 +277,7 @@ paths: - 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 + The method the client or user wants used to receive `buy_asset` from the Anchor. This value may affect the expiration and price provided. The values used for this parameter is defined in the application's configuration. Will not be used in conjuction with `sell_delivery_method`. schema: @@ -291,9 +291,9 @@ paths: $ref: '#/components/schemas/RateResponse' '422': description: | - Unprocessable Entity. This status should be returned when the anchor understood the request but cannot + Unprocessable Entity. This status should be returned when the anchor understood the request but cannot return a success response. - In these cases, the Platform will respond to the client application's request with a `400 Bad Request` + In these cases, the Platform will respond to the client application's request with a `400 Bad Request` and include the error message provided by the anchor in the response body. content: application/json: @@ -308,21 +308,21 @@ paths: /customer: get: description: | - The request and response for this endpoint is identical to the - [`GET /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-get) + The request and response for this endpoint is identical to the + [`GET /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-get) request and response defined in SEP-12. This endpoint allows clients to: - 1. Fetch the fields the server requires in order to register a new customer via a SEP-12 + 1. Fetch the fields the server requires in order to register a new customer via a SEP-12 [`PUT /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-put) request - If the server does not have a customer registered for the parameters sent in the request, it should return the + If the server does not have a customer registered for the parameters sent in the request, it should return the fields required in the response. The same response should be returned when no parameters are sent. 2. Check the status of a customer that may already be registered - This allows clients to check whether the customers information was accepted, rejected, or still needs more info. + This allows clients to check whether the customers information was accepted, rejected, or still needs more info. If the server still needs more info, or the server needs updated information, it should return the fields required. tags: - Customers @@ -358,7 +358,7 @@ paths: - in: query name: type description: | - The type of action the customer is being KYCd for. See the + The type of action the customer is being KYCd for. See the [Type Specification](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#type-specification) documented in SEP-12. schema: @@ -366,15 +366,15 @@ paths: - in: query name: lang description: | - Defaults to `en`. Language code specified using ISO 639-1. Human readable descriptions, choices, and + Defaults to `en`. Language code specified using ISO 639-1. Human readable descriptions, choices, and messages should be in this language. schema: type: string responses: '200': description: | - Valid request. Customer either already exists or the customer identified by the parameters is new and must - provide the field values described in the response body. Response bodies are identical to the schema defined + Valid request. Customer either already exists or the customer identified by the parameters is new and must + provide the field values described in the response body. Response bodies are identical to the schema defined in [SEP-12](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-get). content: application/json: @@ -404,11 +404,11 @@ paths: description: | **The Anchor Platform does not persist any customer KYC data.** - The request and response for this endpoint are identical to the - [`PUT /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-put) + The request and response for this endpoint are identical to the + [`PUT /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-put) request and response defined in SEP-12. - Client applications make requests with the following request body, which is forwarded to the anchor. Anchors + Client applications make requests with the following request body, which is forwarded to the anchor. Anchors must validate and persist the data passed, and return the customer's `id`. summary: Create or Update Customer Info operationId: putCustomer @@ -443,8 +443,8 @@ paths: - SEP-12 - SEP-31 description: | - The request for this endpoint is identical to the - [`DELETE /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-delete) + The request for this endpoint is identical to the + [`DELETE /customer`](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#customer-delete) request defined in SEP-12. Delete the customer's data or queue the customers data for deletion. diff --git a/openapi/ap/examples.yml b/openapi/anchor-platform/examples.yml similarity index 100% rename from openapi/ap/examples.yml rename to openapi/anchor-platform/examples.yml diff --git a/openapi/ap/schemas.yml b/openapi/anchor-platform/schemas.yml similarity index 100% rename from openapi/ap/schemas.yml rename to openapi/anchor-platform/schemas.yml diff --git a/openapi/README.md b/openapi/horizon/README.md similarity index 100% rename from openapi/README.md rename to openapi/horizon/README.md diff --git a/openapi/bundled.yml b/openapi/horizon/bundled.yml similarity index 100% rename from openapi/bundled.yml rename to openapi/horizon/bundled.yml diff --git a/openapi/components/endpoints/accounts.yml b/openapi/horizon/components/endpoints/accounts.yml similarity index 100% rename from openapi/components/endpoints/accounts.yml rename to openapi/horizon/components/endpoints/accounts.yml diff --git a/openapi/components/endpoints/assets.yml b/openapi/horizon/components/endpoints/assets.yml similarity index 100% rename from openapi/components/endpoints/assets.yml rename to openapi/horizon/components/endpoints/assets.yml diff --git a/openapi/components/endpoints/claimableBalances.yml b/openapi/horizon/components/endpoints/claimableBalances.yml similarity index 100% rename from openapi/components/endpoints/claimableBalances.yml rename to openapi/horizon/components/endpoints/claimableBalances.yml diff --git a/openapi/components/endpoints/effects.yml b/openapi/horizon/components/endpoints/effects.yml similarity index 100% rename from openapi/components/endpoints/effects.yml rename to openapi/horizon/components/endpoints/effects.yml diff --git a/openapi/components/endpoints/feeStats.yml b/openapi/horizon/components/endpoints/feeStats.yml similarity index 100% rename from openapi/components/endpoints/feeStats.yml rename to openapi/horizon/components/endpoints/feeStats.yml diff --git a/openapi/components/endpoints/ledgers.yml b/openapi/horizon/components/endpoints/ledgers.yml similarity index 100% rename from openapi/components/endpoints/ledgers.yml rename to openapi/horizon/components/endpoints/ledgers.yml diff --git a/openapi/components/endpoints/liquidityPools.yml b/openapi/horizon/components/endpoints/liquidityPools.yml similarity index 100% rename from openapi/components/endpoints/liquidityPools.yml rename to openapi/horizon/components/endpoints/liquidityPools.yml diff --git a/openapi/components/endpoints/offers.yml b/openapi/horizon/components/endpoints/offers.yml similarity index 100% rename from openapi/components/endpoints/offers.yml rename to openapi/horizon/components/endpoints/offers.yml diff --git a/openapi/components/endpoints/operations.yml b/openapi/horizon/components/endpoints/operations.yml similarity index 100% rename from openapi/components/endpoints/operations.yml rename to openapi/horizon/components/endpoints/operations.yml diff --git a/openapi/components/endpoints/orderBooks.yml b/openapi/horizon/components/endpoints/orderBooks.yml similarity index 100% rename from openapi/components/endpoints/orderBooks.yml rename to openapi/horizon/components/endpoints/orderBooks.yml diff --git a/openapi/components/endpoints/paths.yml b/openapi/horizon/components/endpoints/paths.yml similarity index 100% rename from openapi/components/endpoints/paths.yml rename to openapi/horizon/components/endpoints/paths.yml diff --git a/openapi/components/endpoints/tradeAggregations.yml b/openapi/horizon/components/endpoints/tradeAggregations.yml similarity index 100% rename from openapi/components/endpoints/tradeAggregations.yml rename to openapi/horizon/components/endpoints/tradeAggregations.yml diff --git a/openapi/components/endpoints/trades.yml b/openapi/horizon/components/endpoints/trades.yml similarity index 100% rename from openapi/components/endpoints/trades.yml rename to openapi/horizon/components/endpoints/trades.yml diff --git a/openapi/components/endpoints/transactions.yml b/openapi/horizon/components/endpoints/transactions.yml similarity index 100% rename from openapi/components/endpoints/transactions.yml rename to openapi/horizon/components/endpoints/transactions.yml diff --git a/openapi/components/examples/responses/Accounts/ListAllAccounts.yml b/openapi/horizon/components/examples/responses/Accounts/ListAllAccounts.yml similarity index 100% rename from openapi/components/examples/responses/Accounts/ListAllAccounts.yml rename to openapi/horizon/components/examples/responses/Accounts/ListAllAccounts.yml diff --git a/openapi/components/examples/responses/Accounts/RetrieveAnAccount.yml b/openapi/horizon/components/examples/responses/Accounts/RetrieveAnAccount.yml similarity index 100% rename from openapi/components/examples/responses/Accounts/RetrieveAnAccount.yml rename to openapi/horizon/components/examples/responses/Accounts/RetrieveAnAccount.yml diff --git a/openapi/components/examples/responses/Accounts/RetrieveAnAccountsData.yml b/openapi/horizon/components/examples/responses/Accounts/RetrieveAnAccountsData.yml similarity index 100% rename from openapi/components/examples/responses/Accounts/RetrieveAnAccountsData.yml rename to openapi/horizon/components/examples/responses/Accounts/RetrieveAnAccountsData.yml diff --git a/openapi/components/examples/responses/Accounts/RetrieveAnAccountsEffects.yml b/openapi/horizon/components/examples/responses/Accounts/RetrieveAnAccountsEffects.yml similarity index 100% rename from openapi/components/examples/responses/Accounts/RetrieveAnAccountsEffects.yml rename to openapi/horizon/components/examples/responses/Accounts/RetrieveAnAccountsEffects.yml diff --git a/openapi/components/examples/responses/Accounts/RetrieveAnAccountsOffers.yml b/openapi/horizon/components/examples/responses/Accounts/RetrieveAnAccountsOffers.yml similarity index 100% rename from openapi/components/examples/responses/Accounts/RetrieveAnAccountsOffers.yml rename to openapi/horizon/components/examples/responses/Accounts/RetrieveAnAccountsOffers.yml diff --git a/openapi/components/examples/responses/Accounts/RetrieveAnAccountsOperations.yml b/openapi/horizon/components/examples/responses/Accounts/RetrieveAnAccountsOperations.yml similarity index 100% rename from openapi/components/examples/responses/Accounts/RetrieveAnAccountsOperations.yml rename to openapi/horizon/components/examples/responses/Accounts/RetrieveAnAccountsOperations.yml diff --git a/openapi/components/examples/responses/Accounts/RetrieveAnAccountsPayments.yml b/openapi/horizon/components/examples/responses/Accounts/RetrieveAnAccountsPayments.yml similarity index 100% rename from openapi/components/examples/responses/Accounts/RetrieveAnAccountsPayments.yml rename to openapi/horizon/components/examples/responses/Accounts/RetrieveAnAccountsPayments.yml diff --git a/openapi/components/examples/responses/Accounts/RetrieveAnAccountsTrades.yml b/openapi/horizon/components/examples/responses/Accounts/RetrieveAnAccountsTrades.yml similarity index 100% rename from openapi/components/examples/responses/Accounts/RetrieveAnAccountsTrades.yml rename to openapi/horizon/components/examples/responses/Accounts/RetrieveAnAccountsTrades.yml diff --git a/openapi/components/examples/responses/Accounts/RetrieveAnAccountsTransactions.yml b/openapi/horizon/components/examples/responses/Accounts/RetrieveAnAccountsTransactions.yml similarity index 100% rename from openapi/components/examples/responses/Accounts/RetrieveAnAccountsTransactions.yml rename to openapi/horizon/components/examples/responses/Accounts/RetrieveAnAccountsTransactions.yml diff --git a/openapi/components/examples/responses/Assets/ListAllAssets.yml b/openapi/horizon/components/examples/responses/Assets/ListAllAssets.yml similarity index 100% rename from openapi/components/examples/responses/Assets/ListAllAssets.yml rename to openapi/horizon/components/examples/responses/Assets/ListAllAssets.yml diff --git a/openapi/components/examples/responses/ClaimableBalances/CBRetrieveRelatedOperations.yml b/openapi/horizon/components/examples/responses/ClaimableBalances/CBRetrieveRelatedOperations.yml similarity index 100% rename from openapi/components/examples/responses/ClaimableBalances/CBRetrieveRelatedOperations.yml rename to openapi/horizon/components/examples/responses/ClaimableBalances/CBRetrieveRelatedOperations.yml diff --git a/openapi/components/examples/responses/ClaimableBalances/CBRetrieveRelatedTransactions.yml b/openapi/horizon/components/examples/responses/ClaimableBalances/CBRetrieveRelatedTransactions.yml similarity index 100% rename from openapi/components/examples/responses/ClaimableBalances/CBRetrieveRelatedTransactions.yml rename to openapi/horizon/components/examples/responses/ClaimableBalances/CBRetrieveRelatedTransactions.yml diff --git a/openapi/components/examples/responses/ClaimableBalances/ListAllClaimableBalances.yml b/openapi/horizon/components/examples/responses/ClaimableBalances/ListAllClaimableBalances.yml similarity index 100% rename from openapi/components/examples/responses/ClaimableBalances/ListAllClaimableBalances.yml rename to openapi/horizon/components/examples/responses/ClaimableBalances/ListAllClaimableBalances.yml diff --git a/openapi/components/examples/responses/ClaimableBalances/RetrieveAClaimableBalance.yml b/openapi/horizon/components/examples/responses/ClaimableBalances/RetrieveAClaimableBalance.yml similarity index 100% rename from openapi/components/examples/responses/ClaimableBalances/RetrieveAClaimableBalance.yml rename to openapi/horizon/components/examples/responses/ClaimableBalances/RetrieveAClaimableBalance.yml diff --git a/openapi/components/examples/responses/Effects/ListAllEffects.yml b/openapi/horizon/components/examples/responses/Effects/ListAllEffects.yml similarity index 100% rename from openapi/components/examples/responses/Effects/ListAllEffects.yml rename to openapi/horizon/components/examples/responses/Effects/ListAllEffects.yml diff --git a/openapi/components/examples/responses/FeeStats/RetrieveFeeStats.yml b/openapi/horizon/components/examples/responses/FeeStats/RetrieveFeeStats.yml similarity index 100% rename from openapi/components/examples/responses/FeeStats/RetrieveFeeStats.yml rename to openapi/horizon/components/examples/responses/FeeStats/RetrieveFeeStats.yml diff --git a/openapi/components/examples/responses/Ledgers/ListAllLedgers.yml b/openapi/horizon/components/examples/responses/Ledgers/ListAllLedgers.yml similarity index 100% rename from openapi/components/examples/responses/Ledgers/ListAllLedgers.yml rename to openapi/horizon/components/examples/responses/Ledgers/ListAllLedgers.yml diff --git a/openapi/components/examples/responses/Ledgers/RetrieveALedger.yml b/openapi/horizon/components/examples/responses/Ledgers/RetrieveALedger.yml similarity index 100% rename from openapi/components/examples/responses/Ledgers/RetrieveALedger.yml rename to openapi/horizon/components/examples/responses/Ledgers/RetrieveALedger.yml diff --git a/openapi/components/examples/responses/Ledgers/RetrieveALedgersEffects.yml b/openapi/horizon/components/examples/responses/Ledgers/RetrieveALedgersEffects.yml similarity index 100% rename from openapi/components/examples/responses/Ledgers/RetrieveALedgersEffects.yml rename to openapi/horizon/components/examples/responses/Ledgers/RetrieveALedgersEffects.yml diff --git a/openapi/components/examples/responses/Ledgers/RetrieveALedgersOperations.yml b/openapi/horizon/components/examples/responses/Ledgers/RetrieveALedgersOperations.yml similarity index 100% rename from openapi/components/examples/responses/Ledgers/RetrieveALedgersOperations.yml rename to openapi/horizon/components/examples/responses/Ledgers/RetrieveALedgersOperations.yml diff --git a/openapi/components/examples/responses/Ledgers/RetrieveALedgersPayments.yml b/openapi/horizon/components/examples/responses/Ledgers/RetrieveALedgersPayments.yml similarity index 100% rename from openapi/components/examples/responses/Ledgers/RetrieveALedgersPayments.yml rename to openapi/horizon/components/examples/responses/Ledgers/RetrieveALedgersPayments.yml diff --git a/openapi/components/examples/responses/Ledgers/RetrieveALedgersTransactions.yml b/openapi/horizon/components/examples/responses/Ledgers/RetrieveALedgersTransactions.yml similarity index 100% rename from openapi/components/examples/responses/Ledgers/RetrieveALedgersTransactions.yml rename to openapi/horizon/components/examples/responses/Ledgers/RetrieveALedgersTransactions.yml diff --git a/openapi/components/examples/responses/LiqudityPools/LPRetrieveRelatedOperations.yml b/openapi/horizon/components/examples/responses/LiqudityPools/LPRetrieveRelatedOperations.yml similarity index 100% rename from openapi/components/examples/responses/LiqudityPools/LPRetrieveRelatedOperations.yml rename to openapi/horizon/components/examples/responses/LiqudityPools/LPRetrieveRelatedOperations.yml diff --git a/openapi/components/examples/responses/LiqudityPools/LPRetrieveRelatedTransactions.yml b/openapi/horizon/components/examples/responses/LiqudityPools/LPRetrieveRelatedTransactions.yml similarity index 100% rename from openapi/components/examples/responses/LiqudityPools/LPRetrieveRelatedTransactions.yml rename to openapi/horizon/components/examples/responses/LiqudityPools/LPRetrieveRelatedTransactions.yml diff --git a/openapi/components/examples/responses/LiqudityPools/ListLiquidityPools.yml b/openapi/horizon/components/examples/responses/LiqudityPools/ListLiquidityPools.yml similarity index 100% rename from openapi/components/examples/responses/LiqudityPools/ListLiquidityPools.yml rename to openapi/horizon/components/examples/responses/LiqudityPools/ListLiquidityPools.yml diff --git a/openapi/components/examples/responses/LiqudityPools/RetrieveALiquidityPool.yml b/openapi/horizon/components/examples/responses/LiqudityPools/RetrieveALiquidityPool.yml similarity index 100% rename from openapi/components/examples/responses/LiqudityPools/RetrieveALiquidityPool.yml rename to openapi/horizon/components/examples/responses/LiqudityPools/RetrieveALiquidityPool.yml diff --git a/openapi/components/examples/responses/LiqudityPools/RetrieveRelatedEffects.yml b/openapi/horizon/components/examples/responses/LiqudityPools/RetrieveRelatedEffects.yml similarity index 100% rename from openapi/components/examples/responses/LiqudityPools/RetrieveRelatedEffects.yml rename to openapi/horizon/components/examples/responses/LiqudityPools/RetrieveRelatedEffects.yml diff --git a/openapi/components/examples/responses/LiqudityPools/RetrieveRelatedTrades.yml b/openapi/horizon/components/examples/responses/LiqudityPools/RetrieveRelatedTrades.yml similarity index 100% rename from openapi/components/examples/responses/LiqudityPools/RetrieveRelatedTrades.yml rename to openapi/horizon/components/examples/responses/LiqudityPools/RetrieveRelatedTrades.yml diff --git a/openapi/components/examples/responses/Offers/GetAllOffers.yml b/openapi/horizon/components/examples/responses/Offers/GetAllOffers.yml similarity index 100% rename from openapi/components/examples/responses/Offers/GetAllOffers.yml rename to openapi/horizon/components/examples/responses/Offers/GetAllOffers.yml diff --git a/openapi/components/examples/responses/Offers/GetOfferByOfferId.yml b/openapi/horizon/components/examples/responses/Offers/GetOfferByOfferId.yml similarity index 100% rename from openapi/components/examples/responses/Offers/GetOfferByOfferId.yml rename to openapi/horizon/components/examples/responses/Offers/GetOfferByOfferId.yml diff --git a/openapi/components/examples/responses/Offers/GetTradesByOfferId.yml b/openapi/horizon/components/examples/responses/Offers/GetTradesByOfferId.yml similarity index 100% rename from openapi/components/examples/responses/Offers/GetTradesByOfferId.yml rename to openapi/horizon/components/examples/responses/Offers/GetTradesByOfferId.yml diff --git a/openapi/components/examples/responses/Operations/ListAllOperations.yml b/openapi/horizon/components/examples/responses/Operations/ListAllOperations.yml similarity index 100% rename from openapi/components/examples/responses/Operations/ListAllOperations.yml rename to openapi/horizon/components/examples/responses/Operations/ListAllOperations.yml diff --git a/openapi/components/examples/responses/Operations/ListAllPayments.yml b/openapi/horizon/components/examples/responses/Operations/ListAllPayments.yml similarity index 100% rename from openapi/components/examples/responses/Operations/ListAllPayments.yml rename to openapi/horizon/components/examples/responses/Operations/ListAllPayments.yml diff --git a/openapi/components/examples/responses/Operations/RetrieveAnOperation.yml b/openapi/horizon/components/examples/responses/Operations/RetrieveAnOperation.yml similarity index 100% rename from openapi/components/examples/responses/Operations/RetrieveAnOperation.yml rename to openapi/horizon/components/examples/responses/Operations/RetrieveAnOperation.yml diff --git a/openapi/components/examples/responses/Operations/RetrieveAnOperationsEffects.yml b/openapi/horizon/components/examples/responses/Operations/RetrieveAnOperationsEffects.yml similarity index 100% rename from openapi/components/examples/responses/Operations/RetrieveAnOperationsEffects.yml rename to openapi/horizon/components/examples/responses/Operations/RetrieveAnOperationsEffects.yml diff --git a/openapi/components/examples/responses/OrderBooks/RetrieveAnOrderBook.yml b/openapi/horizon/components/examples/responses/OrderBooks/RetrieveAnOrderBook.yml similarity index 100% rename from openapi/components/examples/responses/OrderBooks/RetrieveAnOrderBook.yml rename to openapi/horizon/components/examples/responses/OrderBooks/RetrieveAnOrderBook.yml diff --git a/openapi/components/examples/responses/Paths/ListStrictReceivePaymentPaths.yml b/openapi/horizon/components/examples/responses/Paths/ListStrictReceivePaymentPaths.yml similarity index 100% rename from openapi/components/examples/responses/Paths/ListStrictReceivePaymentPaths.yml rename to openapi/horizon/components/examples/responses/Paths/ListStrictReceivePaymentPaths.yml diff --git a/openapi/components/examples/responses/Paths/ListStrictSendPaymentPaths.yml b/openapi/horizon/components/examples/responses/Paths/ListStrictSendPaymentPaths.yml similarity index 100% rename from openapi/components/examples/responses/Paths/ListStrictSendPaymentPaths.yml rename to openapi/horizon/components/examples/responses/Paths/ListStrictSendPaymentPaths.yml diff --git a/openapi/components/examples/responses/TradeAggregations/ListTradeAggregations.yml b/openapi/horizon/components/examples/responses/TradeAggregations/ListTradeAggregations.yml similarity index 100% rename from openapi/components/examples/responses/TradeAggregations/ListTradeAggregations.yml rename to openapi/horizon/components/examples/responses/TradeAggregations/ListTradeAggregations.yml diff --git a/openapi/components/examples/responses/Trades/GetAllTrades.yml b/openapi/horizon/components/examples/responses/Trades/GetAllTrades.yml similarity index 100% rename from openapi/components/examples/responses/Trades/GetAllTrades.yml rename to openapi/horizon/components/examples/responses/Trades/GetAllTrades.yml diff --git a/openapi/components/examples/responses/Transactions/ListAllTransactions.yml b/openapi/horizon/components/examples/responses/Transactions/ListAllTransactions.yml similarity index 100% rename from openapi/components/examples/responses/Transactions/ListAllTransactions.yml rename to openapi/horizon/components/examples/responses/Transactions/ListAllTransactions.yml diff --git a/openapi/components/examples/responses/Transactions/RetrieveATransaction.yml b/openapi/horizon/components/examples/responses/Transactions/RetrieveATransaction.yml similarity index 100% rename from openapi/components/examples/responses/Transactions/RetrieveATransaction.yml rename to openapi/horizon/components/examples/responses/Transactions/RetrieveATransaction.yml diff --git a/openapi/components/examples/responses/Transactions/RetrieveATransactionsEffects.yml b/openapi/horizon/components/examples/responses/Transactions/RetrieveATransactionsEffects.yml similarity index 100% rename from openapi/components/examples/responses/Transactions/RetrieveATransactionsEffects.yml rename to openapi/horizon/components/examples/responses/Transactions/RetrieveATransactionsEffects.yml diff --git a/openapi/components/examples/responses/Transactions/RetrieveATransactionsOperations.yml b/openapi/horizon/components/examples/responses/Transactions/RetrieveATransactionsOperations.yml similarity index 100% rename from openapi/components/examples/responses/Transactions/RetrieveATransactionsOperations.yml rename to openapi/horizon/components/examples/responses/Transactions/RetrieveATransactionsOperations.yml diff --git a/openapi/components/examples/responses/Transactions/SubmitaTransaction.yml b/openapi/horizon/components/examples/responses/Transactions/SubmitaTransaction.yml similarity index 100% rename from openapi/components/examples/responses/Transactions/SubmitaTransaction.yml rename to openapi/horizon/components/examples/responses/Transactions/SubmitaTransaction.yml diff --git a/openapi/components/instance_variables.yml b/openapi/horizon/components/instance_variables.yml similarity index 100% rename from openapi/components/instance_variables.yml rename to openapi/horizon/components/instance_variables.yml diff --git a/openapi/components/parameters.yml b/openapi/horizon/components/parameters.yml similarity index 100% rename from openapi/components/parameters.yml rename to openapi/horizon/components/parameters.yml diff --git a/openapi/components/schemas/accountMergeSchema.yml b/openapi/horizon/components/schemas/accountMergeSchema.yml similarity index 100% rename from openapi/components/schemas/accountMergeSchema.yml rename to openapi/horizon/components/schemas/accountMergeSchema.yml diff --git a/openapi/components/schemas/accountSchema.yml b/openapi/horizon/components/schemas/accountSchema.yml similarity index 100% rename from openapi/components/schemas/accountSchema.yml rename to openapi/horizon/components/schemas/accountSchema.yml diff --git a/openapi/components/schemas/allowTrustSchema.yml b/openapi/horizon/components/schemas/allowTrustSchema.yml similarity index 100% rename from openapi/components/schemas/allowTrustSchema.yml rename to openapi/horizon/components/schemas/allowTrustSchema.yml diff --git a/openapi/components/schemas/assetSchema.yml b/openapi/horizon/components/schemas/assetSchema.yml similarity index 100% rename from openapi/components/schemas/assetSchema.yml rename to openapi/horizon/components/schemas/assetSchema.yml diff --git a/openapi/components/schemas/balanceSchema.yml b/openapi/horizon/components/schemas/balanceSchema.yml similarity index 100% rename from openapi/components/schemas/balanceSchema.yml rename to openapi/horizon/components/schemas/balanceSchema.yml diff --git a/openapi/components/schemas/baseAssetSchema.yml b/openapi/horizon/components/schemas/baseAssetSchema.yml similarity index 100% rename from openapi/components/schemas/baseAssetSchema.yml rename to openapi/horizon/components/schemas/baseAssetSchema.yml diff --git a/openapi/components/schemas/beginSponsoringFutureReservesSchema.yml b/openapi/horizon/components/schemas/beginSponsoringFutureReservesSchema.yml similarity index 100% rename from openapi/components/schemas/beginSponsoringFutureReservesSchema.yml rename to openapi/horizon/components/schemas/beginSponsoringFutureReservesSchema.yml diff --git a/openapi/components/schemas/bumpSequenceSchema.yml b/openapi/horizon/components/schemas/bumpSequenceSchema.yml similarity index 100% rename from openapi/components/schemas/bumpSequenceSchema.yml rename to openapi/horizon/components/schemas/bumpSequenceSchema.yml diff --git a/openapi/components/schemas/changeTrustSchema.yml b/openapi/horizon/components/schemas/changeTrustSchema.yml similarity index 100% rename from openapi/components/schemas/changeTrustSchema.yml rename to openapi/horizon/components/schemas/changeTrustSchema.yml diff --git a/openapi/components/schemas/claimClaimableBalanceSchema.yml b/openapi/horizon/components/schemas/claimClaimableBalanceSchema.yml similarity index 100% rename from openapi/components/schemas/claimClaimableBalanceSchema.yml rename to openapi/horizon/components/schemas/claimClaimableBalanceSchema.yml diff --git a/openapi/components/schemas/claimableBalanceSchema.yml b/openapi/horizon/components/schemas/claimableBalanceSchema.yml similarity index 100% rename from openapi/components/schemas/claimableBalanceSchema.yml rename to openapi/horizon/components/schemas/claimableBalanceSchema.yml diff --git a/openapi/components/schemas/createAccountSchema.yml b/openapi/horizon/components/schemas/createAccountSchema.yml similarity index 100% rename from openapi/components/schemas/createAccountSchema.yml rename to openapi/horizon/components/schemas/createAccountSchema.yml diff --git a/openapi/components/schemas/createClaimableBalanceSchema.yml b/openapi/horizon/components/schemas/createClaimableBalanceSchema.yml similarity index 100% rename from openapi/components/schemas/createClaimableBalanceSchema.yml rename to openapi/horizon/components/schemas/createClaimableBalanceSchema.yml diff --git a/openapi/components/schemas/createPassiveSellOfferSchema.yml b/openapi/horizon/components/schemas/createPassiveSellOfferSchema.yml similarity index 100% rename from openapi/components/schemas/createPassiveSellOfferSchema.yml rename to openapi/horizon/components/schemas/createPassiveSellOfferSchema.yml diff --git a/openapi/components/schemas/effectsSchema.yml b/openapi/horizon/components/schemas/effectsSchema.yml similarity index 100% rename from openapi/components/schemas/effectsSchema.yml rename to openapi/horizon/components/schemas/effectsSchema.yml diff --git a/openapi/components/schemas/endSponsoringFutureReservesSchema.yml b/openapi/horizon/components/schemas/endSponsoringFutureReservesSchema.yml similarity index 100% rename from openapi/components/schemas/endSponsoringFutureReservesSchema.yml rename to openapi/horizon/components/schemas/endSponsoringFutureReservesSchema.yml diff --git a/openapi/components/schemas/feeStatsSchema.yml b/openapi/horizon/components/schemas/feeStatsSchema.yml similarity index 100% rename from openapi/components/schemas/feeStatsSchema.yml rename to openapi/horizon/components/schemas/feeStatsSchema.yml diff --git a/openapi/components/schemas/ledgerSchema.yml b/openapi/horizon/components/schemas/ledgerSchema.yml similarity index 100% rename from openapi/components/schemas/ledgerSchema.yml rename to openapi/horizon/components/schemas/ledgerSchema.yml diff --git a/openapi/components/schemas/linksSchema.yml b/openapi/horizon/components/schemas/linksSchema.yml similarity index 100% rename from openapi/components/schemas/linksSchema.yml rename to openapi/horizon/components/schemas/linksSchema.yml diff --git a/openapi/components/schemas/liquidityPool.yml b/openapi/horizon/components/schemas/liquidityPool.yml similarity index 100% rename from openapi/components/schemas/liquidityPool.yml rename to openapi/horizon/components/schemas/liquidityPool.yml diff --git a/openapi/components/schemas/liquidityPoolDepositSchema.yml b/openapi/horizon/components/schemas/liquidityPoolDepositSchema.yml similarity index 100% rename from openapi/components/schemas/liquidityPoolDepositSchema.yml rename to openapi/horizon/components/schemas/liquidityPoolDepositSchema.yml diff --git a/openapi/components/schemas/liquidityPoolWithdrawSchema.yml b/openapi/horizon/components/schemas/liquidityPoolWithdrawSchema.yml similarity index 100% rename from openapi/components/schemas/liquidityPoolWithdrawSchema.yml rename to openapi/horizon/components/schemas/liquidityPoolWithdrawSchema.yml diff --git a/openapi/components/schemas/manageBuyOfferSchema.yml b/openapi/horizon/components/schemas/manageBuyOfferSchema.yml similarity index 100% rename from openapi/components/schemas/manageBuyOfferSchema.yml rename to openapi/horizon/components/schemas/manageBuyOfferSchema.yml diff --git a/openapi/components/schemas/manageDataSchema.yml b/openapi/horizon/components/schemas/manageDataSchema.yml similarity index 100% rename from openapi/components/schemas/manageDataSchema.yml rename to openapi/horizon/components/schemas/manageDataSchema.yml diff --git a/openapi/components/schemas/manageSellOfferSchema.yml b/openapi/horizon/components/schemas/manageSellOfferSchema.yml similarity index 100% rename from openapi/components/schemas/manageSellOfferSchema.yml rename to openapi/horizon/components/schemas/manageSellOfferSchema.yml diff --git a/openapi/components/schemas/offerSchema.yml b/openapi/horizon/components/schemas/offerSchema.yml similarity index 100% rename from openapi/components/schemas/offerSchema.yml rename to openapi/horizon/components/schemas/offerSchema.yml diff --git a/openapi/components/schemas/operationSchema.yml b/openapi/horizon/components/schemas/operationSchema.yml similarity index 100% rename from openapi/components/schemas/operationSchema.yml rename to openapi/horizon/components/schemas/operationSchema.yml diff --git a/openapi/components/schemas/orderBook.yml b/openapi/horizon/components/schemas/orderBook.yml similarity index 100% rename from openapi/components/schemas/orderBook.yml rename to openapi/horizon/components/schemas/orderBook.yml diff --git a/openapi/components/schemas/path.yml b/openapi/horizon/components/schemas/path.yml similarity index 100% rename from openapi/components/schemas/path.yml rename to openapi/horizon/components/schemas/path.yml diff --git a/openapi/components/schemas/pathPaymentStrictReceiveSchema.yml b/openapi/horizon/components/schemas/pathPaymentStrictReceiveSchema.yml similarity index 100% rename from openapi/components/schemas/pathPaymentStrictReceiveSchema.yml rename to openapi/horizon/components/schemas/pathPaymentStrictReceiveSchema.yml diff --git a/openapi/components/schemas/pathPaymentStrictSendSchema.yml b/openapi/horizon/components/schemas/pathPaymentStrictSendSchema.yml similarity index 100% rename from openapi/components/schemas/pathPaymentStrictSendSchema.yml rename to openapi/horizon/components/schemas/pathPaymentStrictSendSchema.yml diff --git a/openapi/components/schemas/paymentSchema.yml b/openapi/horizon/components/schemas/paymentSchema.yml similarity index 100% rename from openapi/components/schemas/paymentSchema.yml rename to openapi/horizon/components/schemas/paymentSchema.yml diff --git a/openapi/components/schemas/revokeSponsorshipSchema.yml b/openapi/horizon/components/schemas/revokeSponsorshipSchema.yml similarity index 100% rename from openapi/components/schemas/revokeSponsorshipSchema.yml rename to openapi/horizon/components/schemas/revokeSponsorshipSchema.yml diff --git a/openapi/components/schemas/setOptionsSchema.yml b/openapi/horizon/components/schemas/setOptionsSchema.yml similarity index 100% rename from openapi/components/schemas/setOptionsSchema.yml rename to openapi/horizon/components/schemas/setOptionsSchema.yml diff --git a/openapi/components/schemas/tradeAggregationSchema.yml b/openapi/horizon/components/schemas/tradeAggregationSchema.yml similarity index 100% rename from openapi/components/schemas/tradeAggregationSchema.yml rename to openapi/horizon/components/schemas/tradeAggregationSchema.yml diff --git a/openapi/components/schemas/tradeSchema.yml b/openapi/horizon/components/schemas/tradeSchema.yml similarity index 100% rename from openapi/components/schemas/tradeSchema.yml rename to openapi/horizon/components/schemas/tradeSchema.yml diff --git a/openapi/components/schemas/transactionSchema.yml b/openapi/horizon/components/schemas/transactionSchema.yml similarity index 100% rename from openapi/components/schemas/transactionSchema.yml rename to openapi/horizon/components/schemas/transactionSchema.yml diff --git a/openapi/components/schemas/transactionTransactionSchema.yml b/openapi/horizon/components/schemas/transactionTransactionSchema.yml similarity index 100% rename from openapi/components/schemas/transactionTransactionSchema.yml rename to openapi/horizon/components/schemas/transactionTransactionSchema.yml diff --git a/openapi/horizon/main.yml b/openapi/horizon/main.yml new file mode 100644 index 000000000..44afb977b --- /dev/null +++ b/openapi/horizon/main.yml @@ -0,0 +1,125 @@ +openapi: 3.0.3 +info: + title: Horizon + version: 0.0.1 + +servers: + - url: https://horizon.stellar.org + description: The main network + - url: https://horizon-testnet.stellar.org + description: The test network +tags: + - name: Accounts + description: Users interact with the Stellar network through accounts. Everything else in the ledger—assets, offers, trustlines, etc. are owned by accounts, and accounts must authorize all changes to the ledger through signed transactions. + - name: Assets + description: Assets are representations of value issued on the Stellar network. An asset consists of a type, code, and issuer. + - name: Claimable Balances + description: A Claimable Balance represents the transfer of ownership of some amount of an asset. Claimable balances provide a mechanism for setting up a payment which can be claimed in the future. This allows you to make payments to accounts which are currently not able to accept them. + - name: Effects + description: Effects represent specific changes that occur in the ledger as a result of successful operations, but are not necessarily directly reflected in the ledger or history, as transactions and operations are. + - name: Fee Stats + description: Fee stats are used to predict what fee to set for a transaction before submitting it to the network. + - name: Liquidity Pools + description: Liquidity Pools provide a simple, non-interactive way to trade large amounts of capital and enable high volumes of trading. + - name: Ledgers + description: Each ledger stores the state of the network at a point in time and contains all the changes - transactions, operations, effects, etc. - to that state. + - name: Offers + description: Offers are statements about how much of an asset an account wants to buy or sell. + - name: Order Books + description: An order book is a collections of offers for a specific pair of assets. + - name: Trade Aggregations + description: A trade aggregation represents aggregated statistics on an asset pair (base and counter) for a specific time period. Trade aggregations are useful to developers of trading clients and provide historical trade data. + - name: Trades + description: When an offer is fully or partially fulfilled, a trade happens. Trades can also be caused by successful path payments, because path payments involve fulfilling offers. A trade occurs between two parties—base and counter. Which is which is either arbitrary or determined by the calling query. + - name: Transactions + description: Transactions are commands that modify the ledger state and consist of one or more operations. +paths: + /accounts: + $ref: './components/endpoints/accounts.yml#/paths/~1accounts' + /accounts/{account_id}: + $ref: './components/endpoints/accounts.yml#/paths/~1accounts~1{account_id}' + /accounts/{account_id}/transactions: + $ref : './components/endpoints/accounts.yml#/paths/~1accounts~1{account_id}~1transactions' + /accounts/{account_id}/operations: + $ref : './components/endpoints/accounts.yml#/paths/~1accounts~1{account_id}~1operations' + /accounts/{account_id}/payments: + $ref : './components/endpoints/accounts.yml#/paths/~1accounts~1{account_id}~1payments' + /accounts/{account_id}/effects: + $ref : './components/endpoints/accounts.yml#/paths/~1accounts~1{account_id}~1effects' + /accounts/{account_id}/offers: + $ref : './components/endpoints/accounts.yml#/paths/~1accounts~1{account_id}~1offers' + /accounts/{account_id}/trades: + $ref : './components/endpoints/accounts.yml#/paths/~1accounts~1{account_id}~1trades' + /accounts/{account_id}/data/{key}: + $ref : './components/endpoints/accounts.yml#/paths/~1accounts~1{account_id}~1data~1{key}' + /assets: + $ref : './components/endpoints/assets.yml#/paths/~1assets' + /claimable_balances: + $ref : './components/endpoints/claimableBalances.yml#/paths/~1claimable_balances' + /claimable_balances/{claimable_balance_id}: + $ref : './components/endpoints/claimableBalances.yml#/paths/~1claimable_balances~1{claimable_balance_id}' + /claimable_balances/{claimable_balance_id}/transactions: + $ref : './components/endpoints/claimableBalances.yml#/paths/~1claimable_balances~1{claimable_balance_id}~1transactions' + /claimable_balances/{claimable_balance_id}/operations: + $ref : './components/endpoints/claimableBalances.yml#/paths/~1claimable_balances~1{claimable_balance_id}~1operations' + /effects: + $ref : './components/endpoints/effects.yml#/paths/~1effects' + /fee_stats: + $ref: './components/endpoints/feeStats.yml#/paths/~1fee_stats' + /ledgers/{sequence}: + $ref : './components/endpoints/ledgers.yml#/paths/~1ledgers~1{sequence}' + /ledgers/{sequence}/transactions: + $ref : './components/endpoints/ledgers.yml#/paths/~1ledgers~1{sequence}~1transactions' + /ledgers/{sequence}/payments: + $ref : './components/endpoints/ledgers.yml#/paths/~1ledgers~1{sequence}~1payments' + /ledgers/{sequence}/operations: + $ref : './components/endpoints/ledgers.yml#/paths/~1ledgers~1{sequence}~1operations' + /ledgers/{sequence}/effects: + $ref : './components/endpoints/ledgers.yml#/paths/~1ledgers~1{sequence}~1effects' + /ledgers: + $ref : './components/endpoints/ledgers.yml#/paths/~1ledgers' + /liquidity_pools: + $ref : './components/endpoints/liquidityPools.yml#/paths/~1liquidity_pools' + /liquidity_pools/{liquidity_pool_id}: + $ref : './components/endpoints/liquidityPools.yml#/paths/~1liquidity_pools~1{liquidity_pool_id}' + /liquidity_pools/{liquidity_pool_id}/effects: + $ref : './components/endpoints/liquidityPools.yml#/paths/~1liquidity_pools~1{liquidity_pool_id}~1effects' + /liquidity_pools/{liquidity_pool_id}/trades: + $ref : './components/endpoints/liquidityPools.yml#/paths/~1liquidity_pools~1{liquidity_pool_id}~1trades' + /liquidity_pools/{liquidity_pool_id}/transactions: + $ref : './components/endpoints/liquidityPools.yml#/paths/~1liquidity_pools~1{liquidity_pool_id}~1transactions' + /liquidity_pools/{liquidity_pool_id}/operations: + $ref : './components/endpoints/liquidityPools.yml#/paths/~1liquidity_pools~1{liquidity_pool_id}~1operations' + /offers: + $ref : './components/endpoints/offers.yml#/paths/~1offers' + /offers/{offer_id}: + $ref : './components/endpoints/offers.yml#/paths/~1offers~1{offer_id}' + /offers/{offer_id}/trades: + $ref : './components/endpoints/offers.yml#/paths/~1offers~1{offer_id}~1trades' + /operations/{id}: + $ref : './components/endpoints/operations.yml#/paths/~1operations~1{id}' + /operations/{id}/effects: + $ref : './components/endpoints/operations.yml#/paths/~1operations~1{id}~1effects' + /operations: + $ref : './components/endpoints/operations.yml#/paths/~1operations' + /order_books{selling_asset_type}: + $ref : './components/endpoints/orderBooks.yml#/paths/~1order_book{selling_asset_type}' + # This path is broken. The URL is wrong. compare example to recieved value + /paths/strict-receive{destination_asset_type}{destination_amount}: + $ref : './components/endpoints/paths.yml#/paths/~1paths~1strict-receive{destination_asset_type}{destination_amount}' + /paths/strict-send{source_asset_type}{source_amount}: + $ref : './components/endpoints/paths.yml#/paths/~1paths~1strict-send{source_asset_type}{source_amount}' + /payments: + $ref : './components/endpoints/operations.yml#/paths/~1payments' + /trade_aggregations{base_asset_type}{counter_asset_type}: + $ref : './components/endpoints/tradeAggregations.yml#/paths/~1trade_aggregations{base_asset_type}{counter_asset_type}' + /trades: + $ref : './components/endpoints/trades.yml#/paths/~1trades' + /transactions/{transaction_hash}: + $ref : './components/endpoints/transactions.yml#/paths/~1transactions~1{transaction_hash}' + /transactions/{transaction_hash}/operations: + $ref : './components/endpoints/transactions.yml#/paths/~1transactions~1{transaction_hash}~1operations' + /transactions/{transaction_hash}/effects: + $ref : './components/endpoints/transactions.yml#/paths/~1transactions~1{transaction_hash}~1effects' + /transactions: + $ref : './components/endpoints/transactions.yml#/paths/~1transactions' diff --git a/openapi/main.yml b/openapi/main.yml deleted file mode 100644 index a6341b3bd..000000000 --- a/openapi/main.yml +++ /dev/null @@ -1,126 +0,0 @@ -openapi: 3.0.3 -info: - title: Horizon - version: 0.0.1 - -servers: - - url: https://horizon.stellar.org - description: The main network - - url: https://horizon-testnet.stellar.org - description: The test network -tags: - - name: Accounts - description: Users interact with the Stellar network through accounts. Everything else in the ledger—assets, offers, trustlines, etc. are owned by accounts, and accounts must authorize all changes to the ledger through signed transactions. - - name: Assets - description: Assets are representations of value issued on the Stellar network. An asset consists of a type, code, and issuer. - - name: Claimable Balances - description: A Claimable Balance represents the transfer of ownership of some amount of an asset. Claimable balances provide a mechanism for setting up a payment which can be claimed in the future. This allows you to make payments to accounts which are currently not able to accept them. - - name: Effects - description: Effects represent specific changes that occur in the ledger as a result of successful operations, but are not necessarily directly reflected in the ledger or history, as transactions and operations are. - - name: Fee Stats - description: Fee stats are used to predict what fee to set for a transaction before submitting it to the network. - - name: Liquidity Pools - description: Liquidity Pools provide a simple, non-interactive way to trade large amounts of capital and enable high volumes of trading. - - name: Ledgers - description: Each ledger stores the state of the network at a point in time and contains all the changes - transactions, operations, effects, etc. - to that state. - - name: Offers - description: Offers are statements about how much of an asset an account wants to buy or sell. - - name: Order Books - description: An order book is a collections of offers for a specific pair of assets. - - name: Trade Aggregations - description: A trade aggregation represents aggregated statistics on an asset pair (base and counter) for a specific time period. Trade aggregations are useful to developers of trading clients and provide historical trade data. - - name: Trades - description: When an offer is fully or partially fulfilled, a trade happens. Trades can also be caused by successful path payments, because path payments involve fulfilling offers. A trade occurs between two parties—base and counter. Which is which is either arbitrary or determined by the calling query. - - name: Transactions - description: Transactions are commands that modify the ledger state and consist of one or more operations. -paths: - /accounts: - $ref: '../openapi/components/endpoints/accounts.yml#/paths/~1accounts' - /accounts/{account_id}: - $ref: '../openapi/components/endpoints/accounts.yml#/paths/~1accounts~1{account_id}' - /accounts/{account_id}/transactions: - $ref : '../openapi/components/endpoints/accounts.yml#/paths/~1accounts~1{account_id}~1transactions' - /accounts/{account_id}/operations: - $ref : '../openapi/components/endpoints/accounts.yml#/paths/~1accounts~1{account_id}~1operations' - /accounts/{account_id}/payments: - $ref : '../openapi/components/endpoints/accounts.yml#/paths/~1accounts~1{account_id}~1payments' - /accounts/{account_id}/effects: - $ref : '../openapi/components/endpoints/accounts.yml#/paths/~1accounts~1{account_id}~1effects' - /accounts/{account_id}/offers: - $ref : '../openapi/components/endpoints/accounts.yml#/paths/~1accounts~1{account_id}~1offers' - /accounts/{account_id}/trades: - $ref : '../openapi/components/endpoints/accounts.yml#/paths/~1accounts~1{account_id}~1trades' - /accounts/{account_id}/data/{key}: - $ref : '../openapi/components/endpoints/accounts.yml#/paths/~1accounts~1{account_id}~1data~1{key}' - /assets: - $ref : '../openapi/components/endpoints/assets.yml#/paths/~1assets' - /claimable_balances: - $ref : '../openapi/components/endpoints/claimableBalances.yml#/paths/~1claimable_balances' - /claimable_balances/{claimable_balance_id}: - $ref : '../openapi/components/endpoints/claimableBalances.yml#/paths/~1claimable_balances~1{claimable_balance_id}' - /claimable_balances/{claimable_balance_id}/transactions: - $ref : '../openapi/components/endpoints/claimableBalances.yml#/paths/~1claimable_balances~1{claimable_balance_id}~1transactions' - /claimable_balances/{claimable_balance_id}/operations: - $ref : '../openapi/components/endpoints/claimableBalances.yml#/paths/~1claimable_balances~1{claimable_balance_id}~1operations' - /effects: - $ref : '../openapi/components/endpoints/effects.yml#/paths/~1effects' - /fee_stats: - $ref: '../openapi/components/endpoints/feeStats.yml#/paths/~1fee_stats' - /ledgers/{sequence}: - $ref : '../openapi/components/endpoints/ledgers.yml#/paths/~1ledgers~1{sequence}' - /ledgers/{sequence}/transactions: - $ref : '../openapi/components/endpoints/ledgers.yml#/paths/~1ledgers~1{sequence}~1transactions' - /ledgers/{sequence}/payments: - $ref : '../openapi/components/endpoints/ledgers.yml#/paths/~1ledgers~1{sequence}~1payments' - /ledgers/{sequence}/operations: - $ref : '../openapi/components/endpoints/ledgers.yml#/paths/~1ledgers~1{sequence}~1operations' - /ledgers/{sequence}/effects: - $ref : '../openapi/components/endpoints/ledgers.yml#/paths/~1ledgers~1{sequence}~1effects' - /ledgers: - $ref : '../openapi/components/endpoints/ledgers.yml#/paths/~1ledgers' - /liquidity_pools: - $ref : '../openapi/components/endpoints/liquidityPools.yml#/paths/~1liquidity_pools' - /liquidity_pools/{liquidity_pool_id}: - $ref : '../openapi/components/endpoints/liquidityPools.yml#/paths/~1liquidity_pools~1{liquidity_pool_id}' - /liquidity_pools/{liquidity_pool_id}/effects: - $ref : '../openapi/components/endpoints/liquidityPools.yml#/paths/~1liquidity_pools~1{liquidity_pool_id}~1effects' - /liquidity_pools/{liquidity_pool_id}/trades: - $ref : '../openapi/components/endpoints/liquidityPools.yml#/paths/~1liquidity_pools~1{liquidity_pool_id}~1trades' - /liquidity_pools/{liquidity_pool_id}/transactions: - $ref : '../openapi/components/endpoints/liquidityPools.yml#/paths/~1liquidity_pools~1{liquidity_pool_id}~1transactions' - /liquidity_pools/{liquidity_pool_id}/operations: - $ref : '../openapi/components/endpoints/liquidityPools.yml#/paths/~1liquidity_pools~1{liquidity_pool_id}~1operations' - /offers: - $ref : '../openapi/components/endpoints/offers.yml#/paths/~1offers' - /offers/{offer_id}: - $ref : '../openapi/components/endpoints/offers.yml#/paths/~1offers~1{offer_id}' - /offers/{offer_id}/trades: - $ref : '../openapi/components/endpoints/offers.yml#/paths/~1offers~1{offer_id}~1trades' - /operations/{id}: - $ref : '../openapi/components/endpoints/operations.yml#/paths/~1operations~1{id}' - /operations/{id}/effects: - $ref : '../openapi/components/endpoints/operations.yml#/paths/~1operations~1{id}~1effects' - /operations: - $ref : '../openapi/components/endpoints/operations.yml#/paths/~1operations' - /order_books{selling_asset_type}: - $ref : '../openapi/components/endpoints/orderBooks.yml#/paths/~1order_book{selling_asset_type}' - # This path is broken. The URL is wrong. compare example to recieved value - /paths/strict-receive{destination_asset_type}{destination_amount}: - $ref : '../openapi/components/endpoints/paths.yml#/paths/~1paths~1strict-receive{destination_asset_type}{destination_amount}' - /paths/strict-send{source_asset_type}{source_amount}: - $ref : '../openapi/components/endpoints/paths.yml#/paths/~1paths~1strict-send{source_asset_type}{source_amount}' - /payments: - $ref : '../openapi/components/endpoints/operations.yml#/paths/~1payments' - /trade_aggregations{base_asset_type}{counter_asset_type}: - $ref : '../openapi/components/endpoints/tradeAggregations.yml#/paths/~1trade_aggregations{base_asset_type}{counter_asset_type}' - /trades: - $ref : '../openapi/components/endpoints/trades.yml#/paths/~1trades' - /transactions/{transaction_hash}: - $ref : '../openapi/components/endpoints/transactions.yml#/paths/~1transactions~1{transaction_hash}' - /transactions/{transaction_hash}/operations: - $ref : '../openapi/components/endpoints/transactions.yml#/paths/~1transactions~1{transaction_hash}~1operations' - /transactions/{transaction_hash}/effects: - $ref : '../openapi/components/endpoints/transactions.yml#/paths/~1transactions~1{transaction_hash}~1effects' - /transactions: - $ref : '../openapi/components/endpoints/transactions.yml#/paths/~1transactions' - \ No newline at end of file diff --git a/package.json b/package.json index 04cb2cf1e..e0b526507 100644 --- a/package.json +++ b/package.json @@ -11,8 +11,8 @@ "clear": "docusaurus clear", "serve": "docusaurus serve", "api:clean": "docusaurus clean-api-docs all", - "api:bundle": "redocly bundle openapi/main.yml --output openapi/bundled.yml && redocly bundle openapi/ap/Platform\\ API.yml --output openapi/ap/bundled.yml && yarn redocly bundle openapi/ap/Callbacks\\ API.yml --output openapi/ap/bundled_callback.yml", - "api:gen": "docusaurus gen-api-docs all && rm api/resources/*.info.mdx && rm ap_api/resources/*.info.mdx && rm ap_api/callbacks/*.info.mdx", + "api:bundle": "redocly bundle openapi/horizon/main.yml --output openapi/horizon/bundled.yml && redocly bundle openapi/anchor-platform/Platform\\ API.yml --output openapi/anchor-platform/bundled.yml && yarn redocly bundle openapi/anchor-platform/Callbacks\\ API.yml --output openapi/anchor-platform/bundled_callback.yml", + "api:gen": "docusaurus gen-api-docs all && rm api/horizon/resources/*.info.mdx && rm api/anchor-platform/resources/*.info.mdx && rm api/anchor-platform/callbacks/*.info.mdx", "api": "yarn api:clean && yarn api:bundle && yarn api:gen", "write-translations": "docusaurus write-translations", "write-heading-ids": "docusaurus write-heading-ids", diff --git a/sidebars.js b/sidebars.js index dcf934ace..bec99bcb3 100644 --- a/sidebars.js +++ b/sidebars.js @@ -2,7 +2,7 @@ /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ const sidebars = { - myAutogeneratedSidebar: [ + docs: [ { type: 'autogenerated', dirName: '.', diff --git a/sidebarsApi.js b/sidebarsApi.js index 4457d6741..20d3088c2 100644 --- a/sidebarsApi.js +++ b/sidebarsApi.js @@ -2,12 +2,31 @@ /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ const sidebars = { - apiSidebar: [ + horizon: [ { - type: "autogenerated", - dirName: ".", + type: 'category', + label: 'Horizon API', + items: [ + { + type: "autogenerated", + dirName: "horizon", + }, + ], + collapsible: false, }, ], -}; + anchor_platform: [ + { + type: 'category', + label: 'Anchor Platform API', + items: [ + { + type: "autogenerated", + dirName: "anchor-platform", + }, + ], + } + ], +} module.exports = sidebars; diff --git a/src/css/custom.scss b/src/css/custom.scss index 0be262384..b1e398aff 100644 --- a/src/css/custom.scss +++ b/src/css/custom.scss @@ -41,4 +41,4 @@ var(--ifm-heading-vertical-rhythm-bottom) * var(--ifm-leading) ); margin-top: calc(var(--ifm-h4-vertical-rhythm-top) * var(--ifm-leading)); -} \ No newline at end of file +} diff --git a/src/sidebar-api-generator.js b/src/sidebar-api-generator.js index f6f6ae75c..1ee0b9487 100644 --- a/src/sidebar-api-generator.js +++ b/src/sidebar-api-generator.js @@ -18,6 +18,7 @@ module.exports = async ({ defaultSidebarItemsGenerator, ...args }) => { const sidebarPath = path.join( args.version.contentPath, + args.item.dirName, "./resources/sidebar.js", ); @@ -46,6 +47,7 @@ module.exports = async ({ defaultSidebarItemsGenerator, ...args }) => { const sidebarPath2 = path.join( args.version.contentPath, + args.item.dirName, "./callbacks/sidebar.js", ); diff --git a/src/theme/DocSidebar/index.js b/src/theme/DocSidebar/index.js new file mode 100644 index 000000000..8aba0c34b --- /dev/null +++ b/src/theme/DocSidebar/index.js @@ -0,0 +1,23 @@ +import React from 'react'; +import DocSidebar from '@theme-original/DocSidebar'; + +export default function DocSidebarWrapper(props) { + let newProps + + // For all `/api` sidebars, remove the parent category from the sidebar + if (props.path.startsWith('/api')) { + newProps = { + ...props, + sidebar: props.sidebar[0].items + } + } + // For all other sidebars, pass the default props + else { + newProps = props + } + return ( + <> + + + ); +}