v1.0.0

OAS 3.0.3

Qubic Live API

GitHub

Bridge service for Qubic network operations.

Server

https://rpc.qubic.org/live/v1

Client Libraries

Shell Curl

Accounts

Check account balances and transfer history.

Accounts Operations

get/balances/{id}

Get Balance

Gets the balance of the specified identity.

Path Parameters

id
Type: string
required

Responses

200
Type: object
GetBalanceResponse

balance
Type: Balance

Balance

get/balances/{id}

curl 'https://rpc.qubic.org/live/v1/balances/{id}'

Show Schema

{
  "balance": {
    "id": "string",
    "balance": "string",
    "validForTick": 1,
    "latestIncomingTransferTick": 1,
    "latestOutgoingTransferTick": 1,
    "incomingAmount": "string",
    "outgoingAmount": "string",
    "numberOfIncomingTransfers": 1,
    "numberOfOutgoingTransfers": 1
  }
}

Assets

Query and manage assets including issuances, ownerships, and possessions.

Assets Operations

get/assets/issuances
get/assets/issuances/{index}
get/assets/ownerships
get/assets/ownerships/{index}
get/assets/possessions
get/assets/possessions/{index}
get/assets/{identity}/issued
get/assets/{identity}/owned
get/assets/{identity}/possessed

Search Asset Issuances

Returns a list of issued assets filtered by issuer identity and asset name.

Query Parameters

issuerIdentity
Type: string
assetName
Type: string

Responses

200
Type: object
AssetIssuances

assets
Type: array AssetIssuance[]

AssetIssuance

get/assets/issuances

curl https://rpc.qubic.org/live/v1/assets/issuances

Show Schema

{
  "assets": [
    {
      "data": {
        "issuerIdentity": "string",
        "type": 1,
        "name": "string",
        "numberOfDecimalPlaces": 1,
        "unitOfMeasurement": [
          1
        ]
      },
      "tick": 1,
      "universeIndex": 1
    }
  ]
}

Get Asset Issuance By Index

Returns an asset issuance by universe index.

Path Parameters

index
Type: integerFormat: uint32
required

Responses

200
Type: object
AssetIssuance

data
Type: AssetIssuanceData

AssetIssuanceData

tick
Type: integerFormat: uint32
universeIndex
Type: integerFormat: uint32

get/assets/issuances/{index}

curl https://rpc.qubic.org/live/v1/assets/issuances/1

Show Schema

{
  "data": {
    "issuerIdentity": "string",
    "type": 1,
    "name": "string",
    "numberOfDecimalPlaces": 1,
    "unitOfMeasurement": [
      1
    ]
  },
  "tick": 1,
  "universeIndex": 1
}

Search Asset Ownerships

Returns a list of asset ownerships filtered by issuer, asset name, owner and managing contract.

Query Parameters

issuerIdentity
Type: string

Identity of the issuer. Defaults to the zero address (smart contract shares).
assetName
Type: string

Name of the asset (required).
ownerIdentity
Type: string

Identity of the owner of the asset (optional).
ownershipManagingContract
Type: integerFormat: uint32

Index of the contract that manages the ownership (optional).

Responses

200
Type: object
AssetOwnerships

assets
Type: array AssetOwnership[]

AssetOwnership

get/assets/ownerships

curl https://rpc.qubic.org/live/v1/assets/ownerships

Show Schema

{
  "assets": [
    {
      "data": {
        "ownerIdentity": "string",
        "type": 1,
        "managingContractIndex": 1,
        "issuanceIndex": 1,
        "numberOfUnits": "string"
      },
      "tick": 1,
      "universeIndex": 1
    }
  ]
}

Get Asset Ownership By Index

Returns an asset ownership by universe index.

Path Parameters

index
Type: integerFormat: uint32
required

Responses

200
Type: object
AssetOwnership

data
Type: AssetOwnershipData

AssetOwnershipData

tick
Type: integerFormat: uint32
universeIndex
Type: integerFormat: uint32

get/assets/ownerships/{index}

curl https://rpc.qubic.org/live/v1/assets/ownerships/1

Show Schema

