A lot of the current commands available in the API operate on generic templated code that allows insertion of any object type without the need for repeated functions to handle each object type. The following list of generic endpoints have default parameters that can be useful to know outside of each individual command-set.
The following templates do not exceed a local scope, meaning they will return results derived from the internal indexing services which requires login and authorization. The data-set returned from these templates is stored in the Logical Database, and thus only provides data local to a profile-id, meaning history and transactions will only show events that happened on the profile that generated indexes with login.
The following list of verbs are templates throughout the Nexus APIs. While the action is generic in nature (i.e. list, get, create), implementations of these actions will adhere to certain semantics or mandatory parameters regardless of the noun (resource).
list
order : The order of the results. Values can be desc (default) or asclimit : The number of records to return, default 100. limit=none is allowed.page: Allows the results to be returned by page (zero based). E.g. passing in page=1 will return the second set of (limit) transactions. The default value is 0 if not supplied.offset : An alternative to page, offset can be used to return a set of (limit) results from a particular index.verbose : to indicate the verbosity of the data returned. Values can be default, summary, or detailget
verbose : to indicate the verbosity of the data returned. Values can be default, summary, or detailcreate
format : indicates the format of the data being provided to create the item / object (where applicable). Values can be basic, raw, and JSONscheme : sets the key type to be used for the given transaction. Values can be falcon or brainbpoolupdate
format : indicates the format of the data being provided to create the item / object (where applicable). Values can be basic, raw, standard, and JSONscheme : sets the key type to be used for the given transaction. Values can be falcon or brainbpooltransfer
address: the address of object to transferrecipient: the profile-id of the sigchain receiving object.scheme : sets the key type to be used for the given transaction. Values can be falcon or brainbpoolclaim
address: the address of object to claimtxid: the transaction-id of the transfer we are claiming.scheme : sets the key type to be used for the given transaction. Values can be falcon or brainbpoolhistory
address: the address of object to view history for.order : The order of the results. Values can be desc (default) or asclimit : The number of records to return, default 100. limit=none is allowed.page: Allows the results to be returned by page (zero based). E.g. passing in page=1 will return the second set of (limit) transactions. The default value is 0 if not supplied.offset : An alternative to page, offset can be used to return a set of (limit) results from a particular index.verbose : to indicate the verbosity of the data returned. Values can be default, summary, or detailtransactions
address: the address of object to view transactions for.order : The order of the results. Values can be desc (default) or asclimit : The number of records to return, default 100. limit=none is allowed.page: Allows the results to be returned by page (zero based). E.g. passing in page=1 will return the second set of (limit) transactions. The default value is 0 if not supplied.offset : An alternative to page, offset can be used to return a set of (limit) results from a particular index.verbose : to indicate the verbosity of the data returned. Values can be default, summary, or detail