Visit Site

API Definition

Definition of API Endpoints

Account

post
Body
heightintegerOptional
addressstringRequired
Responses
200
Successful Response
application/json
post
POST /v1/lb/YourPortalIdHere/v1/query/account HTTP/1.1
Host: mainnet.gateway.pokt.network
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "height": 1,
  "address": "text"
}
200

Successful Response

{
  "address": "text",
  "coins": [
    {
      "amount": "text",
      "denom": "upokt"
    }
  ]
}

Accounts

post
Body
heightintegerOptional
pageintegerOptional
per_pageinteger · max: 10000Optional

Number of transactions per page. Max of 10000

Default: 100
Responses
200
Successful Response
application/json
post
POST /v1/lb/YourPortalIdHere/v1/query/accounts HTTP/1.1
Host: mainnet.gateway.pokt.network
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "height": 1,
  "page": 1,
  "per_page": 100
}
200

Successful Response

{
  "result": [
    {
      "address": "text",
      "coins": [
        {
          "amount": "text",
          "denom": "upokt"
        }
      ]
    }
  ],
  "page": 1,
  "total_pages": 1
}

Balance

post
Body
heightintegerOptional
addressstringRequired
Responses
200
Successful Response
application/json
post
POST /v1/lb/YourPortalIdHere/v1/query/balance HTTP/1.1
Host: mainnet.gateway.pokt.network
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "height": 1,
  "address": "text"
}
200

Successful Response

{
  "balance": 1
}

Account Txs

post
Body
addressstringRequired
pageintegerOptional
per_pageinteger · max: 10000Optional

Number of transactions per page. Max of 10000

Default: 100
receivedbooleanOptional
provebooleanOptional
orderstring · enumOptional

The sort order, either 'asc' or 'desc'

Default: descPossible values:
Responses
200
Successful Response
application/json
post
POST /v1/lb/YourPortalIdHere/v1/query/accounttxs HTTP/1.1
Host: mainnet.gateway.pokt.network
Content-Type: application/json
Accept: */*
Content-Length: 86

{
  "address": "text",
  "page": 1,
  "per_page": 100,
  "received": true,
  "prove": true,
  "order": "desc"
}
200

Successful Response

{
  "txs": [
    {
      "hash": "text",
      "height": 1,
      "index": 1,
      "tx_result": {
        "code": 1,
        "data": "text",
        "log": "text",
        "info": "text",
        "events": [
          "text"
        ],
        "codespace": "text",
        "signer": "text",
        "recipient": "text",
        "message_type": "text"
      },
      "tx": "text",
      "proof": {
        "root_hash": "text",
        "data": "text",
        "proof": {
          "total": 1,
          "index": 1,
          "leaf_hash": "text",
          "aunts": [
            "text"
          ]
        }
      },
      "stdTx": {
        "entropy": 1,
        "fee": [
          {
            "amount": "text",
            "denom": "upokt"
          }
        ],
        "memo": "text",
        "msg": {
          "type": "apps/MsgAppStake",
          "value": {
            "pubkey": {
              "type": "text",
              "value": "text"
            },
            "chains": [
              "text"
            ],
            "value": 1
          }
        },
        "signature": {
          "pub_key": "text",
          "signature": "text"
        }
      }
    }
  ],
  "total_txs": "text",
  "page_total": "text",
  "total_count": "text"
}

Block

post
Body
heightintegerOptional
Responses
200
Successful Response
application/json
post
POST /v1/lb/YourPortalIdHere/v1/query/block HTTP/1.1
Host: mainnet.gateway.pokt.network
Content-Type: application/json
Accept: */*
Content-Length: 12

{
  "height": 1
}
200

Successful Response