{
  "data": {
    "ownerIdentity": "string",
    "type": 1,
    "managingContractIndex": 1,
    "issuanceIndex": 1,
    "numberOfUnits": "string"
  },
  "tick": 1,
  "universeIndex": 1
}

Search Asset Possessions

Returns a list of asset possessions filtered by issuer, asset name, owner, possessor and managing contracts.

Query Parameters

issuerIdentity
Type: string

Identity of the issuer (required). Defaults to the zero address (smart contract shares).
assetName
Type: string

Name of the asset (required).
ownerIdentity
Type: string

Identity of the owner of the asset (optional).
possessorIdentity
Type: string

Identity of the possessor of the asset (optional).
ownershipManagingContract
Type: integerFormat: uint32

Index of the contract that manages the ownership (optional).
possessionManagingContract
Type: integerFormat: uint32

Index of the contract that manages the possession (optional).

Responses

200
Type: object
AssetPossessions

assets
Type: array AssetPossession[]

AssetPossession

get/assets/possessions

curl https://rpc.qubic.org/live/v1/assets/possessions

Show Schema

{
  "assets": [
    {
      "data": {
        "possessorIdentity": "string",
        "type": 1,
        "managingContractIndex": 1,
        "ownershipIndex": 1,
        "numberOfUnits": "string"
      },
      "tick": 1,
      "universeIndex": 1
    }
  ]
}

Get Asset Possession By Index

Returns an asset possession by universe index.

Path Parameters

index
Type: integerFormat: uint32
required

Responses

200
Type: object
AssetPossession

data
Type: AssetPossessionData

AssetPossessionData

tick
Type: integerFormat: uint32
universeIndex
Type: integerFormat: uint32

get/assets/possessions/{index}

curl https://rpc.qubic.org/live/v1/assets/possessions/1

Show Schema

{
  "data": {
    "possessorIdentity": "string",
    "type": 1,
    "managingContractIndex": 1,
    "ownershipIndex": 1,
    "numberOfUnits": "string"
  },
  "tick": 1,
  "universeIndex": 1
}

List Issued Assets

Gets assets issued by the specified identity.

Path Parameters

identity
Type: string
required

Responses

200
Type: object
IssuedAssetsResponse

issuedAssets
Type: array IssuedAsset[]

IssuedAsset

get/assets/{identity}/issued

curl 'https://rpc.qubic.org/live/v1/assets/{identity}/issued'

Show Schema

{
  "issuedAssets": [
    {
      "data": {
        "issuerIdentity": "string",
        "type": 1,
        "name": "string",
        "numberOfDecimalPlaces": 1,
        "unitOfMeasurement": [
          1
        ]
      },
      "info": {
        "tick": 1,
        "universeIndex": 1
      }
    }
  ]
}

List Owned Assets

Gets assets that are owned by the specified identity.

Path Parameters

identity
Type: string
required

Responses

200
Type: object
OwnedAssetsResponse

ownedAssets
Type: array OwnedAsset[]

OwnedAsset

get/assets/{identity}/owned

curl 'https://rpc.qubic.org/live/v1/assets/{identity}/owned'

Show Schema

{
  "ownedAssets": [
    {
      "data": {
        "ownerIdentity": "string",
        "type": 1,
        "padding": 1,
        "managingContractIndex": 1,
        "issuanceIndex": 1,
        "numberOfUnits": "string",
        "issuedAsset": {
          "issuerIdentity": "string",
          "type": 1,
          "name": "string",
          "numberOfDecimalPlaces": 1,
          "unitOfMeasurement": [
            1
          ]
        }
      },
      "info": {
        "tick": 1,
        "universeIndex": 1
      }
    }
  ]
}

List Possessed Assets

Gets assets that are possessed by the specified identity.

Path Parameters

identity
Type: string
required

Responses

200
Type: object
PossessedAssetsResponse

possessedAssets
Type: array PossessedAsset[]

PossessedAsset

get/assets/{identity}/possessed

curl 'https://rpc.qubic.org/live/v1/assets/{identity}/possessed'

Show Schema

