Swagger url for algod and indexer

humblefool · April 10, 2022, 2:36pm

algod swagger.json doesn’t have ‘/v2’ API.
EX: https://testnet-api.algonode.cloud/swagger.json

Am I looking at the wrong swagger JSON or is it not properly updated?
and how can I fetch swagger JSON for indexer API’s?

scholtz · April 10, 2022, 6:15pm

i searched quite recently for indexer swagger, and i think this is what you want:

github.com

algorand/indexer/blob/develop/api/indexer.oas3.yml

{
  "components": {
    "parameters": {
      "account-id": {
        "description": "account string",
        "in": "path",
        "name": "account-id",
        "required": true,
        "schema": {
          "type": "string"
        }
      },
      "address": {
        "description": "Only include transactions with this address in one of the transaction fields.",
        "in": "query",
        "name": "address",
        "schema": {
          "type": "string",
          "x-algorand-format": "Address"
        },

This file has been truncated. show original

github.com

algorand/indexer/blob/develop/api/indexer.oas2.json

{
  "schemes": [
    "https"
  ],
  "swagger": "2.0",
  "info": {
    "description": "Algorand ledger analytics API.",
    "title": "Indexer",
    "contact": {
      "name": "Algorand",
      "url": "https://www.algorand.com/get-in-touch/contact"
    },
    "version": "2.0"
  },
  "host": "example.com",
  "produces": [
    "application/json"
  ],
  "paths": {
    "/health": {

This file has been truncated. show original

Dont know why there is no official swagger gettable by the api as it is in the algod, but i think this should be quite enough…

humblefool · April 11, 2022, 6:17am

It worked. Thanks @scholtz

humblefool · July 24, 2022, 8:29am

github.com

algorand/go-algorand/blob/master/daemon/algod/api/algod.oas2.json

{
  "consumes": [
    "application/json"
  ],
  "produces": [
    "application/json"
  ],
  "schemes": [
    "http",
    "https"
  ],
  "swagger": "2.0",
  "info": {
    "description": "API endpoint for algod operations.",
    "title": "Algod REST API.",
    "contact": {
      "name": "algorand",
      "url": "https://www.algorand.com/get-in-touch/contact",
      "email": "contact@algorand.com"
    },

This file has been truncated. show original

Topic		Replies	Views
Testnet Algod API TestNet	12	1065	August 5, 2020
V1 APIs Retirement General	0	419	August 22, 2022
Pythhon SDK Indexer; Cannot work with AlgoExplorer AlgoSDK	2	455	January 25, 2022
Indexer API endpoint General	8	333	September 6, 2021
Algorand-indexer failing to fetch from algod TestNet testnet	2	538	March 30, 2022

Swagger url for algod and indexer

Related Topics