{
  "block": {
    "header": {
      "version": {
        "block": 1,
        "app": 1
      },
      "chain_id": "text",
      "height": 1,
      "time": "text",
      "num_txs": 1,
      "total_txs": 1,
      "last_block_id": {
        "hash": "text",
        "parts": {
          "total": 1,
          "hash": "text"
        }
      },
      "last_commit_hash": "text",
      "data_hash": "text",
      "validators_hash": "text",
      "next_validators_hash": "text",
      "consensus_hash": "text",
      "app_hash": "text",
      "last_results_hash": "text",
      "evidence_hash": "text",
      "proposer_address": "text"
    },
    "data": {
      "txs": [
        "text"
      ]
    },
    "evidence": {
      "evidence": "text"
    },
    "lastCommit": {
      "block_id": {
        "hash": "text",
        "parts": {
          "total": 1,
          "hash": "text"
        }
      },
      "commit_signature": {
        "type": "text",
        "height": 1,
        "round": 1,
        "block_id": {
          "hash": "text",
          "parts": {
            "total": 1,
            "hash": "text"
          }
        },
        "timestamp": "text",
        "validator_address": "text",
        "validator_index": 1,
        "signature": "text"
      }
    }
  },
  "block_meta": {
    "block_id": {
      "hash": "text",
      "parts": {
        "total": 1,
        "hash": "text"
      }
    },
    "blockHeader": {
      "version": {
        "block": 1,
        "app": 1
      },
      "chain_id": "text",
      "height": 1,
      "time": "text",
      "num_txs": 1,
      "total_txs": 1,
      "last_block_id": {
        "hash": "text",
        "parts": {
          "total": 1,
          "hash": "text"
        }
      },
      "last_commit_hash": "text",
      "data_hash": "text",
      "validators_hash": "text",
      "next_validators_hash": "text",
      "consensus_hash": "text",
      "app_hash": "text",
      "last_results_hash": "text",
      "evidence_hash": "text",
      "proposer_address": "text"
    }
  }
}

Block Txs

post
Body
heightintegerRequired
pageintegerOptional
per_pageinteger · max: 10000Optional

Number of transactions per page. Max of 10000

Default: 100
provebooleanOptional
orderstring · enumOptional

The sort order, either 'asc' or 'desc'

Default: descPossible values:
Responses
200
Successful Response
application/json
post
POST /v1/lb/YourPortalIdHere/v1/query/blocktxs HTTP/1.1
Host: mainnet.gateway.pokt.network
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "height": 1,
  "page": 1,
  "per_page": 100,
  "prove": true,
  "order": "desc"
}
200

Successful Response

{
  "txs": [
    {
      "hash": "text",
      "height": 1,
      "index": 1,
      "tx_result": {
        "code": 1,
        "data": "text",
        "log": "text",
        "info": "text",
        "events": [
          "text"
        ],
        "codespace": "text",
        "signer": "text",
        "recipient": "text",
        "message_type": "text"
      },
      "tx": "text",
      "proof": {
        "root_hash": "text",
        "data": "text",
        "proof": {
          "total": 1,
          "index": 1,
          "leaf_hash": "text",
          "aunts": [
            "text"
          ]
        }
      },
      "stdTx": {
        "entropy": 1,
        "fee": [
          {
            "amount": "text",
            "denom": "upokt"
          }
        ],
        "memo": "text",
        "msg": {
          "type": "apps/MsgAppStake",
          "value": {
            "pubkey": {
              "type": "text",
              "value": "text"
            },
            "chains": [
              "text"
            ],
            "value": 1
          }
        },
        "signature": {
          "pub_key": "text",
          "signature": "text"
        }
      }
    }
  ],
  "total_txs": "text",
  "page_total": "text",
  "total_count": 1
}

Height

post
Responses
200
Successful Response
application/json
post
POST /v1/lb/YourPortalIdHere/v1/query/height HTTP/1.1
Host: mainnet.gateway.pokt.network
Accept: */*
200

Successful Response

{
  "height": 1
}

State

post
Body
heightintegerOptional
Responses
200
Successful Response
application/json
post
POST /v1/lb/YourPortalIdHere/v1/query/state HTTP/1.1
Host: mainnet.gateway.pokt.network
Content-Type: application/json
Accept: */*
Content-Length: 12

{
  "height": 1
}
200

Successful Response

