IOTA Coin Query API
Coin and balance queries: balances, coins list, metadata, supply
OpenAPI Specification
openapi: 3.0.1
info:
description: REST API for the Wasp node
title: Wasp auth Coin Query API
version: '0'
servers:
- url: /
tags:
- name: Coin Query
description: 'Coin and balance queries: balances, coins list, metadata, supply'
paths:
/iotax_getAllBalances:
post:
operationId: iotax_getAllBalances
summary: iotax_getAllBalances
description: Return the total coin balance for all coin type, owned by the address owner.
tags:
- Coin Query
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- jsonrpc
- id
- method
properties:
jsonrpc:
type: string
enum:
- '2.0'
description: JSON-RPC protocol version
id:
oneOf:
- type: integer
- type: string
description: Request identifier
method:
type: string
enum:
- iotax_getAllBalances
description: The JSON-RPC method name
params:
type: array
description: Method parameters
items: {}
example:
jsonrpc: '2.0'
id: 1
method: iotax_getAllBalances
params: []
responses:
'200':
description: Successful JSON-RPC response
content:
application/json:
schema:
type: object
properties:
jsonrpc:
type: string
example: '2.0'
id:
oneOf:
- type: integer
- type: string
result:
type: array
items:
$ref: '#/components/schemas/Balance'
default:
description: JSON-RPC error response
content:
application/json:
schema:
type: object
properties:
jsonrpc:
type: string
id:
oneOf:
- type: integer
- type: string
error:
type: object
properties:
code:
type: integer
message:
type: string
data: {}
/iotax_getAllCoins:
post:
operationId: iotax_getAllCoins
summary: iotax_getAllCoins
description: Return all Coin objects owned by an address.
tags:
- Coin Query
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- jsonrpc
- id
- method
properties:
jsonrpc:
type: string
enum:
- '2.0'
description: JSON-RPC protocol version
id:
oneOf:
- type: integer
- type: string
description: Request identifier
method:
type: string
enum:
- iotax_getAllCoins
description: The JSON-RPC method name
params:
type: array
description: Method parameters
items: {}
example:
jsonrpc: '2.0'
id: 1
method: iotax_getAllCoins
params: []
responses:
'200':
description: Successful JSON-RPC response
content:
application/json:
schema:
type: object
properties:
jsonrpc:
type: string
example: '2.0'
id:
oneOf:
- type: integer
- type: string
result:
$ref: '#/components/schemas/Page_for_Coin_and_ObjectID'
default:
description: JSON-RPC error response
content:
application/json:
schema:
type: object
properties:
jsonrpc:
type: string
id:
oneOf:
- type: integer
- type: string
error:
type: object
properties:
code:
type: integer
message:
type: string
data: {}
/iotax_getBalance:
post:
operationId: iotax_getBalance
summary: iotax_getBalance
description: Return the total coin balance for one coin type, owned by the address owner.
tags:
- Coin Query
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- jsonrpc
- id
- method
properties:
jsonrpc:
type: string
enum:
- '2.0'
description: JSON-RPC protocol version
id:
oneOf:
- type: integer
- type: string
description: Request identifier
method:
type: string
enum:
- iotax_getBalance
description: The JSON-RPC method name
params:
type: array
description: Method parameters
items: {}
example:
jsonrpc: '2.0'
id: 1
method: iotax_getBalance
params: []
responses:
'200':
description: Successful JSON-RPC response
content:
application/json:
schema:
type: object
properties:
jsonrpc:
type: string
example: '2.0'
id:
oneOf:
- type: integer
- type: string
result:
$ref: '#/components/schemas/Balance'
default:
description: JSON-RPC error response
content:
application/json:
schema:
type: object
properties:
jsonrpc:
type: string
id:
oneOf:
- type: integer
- type: string
error:
type: object
properties:
code:
type: integer
message:
type: string
data: {}
/iotax_getCirculatingSupply:
post:
operationId: iotax_getCirculatingSupply
summary: iotax_getCirculatingSupply
description: Return the circulating supply summary.
tags:
- Coin Query
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- jsonrpc
- id
- method
properties:
jsonrpc:
type: string
enum:
- '2.0'
description: JSON-RPC protocol version
id:
oneOf:
- type: integer
- type: string
description: Request identifier
method:
type: string
enum:
- iotax_getCirculatingSupply
description: The JSON-RPC method name
params:
type: array
description: Method parameters
items: {}
example:
jsonrpc: '2.0'
id: 1
method: iotax_getCirculatingSupply
params: []
responses:
'200':
description: Successful JSON-RPC response
content:
application/json:
schema:
type: object
properties:
jsonrpc:
type: string
example: '2.0'
id:
oneOf:
- type: integer
- type: string
result:
$ref: '#/components/schemas/IotaCirculatingSupply'
default:
description: JSON-RPC error response
content:
application/json:
schema:
type: object
properties:
jsonrpc:
type: string
id:
oneOf:
- type: integer
- type: string
error:
type: object
properties:
code:
type: integer
message:
type: string
data: {}
/iotax_getCoinMetadata:
post:
operationId: iotax_getCoinMetadata
summary: iotax_getCoinMetadata
description: Return metadata (e.g., symbol, decimals) for a coin.
tags:
- Coin Query
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- jsonrpc
- id
- method
properties:
jsonrpc:
type: string
enum:
- '2.0'
description: JSON-RPC protocol version
id:
oneOf:
- type: integer
- type: string
description: Request identifier
method:
type: string
enum:
- iotax_getCoinMetadata
description: The JSON-RPC method name
params:
type: array
description: Method parameters
items: {}
example:
jsonrpc: '2.0'
id: 1
method: iotax_getCoinMetadata
params: []
responses:
'200':
description: Successful JSON-RPC response
content:
application/json:
schema:
type: object
properties:
jsonrpc:
type: string
example: '2.0'
id:
oneOf:
- type: integer
- type: string
result:
$ref: '#/components/schemas/IotaCoinMetadata'
default:
description: JSON-RPC error response
content:
application/json:
schema:
type: object
properties:
jsonrpc:
type: string
id:
oneOf:
- type: integer
- type: string
error:
type: object
properties:
code:
type: integer
message:
type: string
data: {}
/iotax_getCoins:
post:
operationId: iotax_getCoins
summary: iotax_getCoins
description: Return all Coin<`coin_type`> objects owned by an address.
tags:
- Coin Query
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- jsonrpc
- id
- method
properties:
jsonrpc:
type: string
enum:
- '2.0'
description: JSON-RPC protocol version
id:
oneOf:
- type: integer
- type: string
description: Request identifier
method:
type: string
enum:
- iotax_getCoins
description: The JSON-RPC method name
params:
type: array
description: Method parameters
items: {}
example:
jsonrpc: '2.0'
id: 1
method: iotax_getCoins
params: []
responses:
'200':
description: Successful JSON-RPC response
content:
application/json:
schema:
type: object
properties:
jsonrpc:
type: string
example: '2.0'
id:
oneOf:
- type: integer
- type: string
result:
$ref: '#/components/schemas/Page_for_Coin_and_ObjectID'
default:
description: JSON-RPC error response
content:
application/json:
schema:
type: object
properties:
jsonrpc:
type: string
id:
oneOf:
- type: integer
- type: string
error:
type: object
properties:
code:
type: integer
message:
type: string
data: {}
/iotax_getTotalSupply:
post:
operationId: iotax_getTotalSupply
summary: iotax_getTotalSupply
description: Return total supply for a coin.
tags:
- Coin Query
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- jsonrpc
- id
- method
properties:
jsonrpc:
type: string
enum:
- '2.0'
description: JSON-RPC protocol version
id:
oneOf:
- type: integer
- type: string
description: Request identifier
method:
type: string
enum:
- iotax_getTotalSupply
description: The JSON-RPC method name
params:
type: array
description: Method parameters
items: {}
example:
jsonrpc: '2.0'
id: 1
method: iotax_getTotalSupply
params: []
responses:
'200':
description: Successful JSON-RPC response
content:
application/json:
schema:
type: object
properties:
jsonrpc:
type: string
example: '2.0'
id:
oneOf:
- type: integer
- type: string
result:
$ref: '#/components/schemas/Supply'
default:
description: JSON-RPC error response
content:
application/json:
schema:
type: object
properties:
jsonrpc:
type: string
id:
oneOf:
- type: integer
- type: string
error:
type: object
properties:
code:
type: integer
message:
type: string
data: {}
components:
securitySchemes:
Authorization:
description: JWT Token
in: header
name: Authorization
type: apiKey
externalDocs:
description: Find out more about Wasp
url: https://wiki.iota.org/smart-contracts/overview
x-original-swagger-version: '2.0'