{ "opencollection": "1.0.0", "info": { "name": "Algod REST API. common search API", "version": "0.0.1" }, "request": { "auth": { "type": "apikey", "key": "X-Algo-API-Token", "value": "{{X-Algo-API-Token}}", "placement": "header" } }, "items": [ { "info": { "name": "search", "type": "folder" }, "items": [ { "info": { "name": "searchForAccounts", "type": "http" }, "http": { "method": "GET", "url": "http://localhost/v2/accounts", "params": [ { "name": "asset-id", "value": "", "type": "query", "description": "Asset ID" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results to return. There could be additional pages even if the limit is not reached." }, { "name": "next", "value": "", "type": "query", "description": "The next page of results. Use the next token provided by the previous results." }, { "name": "currency-greater-than", "value": "", "type": "query", "description": "Results should have an amount greater than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used." }, { "name": "include-all", "value": "", "type": "query", "description": "Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates." }, { "name": "exclude", "value": "", "type": "query", "description": "Exclude additional items such as asset holdings, application local data stored for this account, asset parameters created by this account, and application parameters created by this account." }, { "name": "currency-less-than", "value": "", "type": "query", "description": "Results should have an amount less than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used." }, { "name": "auth-addr", "value": "", "type": "query", "description": "Include accounts configured to use this spending key." }, { "name": "round", "value": "", "type": "query", "description": "Include results for the specified round. For performance reasons, this parameter may be disabled on some configurations. Using application-id or asset-id filters will return both creator and opt-in accounts. Filtering by include-all will return creator and opt-in accounts for deleted assets and accounts. Non-opt-in managers are not included in the results when asset-id is used." }, { "name": "application-id", "value": "", "type": "query", "description": "Application ID" }, { "name": "online-only", "value": "", "type": "query", "description": "When this is set to true, return only accounts whose participation status is currently online." } ] }, "docs": "Search for accounts." }, { "info": { "name": "searchForApplications", "type": "http" }, "http": { "method": "GET", "url": "http://localhost/v2/applications", "params": [ { "name": "application-id", "value": "", "type": "query", "description": "Application ID" }, { "name": "creator", "value": "", "type": "query", "description": "Filter just applications with the given creator address." }, { "name": "include-all", "value": "", "type": "query", "description": "Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results to return. There could be additional pages even if the limit is not reached." }, { "name": "next", "value": "", "type": "query", "description": "The next page of results. Use the next token provided by the previous results." } ] }, "docs": "Search for applications" }, { "info": { "name": "Get box names for a given application.", "type": "http" }, "http": { "method": "GET", "url": "http://localhost/v2/applications/:application-id/boxes", "params": [ { "name": "application-id", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results to return. There could be additional pages even if the limit is not reached." }, { "name": "next", "value": "", "type": "query", "description": "The next page of results. Use the next token provided by the previous results." } ] }, "docs": "Given an application ID, returns the box names of that application sorted lexicographically." }, { "info": { "name": "searchForAssets", "type": "http" }, "http": { "method": "GET", "url": "http://localhost/v2/assets", "params": [ { "name": "include-all", "value": "", "type": "query", "description": "Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results to return. There could be additional pages even if the limit is not reached." }, { "name": "next", "value": "", "type": "query", "description": "The next page of results. Use the next token provided by the previous results." }, { "name": "creator", "value": "", "type": "query", "description": "Filter just assets with the given creator address." }, { "name": "name", "value": "", "type": "query", "description": "Filter just assets with the given name." }, { "name": "unit", "value": "", "type": "query", "description": "Filter just assets with the given unit." }, { "name": "asset-id", "value": "", "type": "query", "description": "Asset ID" } ] }, "docs": "Search for assets." }, { "info": { "name": "searchForBlockHeaders", "type": "http" }, "http": { "method": "GET", "url": "http://localhost/v2/block-headers", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results to return. There could be additional pages even if the limit is not reached." }, { "name": "next", "value": "", "type": "query", "description": "The next page of results. Use the next token provided by the previous results." }, { "name": "min-round", "value": "", "type": "query", "description": "Include results at or after the specified min-round." }, { "name": "max-round", "value": "", "type": "query", "description": "Include results at or before the specified max-round." }, { "name": "before-time", "value": "", "type": "query", "description": "Include results before the given time. Must be an RFC 3339 formatted string." }, { "name": "after-time", "value": "", "type": "query", "description": "Include results after the given time. Must be an RFC 3339 formatted string." }, { "name": "proposers", "value": "", "type": "query", "description": "Accounts marked as proposer in the block header's participation updates. This parameter accepts a comma separated list of addresses." }, { "name": "expired", "value": "", "type": "query", "description": "Accounts marked as expired in the block header's participation updates. This parameter accepts a comma separated list of addresses." }, { "name": "absent", "value": "", "type": "query", "description": "Accounts marked as absent in the block header's participation updates. This parameter accepts a comma separated list of addresses." } ] }, "docs": "Search for block headers. Block headers are returned in ascending round order. Transactions are not included in the output." }, { "info": { "name": "searchForTransactions", "type": "http" }, "http": { "method": "GET", "url": "http://localhost/v2/transactions", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results to return. There could be additional pages even if the limit is not reached." }, { "name": "next", "value": "", "type": "query", "description": "The next page of results. Use the next token provided by the previous results." }, { "name": "note-prefix", "value": "", "type": "query", "description": "Specifies a prefix which must be contained in the note field." }, { "name": "tx-type", "value": "", "type": "query" }, { "name": "sig-type", "value": "", "type": "query", "description": "SigType filters just results using the specified type of signature:\n* sig - Standard\n* msig - MultiSig\n* lsig - LogicSig" }, { "name": "group-id", "value": "", "type": "query", "description": "Lookup transactions by group ID. This field must be base64-encoded, and afterwards, base64 characters that are URL-unsafe (i.e. =, /, +) must be URL-encoded" }, { "name": "txid", "value": "", "type": "query", "description": "Lookup the specific transaction by ID." }, { "name": "round", "value": "", "type": "query", "description": "Include results for the specified round." }, { "name": "min-round", "value": "", "type": "query", "description": "Include results at or after the specified min-round." }, { "name": "max-round", "value": "", "type": "query", "description": "Include results at or before the specified max-round." }, { "name": "asset-id", "value": "", "type": "query", "description": "Asset ID" }, { "name": "before-time", "value": "", "type": "query", "description": "Include results before the given time. Must be an RFC 3339 formatted string." }, { "name": "after-time", "value": "", "type": "query", "description": "Include results after the given time. Must be an RFC 3339 formatted string." }, { "name": "currency-greater-than", "value": "", "type": "query", "description": "Results should have an amount greater than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used." }, { "name": "currency-less-than", "value": "", "type": "query", "description": "Results should have an amount less than this value. MicroAlgos are the default currency unless an asset-id is provided, in which case the asset will be used." }, { "name": "address", "value": "", "type": "query", "description": "Only include transactions with this address in one of the transaction fields." }, { "name": "address-role", "value": "", "type": "query", "description": "Combine with the address parameter to define what type of address to search for." }, { "name": "exclude-close-to", "value": "", "type": "query", "description": "Combine with address and address-role parameters to define what type of address to search for. The close to fields are normally treated as a receiver, if you would like to exclude them set this parameter to true." }, { "name": "rekey-to", "value": "", "type": "query", "description": "Include results which include the rekey-to field." }, { "name": "application-id", "value": "", "type": "query", "description": "Application ID" } ] }, "docs": "Search for transactions. Transactions are returned oldest to newest unless the address parameter is used, in which case results are returned newest to oldest." } ] } ], "bundled": true }