{
  "app_hash": "text",
  "app_state": {
    "application": {
      "applications": [
        {
          "address": "text",
          "public_key": "text",
          "jailed": false,
          "status": 1,
          "chains": [
            "text"
          ],
          "staked_tokens": "text",
          "max_relays": 1,
          "unstaking_time": "text"
        }
      ],
      "exported": true,
      "params": {
        "unstaking_time": "text",
        "max_applications": 1,
        "app_stake_minimum": 1,
        "base_relays_per_pokt": 1,
        "stability_adjustment": 1,
        "participation_rate_on": true
      }
    },
    "auth": {
      "accounts": [
        {
          "type": "posmint/Account",
          "value": {
            "address": "text",
            "coins": [
              {
                "amount": "text",
                "denom": "upokt"
              }
            ]
          }
        }
      ],
      "params": {
        "fee_multipliers": {
          "fee_multiplier": 1,
          "default": 1
        },
        "max_memo_characters": "text",
        "tx_sig_limit": "text"
      },
      "supply": [
        {
          "amount": "text",
          "denom": "text"
        }
      ]
    },
    "gov": {
      "DAO_Tokens": "text",
      "params": {
        "acl": [
          {
            "acl_key": "text",
            "address": "text"
          }
        ],
        "dao_owner": "text",
        "upgrade": {
          "Height": 1,
          "Version": "text",
          "OldUpgradeHeight": 1,
          "Features": [
            "text"
          ]
        }
      }
    },
    "pocketcore": {
      "claims": [
        {
          "evidence_type": "text",
          "expiration_height": 1,
          "from_address": "text"
        }
      ],
      "params": {
        "claim_expiration": "text",
        "minimum_number_of_proofs": 1,
        "proof_waiting_period": "text",
        "replay_attack_burn_multiplier": "text",
        "session_node_count": 1,
        "supported_blockchains": [
          "text"
        ]
      }
    },
    "pos": {
      "exported": true,
      "missed_blocks": {},
      "params": {
        "dao_allocation": "text",
        "downtime_jail_duration": "text",
        "max_evidence_age": "text",
        "max_jailed_blocks": 1,
        "max_validators": 1,
        "min_signed_per_window": "text",
        "proposer_allocation": "text",
        "relays_to_tokens_multiplier": "text",
        "session_block_frequency": "text",
        "signed_blocks_window": "text",
        "slash_fraction_double_sign": "text",
        "slash_fraction_downtime": "text",
        "stake_denom": "text",
        "stake_minimum": 1,
        "unstaking_time": 1
      },
      "prevState_total_power": "text",
      "prevState_validator_powers": [
        {
          "Address": "text",
          "Power": "text"
        }
      ],
      "previous_proposer": "text",
      "signing_infos": {
        "ANY_ADDITIONAL_PROPERTY": {
          "address": "text",
          "index_offset": 1,
          "jailed_blocks_counter": 1,
          "jailed_until": "text",
          "missed_blocks_counter": 1,
          "start_height": 1
        }
      },
      "validators": [
        {
          "address": "text",
          "chains": [
            "text"
          ],
          "jailed": true,
          "output_address": "text",
          "public_key": "text",
          "service_url": "text",
          "status": 1,
          "tokens": "text",
          "unstaking_time": "text"
        }
      ]
    }
  },
  "chain_id": "text",
  "consensus_params": {
    "block": {
      "max_bytes": "text",
      "max_gas": "text",
      "time_iota_ms": "text"
    },
    "evidence": {
      "max_age": "text"
    },
    "validator": {
      "pub_key_types": [
        "text"
      ]
    }
  },
  "genesis_time": "text"
}

Supply

post
Body
heightintegerOptional
Responses
200
Successful Response
application/json
post
POST /v1/lb/YourPortalIdHere/v1/query/supply HTTP/1.1
Host: mainnet.gateway.pokt.network
Content-Type: application/json
Accept: */*
Content-Length: 12

{
  "height": 1
}
200

Successful Response

{
  "node_staked": 1,
  "app_staked": 1,
  "dao": 1,
  "total_staked": 1,
  "total_unstaked": 1,
  "total": 1
}

Supported Chains

post
Body
heightintegerOptional
Responses
200
Successful Response
application/json
post
POST /v1/lb/YourPortalIdHere/v1/query/supportedchains HTTP/1.1
Host: mainnet.gateway.pokt.network
Content-Type: application/json
Accept: */*
Content-Length: 12

{
  "height": 1
}
200

Successful Response

{
  "supported_chains": [
    "text"
  ]
}

Upgrade

post
Body
heightintegerOptional
Responses
200
Successful Response
application/json
post
POST /v1/lb/YourPortalIdHere/v1/query/upgrade HTTP/1.1
Host: mainnet.gateway.pokt.network
Content-Type: application/json
Accept: */*
Content-Length: 12

{
  "height": 1
}
200

Successful Response

{
  "Height": 1,
  "Version": "text",
  "OldUpgradeHeight": 1,
  "Features": [
    "text"
  ]
}

Param

post
Body
heightintegerOptional
keystring · enumRequiredPossible values:
Responses
200
Successful Response
application/json
Responseany of
or
or
or
or
or
or
or
post
POST /v1/lb/YourPortalIdHere/v1/query/param HTTP/1.1
Host: mainnet.gateway.pokt.network
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "height": 1,
  "key": "application/AppUnstakingTime"
}
200

Successful Response

{
  "param_key": "application/AppUnstakingTime",
  "param_value": 1
}

All Params

post
Body
heightintegerOptional
Responses
200
Successful Response
application/json
post
POST /v1/lb/YourPortalIdHere/v1/query/allParams HTTP/1.1
Host: mainnet.gateway.pokt.network
Content-Type: application/json
Accept: */*
Content-Length: 12

{
  "height": 1
}
200

Successful Response

