Akash Network Transactions API
The Transactions API from Akash Network — 7 operation(s) for transactions.
OpenAPI Specification
swagger: '2.0'
info:
title: AKASH - gRPC Gateway docs Addresses Transactions API
description: A REST interface for state queries
version: 1.0.0
tags:
- name: Transactions
paths:
/txs/{hash}:
get:
deprecated: true
summary: Get a Tx by hash
tags:
- Transactions
description: Retrieve a transaction using its hash.
produces:
- application/json
parameters:
- in: path
name: hash
description: Tx hash
required: true
type: string
x-example: BCBE20E8D46758B96AE5883B792858296AC06E51435490FBDCAE25A72B3CC76B
responses:
'200':
description: Tx with the provided hash
schema:
type: object
properties:
hash:
type: string
example: D085138D913993919295FF4B0A9107F1F2CDE0D37A87CE0644E217CBF3B49656
height:
type: number
example: 368
tx:
type: object
properties:
msg:
type: array
items:
type: string
fee:
type: object
properties:
gas:
type: string
amount:
type: array
items:
type: object
properties:
denom:
type: string
example: stake
amount:
type: string
example: '50'
memo:
type: string
signature:
type: object
properties:
signature:
type: string
example: MEUCIQD02fsDPra8MtbRsyB1w7bqTM55Wu138zQbFcWx4+CFyAIge5WNPfKIuvzBZ69MyqHsqD8S1IwiEp+iUb6VSdtlpgY=
pub_key:
type: object
properties:
type:
type: string
example: tendermint/PubKeySecp256k1
value:
type: string
example: Avz04VhtKJh8ACCVzlI8aTosGy0ikFXKIVHQ3jKMrosH
account_number:
type: string
example: '0'
sequence:
type: string
example: '0'
result:
type: object
properties:
log:
type: string
gas_wanted:
type: string
example: '200000'
gas_used:
type: string
example: '26354'
tags:
type: array
items:
type: object
properties:
key:
type: string
value:
type: string
'500':
description: Internal Server Error
/txs:
get:
deprecated: true
tags:
- Transactions
summary: Search transactions
description: Search transactions by events.
produces:
- application/json
parameters:
- in: query
name: message.action
type: string
description: 'transaction events such as ''message.action=send'' which results in the following endpoint: ''GET /txs?message.action=send''. note that each module documents its own events. look for xx_events.md in the corresponding cosmos-sdk/docs/spec directory'
x-example: send
- in: query
name: message.sender
type: string
description: 'transaction tags with sender: ''GET /txs?message.action=send&message.sender=cosmos16xyempempp92x9hyzz9wrgf94r6j9h5f06pxxv'''
x-example: cosmos16xyempempp92x9hyzz9wrgf94r6j9h5f06pxxv
- in: query
name: page
description: Page number
type: integer
x-example: 1
- in: query
name: limit
description: Maximum number of items per page
type: integer
x-example: 1
- in: query
name: tx.minheight
type: integer
description: transactions on blocks with height greater or equal this value
x-example: 25
- in: query
name: tx.maxheight
type: integer
description: transactions on blocks with height less than or equal this value
x-example: 800000
responses:
'200':
description: All txs matching the provided events
schema:
type: object
properties:
total_count:
type: number
example: 1
count:
type: number
example: 1
page_number:
type: number
example: 1
page_total:
type: number
example: 1
limit:
type: number
example: 30
txs:
type: array
items:
type: object
properties:
hash:
type: string
example: D085138D913993919295FF4B0A9107F1F2CDE0D37A87CE0644E217CBF3B49656
height:
type: number
example: 368
tx:
type: object
properties:
msg:
type: array
items:
type: string
fee:
type: object
properties:
gas:
type: string
amount:
type: array
items:
type: object
properties:
denom:
type: string
example: stake
amount:
type: string
example: '50'
memo:
type: string
signature:
type: object
properties:
signature:
type: string
example: MEUCIQD02fsDPra8MtbRsyB1w7bqTM55Wu138zQbFcWx4+CFyAIge5WNPfKIuvzBZ69MyqHsqD8S1IwiEp+iUb6VSdtlpgY=
pub_key:
type: object
properties:
type:
type: string
example: tendermint/PubKeySecp256k1
value:
type: string
example: Avz04VhtKJh8ACCVzlI8aTosGy0ikFXKIVHQ3jKMrosH
account_number:
type: string
example: '0'
sequence:
type: string
example: '0'
result:
type: object
properties:
log:
type: string
gas_wanted:
type: string
example: '200000'
gas_used:
type: string
example: '26354'
tags:
type: array
items:
type: object
properties:
key:
type: string
value:
type: string
'400':
description: Invalid search events
'500':
description: Internal Server Error
post:
tags:
- Transactions
summary: Broadcast a signed tx
description: Broadcast a signed tx to a full node
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: txBroadcast
description: The tx must be a signed StdTx. The supported broadcast modes include `"block"`(return after tx commit), `"sync"`(return afer CheckTx) and `"async"`(return right away).
required: true
schema:
type: object
properties:
tx:
type: object
properties:
msg:
type: array
items:
type: string
fee:
type: object
properties:
gas:
type: string
amount:
type: array
items:
type: object
properties:
denom:
type: string
example: stake
amount:
type: string
example: '50'
memo:
type: string
signature:
type: object
properties:
signature:
type: string
example: MEUCIQD02fsDPra8MtbRsyB1w7bqTM55Wu138zQbFcWx4+CFyAIge5WNPfKIuvzBZ69MyqHsqD8S1IwiEp+iUb6VSdtlpgY=
pub_key:
type: object
properties:
type:
type: string
example: tendermint/PubKeySecp256k1
value:
type: string
example: Avz04VhtKJh8ACCVzlI8aTosGy0ikFXKIVHQ3jKMrosH
account_number:
type: string
example: '0'
sequence:
type: string
example: '0'
mode:
type: string
example: block
responses:
'200':
description: Tx broadcasting result
schema:
type: object
properties:
check_tx:
type: object
properties:
code:
type: integer
data:
type: string
gas_used:
type: integer
gas_wanted:
type: integer
info:
type: string
log:
type: string
tags:
type: array
items:
type: object
properties:
key:
type: string
value:
type: string
example:
code: 0
data: data
log: log
gas_used: 5000
gas_wanted: 10000
info: info
tags:
- ''
- ''
deliver_tx:
type: object
properties:
code:
type: integer
data:
type: string
gas_used:
type: integer
gas_wanted:
type: integer
info:
type: string
log:
type: string
tags:
type: array
items:
type: object
properties:
key:
type: string
value:
type: string
example:
code: 5
data: data
log: log
gas_used: 5000
gas_wanted: 10000
info: info
tags:
- ''
- ''
hash:
type: string
example: EE5F3404034C524501629B56E0DDC38FAD651F04
height:
type: integer
'500':
description: Internal Server Error
/txs/encode:
post:
deprecated: true
tags:
- Transactions
summary: Encode a transaction to the Amino wire format
description: Encode a transaction (signed or not) from JSON to base64-encoded Amino serialized bytes
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: tx
description: The tx to encode
required: true
schema:
type: object
properties:
tx:
type: object
properties:
msg:
type: array
items:
type: string
fee:
type: object
properties:
gas:
type: string
amount:
type: array
items:
type: object
properties:
denom:
type: string
example: stake
amount:
type: string
example: '50'
memo:
type: string
signature:
type: object
properties:
signature:
type: string
example: MEUCIQD02fsDPra8MtbRsyB1w7bqTM55Wu138zQbFcWx4+CFyAIge5WNPfKIuvzBZ69MyqHsqD8S1IwiEp+iUb6VSdtlpgY=
pub_key:
type: object
properties:
type:
type: string
example: tendermint/PubKeySecp256k1
value:
type: string
example: Avz04VhtKJh8ACCVzlI8aTosGy0ikFXKIVHQ3jKMrosH
account_number:
type: string
example: '0'
sequence:
type: string
example: '0'
responses:
'200':
description: The tx was successfully decoded and re-encoded
schema:
type: object
properties:
tx:
type: string
example: The base64-encoded Amino-serialized bytes for the tx
'400':
description: The tx was malformated
'500':
description: Server internal error
/txs/decode:
post:
deprecated: true
tags:
- Transactions
summary: Decode a transaction from the Amino wire format
description: Decode a transaction (signed or not) from base64-encoded Amino serialized bytes to JSON
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: tx
description: The tx to decode
required: true
schema:
type: object
properties:
tx:
type: string
example: SvBiXe4KPqijYZoKFFHEzJ8c2HPAfv2EFUcIhx0yPagwEhTy0vPA+GGhCEslKXa4Af0uB+mfShoMCgVzdGFrZRIDMTAwEgQQwJoM
responses:
'200':
description: The tx was successfully decoded
schema:
type: object
properties:
msg:
type: array
items:
type: string
fee:
type: object
properties:
gas:
type: string
amount:
type: array
items:
type: object
properties:
denom:
type: string
example: stake
amount:
type: string
example: '50'
memo:
type: string
signature:
type: object
properties:
signature:
type: string
example: MEUCIQD02fsDPra8MtbRsyB1w7bqTM55Wu138zQbFcWx4+CFyAIge5WNPfKIuvzBZ69MyqHsqD8S1IwiEp+iUb6VSdtlpgY=
pub_key:
type: object
properties:
type:
type: string
example: tendermint/PubKeySecp256k1
value:
type: string
example: Avz04VhtKJh8ACCVzlI8aTosGy0ikFXKIVHQ3jKMrosH
account_number:
type: string
example: '0'
sequence:
type: string
example: '0'
'400':
description: The tx was malformated
'500':
description: Server internal error
/v1/transactions:
get:
summary: Get a list of transactions.
tags:
- Transactions
security: []
parameters:
- schema:
type: number
description: Number of transactions to return
minimum: 1
maximum: 100
example: 20
default: 20
required: false
name: limit
in: query
responses:
'200':
description: Returns transaction list
content:
application/json:
schema:
type: array
items:
type: object
properties:
height:
type: number
datetime:
type: string
hash:
type: string
isSuccess:
type: boolean
error:
type: string
nullable: true
gasUsed:
type: number
gasWanted:
type: number
fee:
type: number
memo:
type: string
messages:
type: array
items:
type: object
properties:
id:
type: string
type:
type: string
amount:
type: number
required:
- id
- type
- amount
required:
- height
- datetime
- hash
- isSuccess
- error
- gasUsed
- gasWanted
- fee
- memo
- messages
/v1/transactions/{hash}:
get:
summary: Get a transaction by hash.
tags:
- Transactions
security: []
parameters:
- schema:
type: string
minLength: 1
description: Transaction hash
example: A19F1950D97E576F0D7B591D71A8D0366AA8BA0A7F3DA76F44769188644BE9EB
required: true
name: hash
in: path
responses:
'200':
description: Returns predicted block date
content:
application/json:
schema:
type: object
properties:
height:
type: number
datetime:
type: string
hash:
type: string
isSuccess:
type: boolean
multisigThreshold:
type: number
signers:
type: array
items:
type: string
error:
type: string
nullable: true
gasUsed:
type: number
gasWanted:
type: number
fee:
type: number
memo:
type: string
messages:
type: array
items:
type: object
properties:
id:
type: string
type:
type: string
data:
type: object
additionalProperties:
type: string
relatedDeploymentId:
type: string
nullable: true
required:
- id
- type
- data
required:
- height
- datetime
- hash
- isSuccess
- signers
- error
- gasUsed
- gasWanted
- fee
- memo
- messages
'404':
description: Transaction not found
/v1/addresses/{address}/transactions/{skip}/{limit}:
get:
summary: Get a list of transactions for a given address.
tags:
- Transactions
security: []
parameters:
- schema:
type: string
description: Wallet Address
example: akash13265twfqejnma6cc93rw5dxk4cldyz2zyy8cdm
required: true
name: address
in: path
- schema:
type: number
nullable: true
minimum: 0
description: Transactions to skip
example: 10
required: false
name: skip
in: path
- schema:
type: number
minimum: 1
maximum: 100
description: Transactions to return
example: 10
required: true
name: limit
in: path
responses:
'200':
description: Returns transaction list
content:
application/json:
schema:
type: object
properties:
count:
type: number
results:
type: array
items:
type: object
properties:
height:
type: number
datetime:
type: string
hash:
type: string
isSuccess:
type: boolean
error:
type: string
nullable: true
gasUsed:
type: number
gasWanted:
type: number
fee:
type: number
memo:
type: string
nullable: true
isSigner:
type: boolean
messages:
type: array
items:
type: object
properties:
id:
type: string
type:
type: string
amount:
type: number
isReceiver:
type: boolean
required:
- id
- type
- amount
- isReceiver
required:
- height
- datetime
- hash
- isSuccess
- error
- gasUsed
- gasWanted
- fee
- memo
- isSigner
- messages
required:
- count
- results
'400':
description: Invalid address or parameters
securityDefinitions:
kms:
type: basic