{ "opencollection": "1.0.0", "info": { "name": "Platform Server Accounts API", "version": "3.0.0" }, "items": [ { "info": { "name": "Accounts", "type": "folder" }, "items": [ { "info": { "name": "List all Accounts", "type": "http" }, "http": { "method": "GET", "url": "https://platform-server.exampleanchor.com/accounts", "params": [ { "name": "sponser", "value": "", "type": "query", "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." }, { "name": "asset", "value": "", "type": "query", "description": "An issued asset represented as “Code:IssuerAccountID”. Every account in the response will have a trustline for the given asset." }, { "name": "signer", "value": "", "type": "query", "description": "Account ID of the signer. Every account in the response will have the given account ID as a signer." }, { "name": "liqudity_pool", "value": "", "type": "query", "description": "With this parameter, the results will include only accounts which have trustlines to the specified liquidity pool." }, { "name": "cursor", "value": "", "type": "query", "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." }, { "name": "order", "value": "", "type": "query", "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`." }, { "name": "limit", "value": "", "type": "query", "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." } ] }, "docs": "This endpoint lists accounts by one of four filters : signer, asset, liquidity pool or sponsor." }, { "info": { "name": "Retrieve an Account", "type": "http" }, "http": { "method": "GET", "url": "https://platform-server.exampleanchor.com/accounts/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "This account’s public key encoded in a base32 string representation." } ] }, "docs": "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." }, { "info": { "name": "Retrieve an Account's Transactions", "type": "http" }, "http": { "method": "GET", "url": "https://platform-server.exampleanchor.com/accounts/:account_id/transactions", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "This account’s public key encoded in a base32 string representation." }, { "name": "cursor", "value": "", "type": "query", "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." }, { "name": "order", "value": "", "type": "query", "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`." }, { "name": "limit", "value": "", "type": "query", "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." }, { "name": "include_failed", "value": "", "type": "query", "description": "Set to true to include failed operations in results. Options include true and false." } ] }, "docs": "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." }, { "info": { "name": "Retrieve an Account's Operations", "type": "http" }, "http": { "method": "GET", "url": "https://platform-server.exampleanchor.com/accounts/:account_id/operations", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "This account’s public key encoded in a base32 string representation." }, { "name": "cursor", "value": "", "type": "query", "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." }, { "name": "order", "value": "", "type": "query", "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`." }, { "name": "limit", "value": "", "type": "query", "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." }, { "name": "include_failed", "value": "", "type": "query", "description": "Set to true to include failed operations in results. Options include true and false." }, { "name": "join", "value": "", "type": "query", "description": "Set to transactions to include the transactions which created each of the operations in the response." } ] }, "docs": "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." }, { "info": { "name": "Retrieve an Account's Payments", "type": "http" }, "http": { "method": "GET", "url": "https://platform-server.exampleanchor.com/accounts/:account_id/payments", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "This account’s public key encoded in a base32 string representation." }, { "name": "cursor", "value": "", "type": "query", "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." }, { "name": "order", "value": "", "type": "query", "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`." }, { "name": "limit", "value": "", "type": "query", "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." }, { "name": "include_failed", "value": "", "type": "query", "description": "Set to true to include failed operations in results. Options include true and false." }, { "name": "join", "value": "", "type": "query", "description": "Set to transactions to include the transactions which created each of the operations in the response." } ] }, "docs": "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." }, { "info": { "name": "Retrieve an Account's Effects", "type": "http" }, "http": { "method": "GET", "url": "https://platform-server.exampleanchor.com/accounts/:account_id/effects", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "This account’s public key encoded in a base32 string representation." }, { "name": "cursor", "value": "", "type": "query", "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." }, { "name": "order", "value": "", "type": "query", "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`." }, { "name": "limit", "value": "", "type": "query", "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." } ] }, "docs": "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." }, { "info": { "name": "Retrieve an Account's Offers", "type": "http" }, "http": { "method": "GET", "url": "https://platform-server.exampleanchor.com/accounts/:account_id/offers", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "This account’s public key encoded in a base32 string representation." }, { "name": "cursor", "value": "", "type": "query", "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." }, { "name": "order", "value": "", "type": "query", "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`." }, { "name": "limit", "value": "", "type": "query", "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." } ] }, "docs": "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." }, { "info": { "name": "Retrieve an Account's Trades", "type": "http" }, "http": { "method": "GET", "url": "https://platform-server.exampleanchor.com/accounts/:account_id/trades", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "This account’s public key encoded in a base32 string representation." }, { "name": "cursor", "value": "", "type": "query", "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." }, { "name": "order", "value": "", "type": "query", "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`." }, { "name": "limit", "value": "", "type": "query", "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." } ] }, "docs": "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." }, { "info": { "name": "Retrieve an Account's Data", "type": "http" }, "http": { "method": "GET", "url": "https://platform-server.exampleanchor.com/accounts/:account_id/data/:key", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "This account’s public key encoded in a base32 string representation." }, { "name": "key", "value": "", "type": "path", "description": "The key name for this data." } ] }, "docs": "This endpoint represents a single data for a given account." } ] } ], "bundled": true }