{
  "app_params": [
    {
      "param_key": "application/AppUnstakingTime",
      "param_value": 1
    }
  ],
  "node_params": [
    {
      "param_key": "application/AppUnstakingTime",
      "param_value": 1
    }
  ],
  "pocket_params": [
    {
      "param_key": "application/AppUnstakingTime",
      "param_value": 1
    }
  ],
  "gov_params": [
    {
      "param_key": "application/AppUnstakingTime",
      "param_value": 1
    }
  ],
  "auth_params": [
    {
      "param_key": "application/AppUnstakingTime",
      "param_value": 1
    }
  ]
}

Single App

post
Body
heightintegerOptional
addressstringRequired
Responses
200
Successful Response
application/json
post
POST /v1/lb/YourPortalIdHere/v1/query/app HTTP/1.1
Host: mainnet.gateway.pokt.network
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "height": 1,
  "address": "text"
}
200

Successful Response

{
  "address": "text",
  "public_key": "text",
  "jailed": false,
  "status": 1,
  "chains": [
    "text"
  ],
  "staked_tokens": "text",
  "max_relays": 1,
  "unstaking_time": "text"
}

Apps

post
Body
heightintegerRequired
Responses
200
Successful Response
application/json
post
POST /v1/lb/YourPortalIdHere/v1/query/apps HTTP/1.1
Host: mainnet.gateway.pokt.network
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "opts": {
    "page": 1,
    "per_page": 100,
    "staking_status": 1,
    "blockchain": "text"
  },
  "height": 1
}
200

Successful Response

{
  "result": [
    {
      "address": "text",
      "public_key": "text",
      "jailed": false,
      "status": 1,
      "chains": [
        "text"
      ],
      "staked_tokens": "text",
      "max_relays": 1,
      "unstaking_time": "text"
    }
  ],
  "page": 1,
  "total_pages": 1
}

Node

post
Body
heightintegerOptional
addressstringRequired
Responses
200
Successful Response
application/json
post
POST /v1/lb/YourPortalIdHere/v1/query/node HTTP/1.1
Host: mainnet.gateway.pokt.network
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "height": 1,
  "address": "text"
}
200

Successful Response

{
  "address": "text",
  "chains": [
    "text"
  ],
  "jailed": false,
  "public_key": "text",
  "service_url": "text",
  "status": 1,
  "tokens": "text",
  "unstaking_time": "text"
}

Nodes