{
  "possessedAssets": [
    {
      "data": {
        "possessorIdentity": "string",
        "type": 1,
        "padding": 1,
        "managingContractIndex": 1,
        "issuanceIndex": 1,
        "numberOfUnits": "string",
        "ownedAsset": {
          "ownerIdentity": "string",
          "type": 1,
          "padding": 1,
          "managingContractIndex": 1,
          "issuanceIndex": 1,
          "numberOfUnits": "string",
          "issuedAsset": {
            "issuerIdentity": "string",
            "type": 1,
            "name": "string",
            "numberOfDecimalPlaces": 1,
            "unitOfMeasurement": [
              1
            ]
          }
        }
      },
      "info": {
        "tick": 1,
        "universeIndex": 1
      }
    }
  ]
}

Network

Network status and tick information.

Network Operations

get/block-height
get/tick-info

deprecated

Get Block Height

Deprecated: use /tick-info instead.

Responses

200
Type: object
GetBlockHeightResponse

blockHeight
Type: TickInfo

TickInfo

get/block-height

curl https://rpc.qubic.org/live/v1/block-height

Show Schema

{
  "blockHeight": {
    "tick": 1,
    "duration": 1,
    "epoch": 1,
    "initialTick": 1
  }
}

Get Tick Info

Gets the current tick information.

Responses

200
Type: object
GetTickInfoResponse

tickInfo
Type: TickInfo

TickInfo

get/tick-info

curl https://rpc.qubic.org/live/v1/tick-info

Show Schema

{
  "tickInfo": {
    "tick": 1,
    "duration": 1,
    "epoch": 1,
    "initialTick": 1
  }
}

Smart Contracts

Query smart contracts and view active IPOs.

Smart Contracts Operations

get/ipos/active
post/querySmartContract

Get Active IPOs

Returns a list of IPOs that are active in the current epoch.

Responses

200
Type: object
GetActiveIposResponse

ipos
Type: array Ipo[]

IPO

get/ipos/active

curl https://rpc.qubic.org/live/v1/ipos/active

Show Schema

{
  "ipos": [
    {
      "contractIndex": 1,
      "assetName": "string"
    }
  ]
}

Query Smart Contract

Queries a smart contract function.

Body

required

application/json

QuerySmartContractRequest

contractIndex
Type: integerFormat: uint32

identifies the smart contract
inputSize
Type: integerFormat: uint32

the size of the input data (request data)
inputType
Type: integerFormat: uint32

identifies the function to be queried
requestData
Type: string

base64 encoded input data

Responses

200
Type: object
QuerySmartContractResponse

responseData
Type: string

Binary data encoded as Base64. This data is returned directly from the called SC function.

post/querySmartContract

curl https://rpc.qubic.org/live/v1/querySmartContract \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "contractIndex": 1,
  "inputType": 1,
  "inputSize": 1,
  "requestData": ""
}'

Show Schema

{
  "responseData": "string"
}

Transactions

Broadcast transactions to the network.

Transactions Operations

post/broadcast-transaction

Broadcast Transaction

Broadcasts a transaction to the network.

Body

required

application/json

BroadcastTransactionRequest

encodedTransaction
Type: string

Base64 encoded binary transaction data.

Responses

200
Type: object
BroadcastTransactionResponse

encodedTransaction
Type: string

The Base 64 encoded binary transaction from the request.

peersBroadcasted
Type: integerFormat: int32

The number of Qubic node peers this transactions has been broadcast to.

transactionId
Type: string

The id / hash of the transaction.

post/broadcast-transaction

curl https://rpc.qubic.org/live/v1/broadcast-transaction \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "encodedTransaction": ""
}'

Show Schema

{
  "peersBroadcasted": 1,
  "encodedTransaction": "string",
  "transactionId": "string"
}

Enabled	Key	Value
	Accept	application/json
	Key	Value

Enabled	Key	Value
	issuerIdentity	Value
	assetName	Value
	Key	Value

Qubic Live API

Accounts

Get Balance

Assets

Search Asset Issuances

Get Asset Issuance By Index

Search Asset Ownerships

Get Asset Ownership By Index

Search Asset Possessions

Get Asset Possession By Index

List Issued Assets

List Owned Assets

List Possessed Assets

Network

Get Block Height

Get Tick Info

Smart Contracts

Get Active IPOs

Query Smart Contract

Transactions

Broadcast Transaction

Authentication

Variables

Cookies

Headers

Query Parameters

Request Body

Code Snippet (Collapsed)