Kaspa REST-API server 2.1.6 to 2.3.0 API CHANGES
v1.0.0https://kas.nownodes.ioThis page lists what changed in the Kaspa REST API between server versions 2.1.6 and 2.3.0. Only changed methods are listed. Everything not mentioned here works exactly as described in the main Kaspa REST-API server reference. No method was added or removed in these releases.
Changed
block_hashof a transaction now contains exactly one block hash instead of every block the transaction was included in. Which one is returned is not defined, so it must not be treated as the only block that carries the transaction. If your integration relies on the full list, this is the change to look at.- Transaction inputs carry two new fields:
compute_budgetandcovenant_id. - Transaction outputs carry two new fields:
covenant_authorizing_inputandcovenant_id, and no longer carryaccepting_block_hash. The transaction-levelaccepting_block_hashis not affected and is still returned. - In block transactions, inputs carry the new
computeBudgetfield and outputs carry the newcovenantobject.
Affected methods:
GET /transactions/{transactionId}POST /transactions/searchGET /addresses/{kaspaAddress}/full-transactionsGET /addresses/{kaspaAddress}/full-transactions-pageGET /blocks/{blockId}GET /blocksGET /blocks-from-bluescore
About the new fields
The new fields are filled in only for the transactions that use these features. Everywhere else they come back as null, but the keys themselves are always present, so a client that parses responses strictly should be ready for them.
Authentication
api-keyAuthapiKeyAPI Key: api-key in header
REST API changelog 2.1.6 to 2.3.0
Addresses
Get Full Transactions For Address
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Changed. block_hash now contains exactly one block hash instead of every block the transaction was included in. Inputs carry the new compute_budget and covenant_id; outputs carry the new covenant_authorizing_input and covenant_id and no longer carry accepting_block_hash. The new fields are filled in only for the transactions that use these features, otherwise they are null.
Get all transactions for a given address from database. And then get their related full transaction data
Parameters
kaspaAddressstringrequiredpathKaspa address as string e.g. kaspa:qqkqkzjvr7zwxxmjxjkmxxdwju9kjs6e9u82uh59z07vgaks6gg62v8707g73
limitinteger[1, 500]50queryThe number of records to get
offsetinteger>= 00queryThe offset from which to get records
fieldsstringqueryresolve_previous_outpointsPreviousOutpointLookupModenoqueryUse this parameter if you want to fetch the TransactionInput previous outpoint details. Light fetches only the adress and amount. Full fetches the whole TransactionOutput and adds it into each TxInput.
Response
Successful Response
Validation Error
Get Full Transactions For Address Page
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Changed. block_hash now contains exactly one block hash instead of every block the transaction was included in. Inputs carry the new compute_budget and covenant_id; outputs carry the new covenant_authorizing_input and covenant_id and no longer carry accepting_block_hash. The new fields are filled in only for the transactions that use these features, otherwise they are null.
Get all transactions for a given address from database. And then get their related full transaction data
Parameters
kaspaAddressstringrequiredpathKaspa address as string e.g. kaspa:qqkqkzjvr7zwxxmjxjkmxxdwju9kjs6e9u82uh59z07vgaks6gg62v8707g73
limitinteger[1, 500]50queryThe max number of records to get. For paging combine with using 'before/after' from oldest previous result. Use value of X-Next-Page-Before/-After as long as header is present to continue paging. The actual number of transactions returned for each page can be > limit.
beforeinteger>= 00queryOnly include transactions with block time before this (epoch-millis)
afterinteger>= 00queryOnly include transactions with block time after this (epoch-millis)
fieldsstringqueryresolve_previous_outpointsPreviousOutpointLookupModenoqueryUse this parameter if you want to fetch the TransactionInput previous outpoint details. Light fetches only the adress and amount. Full fetches the whole TransactionOutput and adds it into each TxInput.
acceptanceAcceptanceModeacceptedrejectedqueryResponse
Successful Response
Validation Error
Blocks
Get Blocks
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Changed. In the transactions of a block, every input now carries computeBudget and every output carries the covenant object. Both are filled in only for the transactions that use these features, otherwise they are null.
Lists block beginning from a low hash (block id).
Parameters
lowHashstringrequiredqueryincludeBlocksbooleanfalsequeryincludeTransactionsbooleanfalsequeryResponse
Successful Response
Validation Error
Get Blocks From Bluescore
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Changed. In the transactions of a block, every input now carries computeBudget and every output carries the covenant object. Both are filled in only for the transactions that use these features, otherwise they are null.
Lists blocks of a given blueScore
Parameters
blueScoreinteger43679173queryincludeTransactionsbooleanfalsequeryResponse
Successful Response
Validation Error
Get Block
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Changed. In the transactions of a block, every input now carries computeBudget and every output carries the covenant object. Both are filled in only for the transactions that use these features, otherwise they are null.
Get block information for a given block id
Parameters
blockIdstringrequiredpathincludeTransactionsbooleantruequeryincludeColorbooleanfalsequeryResponse
Successful Response
Validation Error
Transactions
Search For Transactions
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Changed. block_hash now contains exactly one block hash instead of every block the transaction was included in. Inputs carry the new compute_budget and covenant_id; outputs carry the new covenant_authorizing_input and covenant_id and no longer carry accepting_block_hash. The new fields are filled in only for the transactions that use these features, otherwise they are null.
Search for transactions by transaction_ids or blue_score
Body
transactionIdsArray<string>acceptingBlueScoresTxSearchAcceptingBlueScoresParameters
fieldsstringqueryresolve_previous_outpointsPreviousOutpointLookupModenoqueryUse this parameter if you want to fetch the TransactionInput previous outpoint details. Light fetches only the address and amount. Full fetches the whole TransactionOutput and adds it into each TxInput.
acceptanceAcceptanceModequeryOnly used when searching using transactionIds
Response
Successful Response
Validation Error
Get Transaction
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Changed. block_hash now contains exactly one block hash instead of every block the transaction was included in. Inputs carry the new compute_budget and covenant_id; outputs carry the new covenant_authorizing_input and covenant_id and no longer carry accepting_block_hash. The new fields are filled in only for the transactions that use these features, otherwise they are null.
Get details for a given transaction id
Parameters
transactionIdstringrequiredpathblockHashstringquerySpecify a containing block (if known) for faster lookup
inputsbooleantruequeryoutputsbooleantruequeryresolve_previous_outpointsPreviousOutpointLookupModenoqueryUse this parameter if you want to fetch the TransactionInput previous outpoint details. Light fetches only the address and amount. Full fetches the whole TransactionOutput and adds it into each TxInput.
Response
Successful Response
Validation Error