post
Body
heightintegerRequired
Responses
200
Successful Response
application/json
post
POST /v1/lb/YourPortalIdHere/v1/query/nodes HTTP/1.1
Host: mainnet.gateway.pokt.network
Content-Type: application/json
Accept: */*
Content-Length: 102

{
  "opts": {
    "page": 1,
    "per_page": 100,
    "staking_status": 1,
    "jailed_status": 1,
    "blockchain": "text"
  },
  "height": 1
}
200

Successful Response

{
  "result": [
    {
      "address": "text",
      "chains": [
        "text"
      ],
      "jailed": false,
      "public_key": "text",
      "service_url": "text",
      "status": 1,
      "tokens": "text",
      "unstaking_time": "text"
    }
  ],
  "page": 1,
  "total_pages": 1
}

Signing Info

post
Body
heightintegerRequired
addressstringOptional
pageintegerOptional
per_pageinteger · max: 10000Optional

Number of transactions per page. Max of 10000

Default: 100
Responses
200
Successful Response
application/json
post
POST /v1/lb/YourPortalIdHere/v1/query/signinginfo HTTP/1.1
Host: mainnet.gateway.pokt.network
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "height": 1,
  "address": "text",
  "page": 1,
  "per_page": 100
}
200

Successful Response

{
  "result": [
    {
      "address": "text",
      "index_offset": 1,
      "jailed_blocks_counter": 1,
      "jailed_until": "text",
      "missed_blocks_counter": 1,
      "start_height": 1
    }
  ],
  "page": 1,
  "total_pages": 1
}

Node Claim

post
Body
addressstringRequired
blockchainstringRequired
app_pubkeystringRequired
session_block_heightintegerRequired
heightintegerRequired
receipt_typestring · enumRequiredPossible values:
Responses
200
Successful Response
application/json
post
POST /v1/lb/YourPortalIdHere/v1/query/nodeclaim HTTP/1.1
Host: mainnet.gateway.pokt.network
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "address": "text",
  "blockchain": "text",
  "app_pubkey": "text",
  "session_block_height": 1,
  "height": 1,
  "receipt_type": "challenge"
}
200

Successful Response

{
  "type": "text",
  "value": {
    "header": {
      "app_public_key": "text",
      "chain": "text",
      "session_height": 1
    },
    "merkle_root": {
      "merkleHash": "text",
      "range": {
        "lower": "text",
        "upper": "text"
      }
    },
    "total_proofs": 1,
    "from_address": "text",
    "evidence_type": 1,
    "expiration_height": 1
  }
}

Node Claims

post
Body
heightintegerRequired
addressstringOptional
pageintegerOptional
per_pageinteger · max: 10000Optional

Number of transactions per page. Max of 10000

Default: 100
Responses
200
Successful Response
application/json
post
POST /v1/lb/YourPortalIdHere/v1/query/nodeclaims HTTP/1.1
Host: mainnet.gateway.pokt.network
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "height": 1,
  "address": "text",
  "page": 1,
  "per_page": 100
}
200

Successful Response

{
  "result": [
    {
      "header": {
        "app_public_key": "text",
        "chain": "text",
        "session_height": 1
      },
      "merkle_root": {
        "merkleHash": "text",
        "range": {
          "lower": "text",
          "upper": "text"
        }
      },
      "total_proofs": 1,
      "from_address": "text",
      "evidence_type": 1,
      "expiration_height": 1
    }
  ],
  "page": 1,
  "total_pages": 1
}

Tx

post
Body
hashstringRequired
provebooleanOptional
Responses
200
Successful Response
application/json
post
POST /v1/lb/YourPortalIdHere/v1/query/tx HTTP/1.1
Host: mainnet.gateway.pokt.network
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "hash": "text",
  "prove": true
}
200

Successful Response

{
  "hash": "text",
  "height": 1,
  "index": 1,
  "tx_result": {
    "code": 1,
    "data": "text",
    "log": "text",
    "info": "text",
    "events": [
      "text"
    ],
    "codespace": "text",
    "signer": "text",
    "recipient": "text",
    "message_type": "text"
  },
  "tx": "text",
  "proof": {
    "root_hash": "text",
    "data": "text",
    "proof": {
      "total": 1,
      "index": 1,
      "leaf_hash": "text",
      "aunts": [
        "text"
      ]
    }
  },
  "stdTx": {
    "entropy": 1,
    "fee": [
      {
        "amount": "text",
        "denom": "upokt"
      }
    ],
    "memo": "text",
    "msg": {
      "type": "apps/MsgAppStake",
      "value": {
        "pubkey": {
          "type": "text",
          "value": "text"
        },
        "chains": [
          "text"
        ],
        "value": 1
      }
    },
    "signature": {
      "pub_key": "text",
      "signature": "text"
    }
  }
}

Unconfirmedtx

post
Body
hashstringRequired
Responses
200
Successful Response
application/json
post
POST /v1/lb/YourPortalIdHere/v1/query/unsupportedtx HTTP/1.1
Host: mainnet.gateway.pokt.network
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "hash": "text"
}
200

Successful Response

{
  "hash": "text",
  "message_type": "text",
  "stdTx": {
    "entropy": 1,
    "fee": [
      {
        "amount": "text",
        "denom": "upokt"
      }
    ],
    "memo": "text",
    "msg": {
      "type": "apps/MsgAppStake",
      "value": {
        "pubkey": {
          "type": "text",
          "value": "text"
        },
        "chains": [
          "text"
        ],
        "value": 1
      }
    },
    "signature": {
      "pub_key": "text",
      "signature": "text"
    }
  }
}

Unconfirmedtxs

post
Body
pageintegerRequired
per_pageinteger · max: 10000Optional

Number of transactions per page. Max of 10000

Default: 100
Responses
200
Successful Response
application/json
post
POST /v1/lb/YourPortalIdHere/v1/query/unsupportedtxs HTTP/1.1
Host: mainnet.gateway.pokt.network
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "page": 1,
  "per_page": 100
}
200

Successful Response

{
  "transaction": {
    "hash": "text",
    "message_type": "text",
    "stdTx": {
      "entropy": 1,
      "fee": [
        {
          "amount": "text",
          "denom": "upokt"
        }
      ],
      "memo": "text",
      "msg": {
        "type": "apps/MsgAppStake",
        "value": {
          "pubkey": {
            "type": "text",
            "value": "text"
          },
          "chains": [
            "text"
          ],
          "value": 1
        }
      },
      "signature": {
        "pub_key": "text",
        "signature": "text"
      }
    }
  }
}

Version

get
Responses
200
Successful Response
application/json
Responseany
get
GET /v1/lb/YourPortalIdHere/v1 HTTP/1.1
Host: mainnet.gateway.pokt.network
Accept: */*
200

Successful Response

No content
PreviousSupported Chains

Last updated