swagger.json

{
  "info": {
    "title": "rsk-explorer-api",
    "version": "1.2.2",
    "description": "explorer API Documentation"
  },
  "swagger": "2.0",
  "paths": {
    "/api?module=addresses&action=getAddress": {
      "get": {
        "description": "get address data",
        "tags": [
          "addresses"
        ],
        "parameters": [
          {
            "name": "module",
            "in": "query",
            "required": true,
            "enum": [
              "addresses"
            ]
          },
          {
            "name": "action",
            "in": "query",
            "required": true,
            "enum": [
              "getAddress"
            ]
          },
          {
            "$ref": "#/parameters/address"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/Response"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=addresses&action=getAddresses": {
      "get": {
        "description": "get list of addresses",
        "tags": [
          "addresses"
        ],
        "parameters": [
          {
            "name": "module",
            "in": "query",
            "required": true,
            "enum": [
              "addresses"
            ]
          },
          {
            "name": "action",
            "in": "query",
            "required": true,
            "enum": [
              "getAddresses"
            ]
          },
          {
            "$ref": "#/parameters/limit"
          },
          {
            "$ref": "#/parameters/next"
          },
          {
            "$ref": "#/parameters/prev"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/ResponseList"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=addresses&action=getMiners": {
      "get": {
        "description": "get list of miners",
        "tags": [
          "addresses"
        ],
        "parameters": [
          {
            "name": "module",
            "in": "query",
            "required": true,
            "enum": [
              "addresses"
            ]
          },
          {
            "name": "action",
            "in": "query",
            "required": true,
            "enum": [
              "getMiners"
            ]
          },
          {
            "name": "fromBlock",
            "in": "query",
            "required": false
          },
          {
            "$ref": "#/parameters/limit"
          },
          {
            "$ref": "#/parameters/next"
          },
          {
            "$ref": "#/parameters/prev"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/ResponseList"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=addresses&action=getTokens": {
      "get": {
        "description": "get list of tokens",
        "tags": [
          "addresses"
        ],
        "parameters": [
          {
            "name": "module",
            "in": "query",
            "required": true,
            "enum": [
              "addresses"
            ]
          },
          {
            "name": "action",
            "in": "query",
            "required": true,
            "enum": [
              "getTokens"
            ]
          },
          {
            "$ref": "#/parameters/limit"
          },
          {
            "$ref": "#/parameters/next"
          },
          {
            "$ref": "#/parameters/prev"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/ResponseList"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=addresses&action=getCirculatingSupply": {
      "get": {
        "description": "get list of tokens",
        "tags": [
          "addresses"
        ],
        "parameters": [
          {
            "name": "module",
            "in": "query",
            "required": true,
            "enum": [
              "addresses"
            ]
          },
          {
            "name": "action",
            "in": "query",
            "required": true,
            "enum": [
              "getCirculatingSupply"
            ]
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/Response"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=addresses&action=getCode": {
      "get": {
        "description": "get contract code",
        "tags": [
          "addresses"
        ],
        "parameters": [
          {
            "name": "module",
            "in": "query",
            "required": true,
            "enum": [
              "addresses"
            ]
          },
          {
            "name": "action",
            "in": "query",
            "required": true,
            "enum": [
              "getCode"
            ]
          },
          {
            "$ref": "#/parameters/address"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/Response"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=addresses&action=findAddresses": {
      "get": {
        "description": "find addresses by name",
        "tags": [
          "addresses"
        ],
        "parameters": [
          {
            "name": "module",
            "in": "query",
            "required": true,
            "enum": [
              "addresses"
            ]
          },
          {
            "name": "action",
            "in": "query",
            "required": true
          },
          {
            "name": "name",
            "required": true
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/Response"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=balances&action=getBalance": {
      "get": {
        "description": "get address balance at blockNumber (if exists)",
        "tags": [
          "balances"
        ],
        "parameters": [
          {
            "name": "module",
            "in": "query",
            "required": true,
            "enum": [
              "balances"
            ]
          },
          {
            "name": "action",
            "in": "query",
            "required": true,
            "enum": [
              "getBalance"
            ]
          },
          {
            "$ref": "#/parameters/address"
          },
          {
            "name": "block",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string",
              "description": "block hash or block number",
              "example": 30000
            }
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/Response"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=balances&action=getBalances": {
      "get": {
        "description": "get address balances",
        "tags": [
          "balances"
        ],
        "parameters": [
          {
            "name": "module",
            "in": "query",
            "required": true,
            "enum": [
              "balances"
            ]
          },
          {
            "name": "action",
            "in": "query",
            "required": true,
            "enum": [
              "getBalances"
            ]
          },
          {
            "$ref": "#/parameters/address"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/Response"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=balances&action=getStatus": {
      "get": {
        "description": "get status of balances",
        "tags": [
          "balances"
        ],
        "parameters": [
          {
            "name": "module",
            "in": "query",
            "required": true,
            "enum": [
              "balances"
            ]
          },
          {
            "name": "action",
            "in": "query",
            "required": true,
            "enum": [
              "getStatus"
            ]
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/Response"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=blocks&action=getBlock": {
      "get": {
        "description": "get block data",
        "tags": [
          "blocks"
        ],
        "parameters": [
          {
            "name": "module",
            "in": "query",
            "required": true,
            "enum": [
              "blocks"
            ]
          },
          {
            "name": "action",
            "in": "query",
            "required": true,
            "enum": [
              "getBlock"
            ]
          },
          {
            "name": "hashOrNumber",
            "in": "query",
            "schema": {
              "type": "string",
              "example": 200
            }
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/Response"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=blocks&action=getBlocks": {
      "get": {
        "description": "get list of blocks",
        "tags": [
          "blocks"
        ],
        "parameters": [
          {
            "name": "module",
            "in": "query",
            "required": true,
            "enum": [
              "blocks"
            ]
          },
          {
            "name": "action",
            "in": "query",
            "required": true,
            "enum": [
              "getBlocks"
            ]
          },
          {
            "name": "miner",
            "in": "query",
            "required": false
          },
          {
            "$ref": "#/parameters/limit"
          },
          {
            "$ref": "#/parameters/next"
          },
          {
            "$ref": "#/parameters/prev"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/ResponseList"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=contractVerifier&action=getVerifiedContracts": {
      "get": {
        "description": "Gets a list of verified contracts addresses",
        "tags": [
          "contract verifier"
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/Response"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=contractVerifier&action=verify": {
      "get": {
        "description": "Verify contract source",
        "tags": [
          "contract verifier"
        ],
        "parameters": [
          {
            "name": "request",
            "in": "query",
            "required": true
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/Response"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=contractVerifier&action=getSolcVersions": {
      "get": {
        "description": "Gets solidity compiler versions",
        "tags": [
          "contract verifier"
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/Response"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=contractVerifier&action=getEvmVersions": {
      "get": {
        "description": "Gets evm versions",
        "tags": [
          "contract verifier"
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/Response"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=contractVerifier&action=getVerificationResult": {
      "get": {
        "description": "Gets the result of source code verification",
        "tags": [
          "contract verifier"
        ],
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "required": true
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/Response"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=contractVerifier&action=isVerified": {
      "get": {
        "description": "Checks if a contract was verified",
        "tags": [
          "contract verifier"
        ],
        "parameters": [
          {
            "name": "address",
            "in": "query",
            "required": true
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/Response"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=events&action=getEvent": {
      "get": {
        "description": "get event data",
        "tags": [
          "events"
        ],
        "parameters": [
          {
            "name": "module",
            "in": "query",
            "required": true,
            "enum": [
              "events"
            ]
          },
          {
            "name": "action",
            "in": "query",
            "required": true,
            "enum": [
              "getEvent"
            ]
          },
          {
            "name": "eventId",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/Response"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=events&action=getEventsByAddress": {
      "get": {
        "description": "get events by address",
        "tags": [
          "events"
        ],
        "parameters": [
          {
            "name": "module",
            "in": "query",
            "required": true,
            "enum": [
              "events"
            ]
          },
          {
            "name": "action",
            "in": "query",
            "required": true,
            "enum": [
              "getEventsByAddress"
            ]
          },
          {
            "$ref": "#/parameters/address"
          },
          {
            "name": "contract",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "example": "0x0000000000000000000000000000000001000008"
            }
          },
          {
            "name": "signatures",
            "in": "query",
            "required": false,
            "description": "filter by event's signatures",
            "schema": {
              "type": "array",
              "example": "e19260aff97b920c7df27010903aeb9c8d2be5d310a2c67824cf3f15396e4c16"
            }
          },
          {
            "$ref": "#/parameters/limit"
          },
          {
            "$ref": "#/parameters/next"
          },
          {
            "$ref": "#/parameters/prev"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/ResponseList"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=events&action=getAllEventsByAddress": {
      "get": {
        "description": "get events by address",
        "tags": [
          "events"
        ],
        "parameters": [
          {
            "name": "module",
            "in": "query",
            "required": true,
            "enum": [
              "events"
            ]
          },
          {
            "name": "action",
            "in": "query",
            "required": true,
            "enum": [
              "getAllEventsByAddress"
            ]
          },
          {
            "$ref": "#/parameters/address"
          },
          {
            "$ref": "#/parameters/limit"
          },
          {
            "$ref": "#/parameters/next"
          },
          {
            "$ref": "#/parameters/prev"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/ResponseList"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=extendedStats&action=getExtendedStats": {
      "get": {
        "description": "get extended stats",
        "tags": [
          "extendedStats"
        ],
        "parameters": [
          {
            "name": "module",
            "in": "query",
            "required": true,
            "enum": [
              "extendedStats"
            ]
          },
          {
            "name": "action",
            "in": "query",
            "required": true,
            "enum": [
              "getExtendedStats"
            ]
          },
          {
            "name": "blockNumber",
            "in": "query",
            "schema": {
              "type": "string",
              "example": 200
            }
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/Response"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=extendedStats&action=getHashrates": {
      "get": {
        "description": "get hashrates",
        "tags": [
          "extendedStats"
        ],
        "parameters": [
          {
            "name": "module",
            "in": "query",
            "required": true,
            "enum": [
              "extendedStats"
            ]
          },
          {
            "name": "action",
            "in": "query",
            "required": true,
            "enum": [
              "getHashrates"
            ]
          },
          {
            "name": "blockNumber",
            "in": "query",
            "schema": {
              "type": "string",
              "example": 200
            }
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/Response"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=extendedStats&action=getDifficulties": {
      "get": {
        "description": "get difficulties",
        "tags": [
          "extendedStats"
        ],
        "parameters": [
          {
            "name": "module",
            "in": "query",
            "required": true,
            "enum": [
              "extendedStats"
            ]
          },
          {
            "name": "action",
            "in": "query",
            "required": true,
            "enum": [
              "getDifficulties"
            ]
          },
          {
            "name": "blockNumber",
            "in": "query",
            "schema": {
              "type": "string",
              "example": 200
            }
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/Response"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=internalTransactions&action=getInternalTransaction": {
      "get": {
        "description": "get internal transaction",
        "tags": [
          "internal transactions"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "module",
            "in": "query",
            "required": true,
            "enum": [
              "internalTransactions"
            ]
          },
          {
            "name": "action",
            "in": "query",
            "required": true,
            "enum": [
              "getInternalTransaction"
            ]
          },
          {
            "name": "internalTxId",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/parameters/limit"
          },
          {
            "$ref": "#/parameters/next"
          },
          {
            "$ref": "#/parameters/prev"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/ResponseList"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=internalTransactions&action=getInternalTransactions": {
      "get": {
        "description": "get internal transactions",
        "tags": [
          "internal transactions"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "module",
            "in": "query",
            "required": true,
            "enum": [
              "internalTransactions"
            ]
          },
          {
            "name": "action",
            "in": "query",
            "required": true,
            "enum": [
              "getInternalTransactions"
            ]
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "type": "object"
            }
          },
          {
            "$ref": "#/parameters/limit"
          },
          {
            "$ref": "#/parameters/next"
          },
          {
            "$ref": "#/parameters/prev"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/ResponseList"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=internalTransactions&action=getInternalTransactionsByAddress": {
      "get": {
        "description": "get internal transactions by address",
        "tags": [
          "internal transactions"
        ],
        "parameters": [
          {
            "name": "module",
            "in": "query",
            "required": true,
            "enum": [
              "internalTransactions"
            ]
          },
          {
            "name": "action",
            "in": "query",
            "required": true,
            "enum": [
              "getInternalTransactionsByAddress"
            ]
          },
          {
            "$ref": "#/parameters/address"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/ResponseList"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=internalTransactions&action=getInternalTransactionsByBlock": {
      "get": {
        "description": "get internal transactions by block",
        "tags": [
          "internal transactions"
        ],
        "parameters": [
          {
            "name": "module",
            "in": "query",
            "required": true,
            "enum": [
              "internalTransactions"
            ]
          },
          {
            "name": "action",
            "in": "query",
            "required": true,
            "enum": [
              "getInternalTransactionsByBlock"
            ]
          },
          {
            "$ref": "#/parameters/hashOrNumber"
          },
          {
            "$ref": "#/parameters/limit"
          },
          {
            "$ref": "#/parameters/next"
          },
          {
            "$ref": "#/parameters/prev"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/ResponseList"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=internalTransactions&action=getInternalTransactionsByTxHash": {
      "get": {
        "description": "get internal transactions by tx hash",
        "tags": [
          "internal transactions"
        ],
        "parameters": [
          {
            "name": "module",
            "in": "query",
            "required": true,
            "enum": [
              "internalTransactions"
            ]
          },
          {
            "name": "action",
            "in": "query",
            "required": true,
            "enum": [
              "getInternalTransactionsByTxHash"
            ]
          },
          {
            "$ref": "#/parameters/transactionHash"
          },
          {
            "$ref": "#/parameters/limit"
          },
          {
            "$ref": "#/parameters/next"
          },
          {
            "$ref": "#/parameters/prev"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/ResponseList"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=stats&action=getStats": {
      "get": {
        "description": "get stats",
        "tags": [
          "stats"
        ],
        "parameters": [
          {
            "name": "module",
            "in": "query",
            "required": true,
            "enum": [
              "stats"
            ]
          },
          {
            "name": "action",
            "in": "query",
            "required": true,
            "enum": [
              "getStats"
            ]
          },
          {
            "$ref": "#/parameters/limit"
          },
          {
            "$ref": "#/parameters/next"
          },
          {
            "$ref": "#/parameters/prev"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/ResponseList"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=stats&action=getLatest": {
      "get": {
        "description": "get stats",
        "tags": [
          "stats"
        ],
        "parameters": [
          {
            "name": "module",
            "in": "query",
            "required": true,
            "enum": [
              "stats"
            ]
          },
          {
            "name": "action",
            "in": "query",
            "required": true,
            "enum": [
              "getLatest"
            ]
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/Response"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=summary&action=getSummary": {
      "get": {
        "description": "get block summary",
        "tags": [
          "summary"
        ],
        "parameters": [
          {
            "name": "module",
            "in": "query",
            "required": true,
            "enum": [
              "summary"
            ]
          },
          {
            "name": "action",
            "in": "query",
            "required": true,
            "enum": [
              "getSummary"
            ]
          },
          {
            "name": "hash",
            "description": "block hash",
            "in": "query",
            "schema": {
              "type": "string",
              "example": null
            }
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/Response"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=summary&action=getSummaries": {
      "get": {
        "description": "get list of summaries",
        "tags": [
          "summary"
        ],
        "parameters": [
          {
            "name": "module",
            "in": "query",
            "required": true,
            "enum": [
              "summary"
            ]
          },
          {
            "name": "action",
            "in": "query",
            "required": true,
            "enum": [
              "getSummaries"
            ]
          },
          {
            "$ref": "#/parameters/limit"
          },
          {
            "$ref": "#/parameters/next"
          },
          {
            "$ref": "#/parameters/prev"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/ResponseList"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=tokens&action=getTokenAccounts": {
      "get": {
        "description": "get token accounts",
        "tags": [
          "tokens"
        ],
        "parameters": [
          {
            "name": "module",
            "in": "query",
            "required": true,
            "enum": [
              "tokens"
            ]
          },
          {
            "name": "action",
            "in": "query",
            "required": true,
            "enum": [
              "getTokenAccounts"
            ]
          },
          {
            "$ref": "#/parameters/address"
          },
          {
            "$ref": "#/parameters/limit"
          },
          {
            "$ref": "#/parameters/next"
          },
          {
            "$ref": "#/parameters/prev"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/ResponseList"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=tokens&action=getTokensByAddress": {
      "get": {
        "description": "get token by address",
        "tags": [
          "tokens"
        ],
        "parameters": [
          {
            "name": "module",
            "in": "query",
            "required": true,
            "enum": [
              "tokens"
            ]
          },
          {
            "name": "action",
            "in": "query",
            "required": true,
            "enum": [
              "getTokensByAddress"
            ]
          },
          {
            "$ref": "#/parameters/address"
          },
          {
            "$ref": "#/parameters/limit"
          },
          {
            "$ref": "#/parameters/next"
          },
          {
            "$ref": "#/parameters/prev"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/ResponseList"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=tokens&action=getContractAccount": {
      "get": {
        "description": "get token account",
        "tags": [
          "tokens"
        ],
        "parameters": [
          {
            "name": "module",
            "in": "query",
            "required": true,
            "enum": [
              "tokens"
            ]
          },
          {
            "name": "action",
            "in": "query",
            "required": true,
            "enum": [
              "getContractAccount"
            ]
          },
          {
            "$ref": "#/parameters/address"
          },
          {
            "$ref": "#/parameters/contract"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/Response"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=tokens&action=getTokenAccount": {
      "get": {
        "description": "get token account and address data",
        "tags": [
          "tokens"
        ],
        "parameters": [
          {
            "name": "module",
            "in": "query",
            "required": true,
            "enum": [
              "tokens"
            ]
          },
          {
            "name": "action",
            "in": "query",
            "required": true,
            "enum": [
              "getTokenAccount"
            ]
          },
          {
            "$ref": "#/parameters/address"
          },
          {
            "$ref": "#/parameters/contract"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/Response"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=tokens&action=getTokenBalance": {
      "get": {
        "description": "get token balance",
        "tags": [
          "tokens"
        ],
        "parameters": [
          {
            "name": "module",
            "in": "query",
            "required": true,
            "enum": [
              "tokens"
            ]
          },
          {
            "name": "action",
            "in": "query",
            "required": true,
            "enum": [
              "getTokenBalance"
            ]
          },
          {
            "$ref": "#/parameters/contract"
          },
          {
            "name": "addresses",
            "in": "query",
            "type": "array",
            "required": false,
            "description": "include only this addresses in balance"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/Response"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=transactions&action=getTransactions": {
      "get": {
        "description": "get transactions",
        "tags": [
          "transactions"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "module",
            "in": "query",
            "required": true,
            "enum": [
              "transactions"
            ]
          },
          {
            "name": "action",
            "in": "query",
            "required": true,
            "enum": [
              "getTransactions"
            ]
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "type": "object",
              "example": "txType:normal"
            }
          },
          {
            "$ref": "#/parameters/limit"
          },
          {
            "$ref": "#/parameters/next"
          },
          {
            "$ref": "#/parameters/prev"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/ResponseList"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=transactions&action=getTransaction": {
      "get": {
        "description": "get transaction",
        "tags": [
          "transactions"
        ],
        "parameters": [
          {
            "name": "module",
            "in": "query",
            "required": true,
            "enum": [
              "transactions"
            ]
          },
          {
            "name": "action",
            "in": "query",
            "required": true,
            "enum": [
              "getTransaction"
            ]
          },
          {
            "$ref": "#/parameters/txHash"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/Response"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=transactions&action=getTransactionWithAddressData": {
      "get": {
        "description": "get transaction",
        "tags": [
          "transactions"
        ],
        "parameters": [
          {
            "name": "module",
            "in": "query",
            "required": true,
            "enum": [
              "transactions"
            ]
          },
          {
            "name": "action",
            "in": "query",
            "required": true,
            "enum": [
              "getTransactionWithAddressData"
            ]
          },
          {
            "name": "hash",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/Response"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=transactions&action=getTransactionsByBlock": {
      "get": {
        "description": "get transaction",
        "tags": [
          "transactions"
        ],
        "parameters": [
          {
            "name": "module",
            "in": "query",
            "required": true,
            "enum": [
              "transactions"
            ]
          },
          {
            "name": "action",
            "in": "query",
            "required": true,
            "enum": [
              "getTransactionsByBlock"
            ]
          },
          {
            "$ref": "#/parameters/hashOrNumber"
          },
          {
            "$ref": "#/parameters/limit"
          },
          {
            "$ref": "#/parameters/next"
          },
          {
            "$ref": "#/parameters/prev"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/ResponseList"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=transactions&action=getTransactionsByAddress": {
      "get": {
        "description": "get transactions by address",
        "tags": [
          "transactions"
        ],
        "parameters": [
          {
            "name": "module",
            "in": "query",
            "required": true,
            "enum": [
              "transactions"
            ]
          },
          {
            "name": "action",
            "in": "query",
            "required": true,
            "enum": [
              "getTransactionsByAddress"
            ]
          },
          {
            "$ref": "#/parameters/address"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/ResponseList"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=verificationResults&action=getResults": {
      "get": {
        "description": "Gets a list of verified contracts addresses",
        "tags": [
          "verification results"
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/Response"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    },
    "/api?module=verificationResults&action=getVerification": {
      "get": {
        "description": "Checks if a contract was verified",
        "tags": [
          "verification results"
        ],
        "parameters": [
          {
            "name": "address",
            "in": "query",
            "required": true
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/definitions/Response"
          },
          "400": {
            "$ref": "#/responses/BadRequest"
          },
          "404": {
            "$ref": "#/responses/NotFound"
          }
        }
      }
    }
  },
  "definitions": {
    "Request": {
      "type": "object",
      "properties": {
        "module": {
          "type": "string",
          "required": true
        },
        "action": {
          "type": "string",
          "required": true
        },
        "params": {
          "type": "object",
          "properties": {
            "limit": {
              "type": "integer"
            },
            "next": {
              "type": "string"
            },
            "fields": {
              "type": {
                "oneOf": [
                  "array",
                  "object"
                ]
              }
            }
          }
        }
      }
    },
    "Response": {
      "type": "object",
      "description": "Response",
      "name": "Item",
      "properties": {
        "pages": {
          "type": "object",
          "properties": {
            "sort": {
              "name": "sort",
              "type": "object"
            },
            "sortable": {
              "description": "sortable fields",
              "type": "object"
            },
            "defaultSort": {
              "type": "object"
            },
            "sortDir": {
              "type": "boolean"
            },
            "limit": {
              "type": "integer"
            },
            "next": {
              "type": "object"
            },
            "prev": {
              "type": "object"
            },
            "fields": {
              "type": "object"
            }
          }
        },
        "data": {
          "type": "array",
          "items": {
            "type": "object"
          }
        }
      }
    },
    "ResponseList": {
      "description": "ResponseList",
      "type": "object",
      "properties": {
        "pages": {
          "type": "object",
          "properties": {
            "sort": {
              "name": "sort",
              "type": "object"
            },
            "sortable": {
              "description": "sortable fields",
              "type": "object"
            },
            "defaultSort": {
              "type": "object"
            },
            "sortDir": {
              "type": "boolean"
            },
            "limit": {
              "type": "integer"
            },
            "next": {
              "type": "string"
            },
            "prev": {
              "type": "string"
            },
            "fields": {
              "type": "object"
            }
          }
        },
        "data": {
          "type": "array",
          "items": {
            "type": "object"
          }
        }
      }
    }
  },
  "responses": {
    "NotFound": {
      "description": "Not Found"
    },
    "BadRequest": {
      "description": "Bad Request"
    }
  },
  "parameters": {
    "address": {
      "name": "address",
      "in": "query",
      "required": true,
      "type": "string",
      "schema": {
        "type": "string",
        "example": "0x0000000000000000000000000000000001000008"
      }
    },
    "contract": {
      "name": "address",
      "in": "query",
      "required": true,
      "type": "string",
      "schema": {
        "type": "string",
        "example": "0x0000000000000000000000000000000001000008"
      }
    },
    "txHash": {
      "name": "hash",
      "type": "string",
      "required": true,
      "in": "query",
      "schema": {
        "type": "string",
        "example": "0x4aa0649fdc1a4b0e07b64c26e43138400c84d6a127d0242027226b7ade17a53e"
      }
    },
    "hashOrNumber": {
      "name": "hashOrNumber",
      "type": "string",
      "description": "block hash or block number",
      "in": "query",
      "required": true,
      "schema": {
        "example": 200
      }
    },
    "limit": {
      "name": "limit",
      "type": "integer",
      "in": "query"
    },
    "next": {
      "name": "next",
      "type": "string",
      "in": "query"
    },
    "prev": {
      "name": "prev",
      "type": "string",
      "in": "query"
    }
  },
  "securityDefinitions": {},
  "tags": []
}