api

Title	Description
REST APIs for Budget Module	A high-level overview of gRPC-gateway REST routes for the budget module.

REST APIs for Budget Module

A high-level overview of gRPC-gateway REST routes for the budget module.

Swagger Documentation

• Swagger Docs v1.0.0

gRPC-gateway REST Routes

To test out the budget module API REST routes, you must first set up a local node to query from. See the Localnet tutorial for steps to build the budgetd binary and bootstrap a local network on your local machine.

• Params
• Budgets
• Addresses

Params

Query the values set as budget parameters:

http://localhost:1317/cosmos/budget/v1beta1/params

{
  "params": {
    "epoch_blocks": 1,
    "budgets": [
      {
        "name": "gravity-dex-farming-20213Q-20221Q",
        "rate": "0.300000000000000000",
        "source_address": "cosmos17xpfvakm2amg962yls6f84z3kell8c5lserqta",
        "destination_address": "cosmos1228ryjucdpdv3t87rxle0ew76a56ulvnfst0hq0sscd3nafgjpqqkcxcky",
        "start_time": "2021-10-01T00:00:00Z",
        "end_time": "2022-04-01T00:00:00Z"
      }
    ]
  }
}

Budgets

Query all the budget plans exist in the network:

http://localhost:1317/cosmos/budget/v1beta1/budgets

{
  "budgets": [
    {
      "budget": {
        "name": "gravity-dex-farming-20213Q-20221Q",
        "rate": "0.300000000000000000",
        "source_address": "cosmos17xpfvakm2amg962yls6f84z3kell8c5lserqta",
        "destination_address": "cosmos1228ryjucdpdv3t87rxle0ew76a56ulvnfst0hq0sscd3nafgjpqqkcxcky",
        "start_time": "2021-10-01T00:00:00Z",
        "end_time": "2022-04-01T00:00:00Z"
      },
      "total_collected_coins": [
        {
          "denom": "stake",
          "amount": "66785"
        }
      ]
    }
  ]
}

Addresses

Query the address of fee_collector with address type 1(AddressType20Bytes):

http://localhost:1317/cosmos/budget/v1beta1/addresses/fee_collector?type=1

{
  "address": "cosmos17xpfvakm2amg962yls6f84z3kell8c5lserqta"
}

Query the address of GravityDEXFarmingBudget on farming module with default address type 0(AddressType32Bytes):

http://localhost:1317/cosmos/budget/v1beta1/addresses/GravityDEXFarmingBudget?module_name=farming

{
  "address": "cosmos1228ryjucdpdv3t87rxle0ew76a56ulvnfst0hq0sscd3nafgjpqqkcxcky"
}