openapi.json

{
  "info": {
    "title": "Aldus API",
    "version": "1.0"
  },
  "tags": [
    {
      "name": "V1"
    },
    {
      "name": "V1.Accounts"
    },
    {
      "name": "V1.Codes"
    },
    {
      "name": "V1.Contracts"
    },
    {
      "name": "V1.Globals"
    },
    {
      "name": "V1.Modules"
    },
    {
      "name": "V1.Entities"
    },
    {
      "name": "V1.Assets"
    }
  ],
  "servers": [
    {
      "url": "https://aldus-api.alleslabs.dev"
    }
  ],
  "paths": {
    "/v1/entities": {
      "get": {
        "parameters": [],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/RawEntity"
                  }
                }
              }
            },
            "description": "Successful response"
          }
        },
        "tags": ["V1.Entities"],
        "summary": "Get entities",
        "description": "Get all entity entries"
      }
    },
    "/v1/globals/chains": {
      "get": {
        "parameters": [],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {}
              }
            },
            "description": "Successful response"
          }
        },
        "tags": ["V1.Globals"],
        "summary": "Get all chains",
        "description": "Get all chain entries"
      }
    },
    "/v1/globals/assets": {
      "get": {
        "parameters": [],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {}
              }
            },
            "description": "Successful response"
          }
        },
        "tags": ["V1.Globals"],
        "summary": "Get assets",
        "description": "Get all asset entries"
      }
    },
    "/v1/{chain}/{network}/codes": {
      "get": {
        "parameters": [
          {
            "in": "path",
            "name": "chain",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "in": "path",
            "name": "network",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Code"
                  }
                }
              }
            },
            "description": "Successful response"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPError"
                }
              }
            },
            "description": "Not found"
          }
        },
        "tags": ["V1.Codes"],
        "summary": "Get all codes",
        "description": "Get all code entries for a given chain and network."
      }
    },
    "/v1/{chain}/{network}/assets": {
      "get": {
        "parameters": [
          {
            "in": "path",
            "name": "chain",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "in": "path",
            "name": "network",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Asset"
                  }
                }
              }
            },
            "description": "Successful response"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPError"
                }
              }
            },
            "description": "Not found"
          }
        },
        "tags": ["V1.Assets"],
        "summary": "Get assets",
        "description": "Get all assets entries for a given chain and network"
      }
    },
    "/v1/{chain}/{network}/modules": {
      "get": {
        "parameters": [
          {
            "in": "path",
            "name": "chain",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "in": "path",
            "name": "network",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Module"
                  }
                }
              }
            },
            "description": "Successful response"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPError"
                }
              }
            },
            "description": "Not found"
          }
        },
        "tags": ["V1.Modules"],
        "summary": "Get all modules",
        "description": "Get all module entries for a given chain and network"
      }
    },
    "/v1/{chain}/{network}/accounts": {
      "get": {
        "parameters": [
          {
            "in": "path",
            "name": "chain",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "in": "path",
            "name": "network",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Account"
                  }
                }
              }
            },
            "description": "Successful response"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPError"
                }
              }
            },
            "description": "Not found"
          }
        },
        "tags": ["V1.Accounts"],
        "summary": "Get all accounts",
        "description": "Get all account entries for a given chain and network"
      }
    },
    "/v1/{chain}/{network}/entities": {
      "get": {
        "parameters": [
          {
            "in": "path",
            "name": "chain",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "in": "path",
            "name": "network",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Entity"
                  }
                }
              }
            },
            "description": "Successful response"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPError"
                }
              }
            },
            "description": "Not found"
          }
        },
        "tags": ["V1.Entities"],
        "summary": "Get entities with details",
        "description": "Get all entities entry and details"
      }
    },
    "/v1/{chain}/{network}/contracts": {
      "get": {
        "parameters": [
          {
            "in": "path",
            "name": "chain",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "in": "path",
            "name": "network",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Contract"
                  }
                }
              }
            },
            "description": "Successful response"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPError"
                }
              }
            },
            "description": "Not found"
          }
        },
        "tags": ["V1.Contracts"],
        "summary": "Get all contracts",
        "description": "Get all contract entries for a given chain and network"
      }
    },
    "/v1/{chain}/{network}/accounts/{address}": {
      "get": {
        "parameters": [
          {
            "in": "path",
            "name": "chain",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "in": "path",
            "name": "network",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "in": "path",
            "name": "address",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Account"
                }
              }
            },
            "description": "Successful response"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPError"
                }
              }
            },
            "description": "Not found"
          }
        },
        "tags": ["V1.Accounts"],
        "summary": "Get account by address",
        "description": "Get an account entry for a given chain and network by address"
      }
    },
    "/v1/{chain}/{network}/codes/{code_id}": {
      "get": {
        "parameters": [
          {
            "in": "path",
            "name": "chain",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "in": "path",
            "name": "network",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "in": "path",
            "name": "code_id",
            "schema": {
              "type": "integer"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Code"
                }
              }
            },
            "description": "Successful response"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPError"
                }
              }
            },
            "description": "Not found"
          }
        },
        "tags": ["V1.Codes"],
        "summary": "Get code by ID",
        "description": "Get a code entry for a given chain, network, and code ID"
      }
    },
    "/v1/{chain}/{network}/entities/{entity_slug}": {
      "get": {
        "parameters": [
          {
            "in": "path",
            "name": "chain",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "in": "path",
            "name": "network",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "in": "path",
            "name": "entity_slug",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Entity"
                }
              }
            },
            "description": "Successful response"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPError"
                }
              }
            },
            "description": "Not found"
          }
        },
        "tags": ["V1.Entities"],
        "summary": "Get entity details by slug",
        "description": "Get entity entry and details by slug"
      }
    },
    "/v1/{chain}/{network}/contracts/{contract_address}": {
      "get": {
        "parameters": [
          {
            "in": "path",
            "name": "chain",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "in": "path",
            "name": "network",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "in": "path",
            "name": "contract_address",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Contract"
                }
              }
            },
            "description": "Successful response"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPError"
                }
              }
            },
            "description": "Not found"
          }
        },
        "tags": ["V1.Contracts"],
        "summary": "Get contract by address",
        "description": "Get a contract entry for a given chain and network by address"
      }
    },
    "/v1/{chain}/{network}/modules/{module_address}/{module_name}": {
      "get": {
        "parameters": [
          {
            "in": "path",
            "name": "chain",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "in": "path",
            "name": "network",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "in": "path",
            "name": "module_address",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "in": "path",
            "name": "module_name",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Module"
                }
              }
            },
            "description": "Successful response"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPError"
                }
              }
            },
            "description": "Not found"
          }
        },
        "tags": ["V1.Modules"],
        "summary": "Get module by address and name",
        "description": "Get a module entry for a given chain, network, module_address, and module_name"
      }
    }
  },
  "openapi": "3.0.3",
  "components": {
    "schemas": {
      "HTTPError": {
        "properties": {
          "detail": {
            "type": "object"
          },
          "message": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "Social": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "url": {
            "type": "string"
          }
        },
        "required": ["name", "url"]
      },
      "Account": {
        "type": "object",
        "properties": {
          "slug": {
            "type": "string"
          },
          "address": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "type": {
            "type": "string"
          }
        },
        "required": ["address", "description", "name", "slug", "type"]
      },
      "Code": {
        "type": "object",
        "properties": {
          "slug": {
            "type": "string"
          },
          "id": {
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "github": {
            "type": "string"
          }
        },
        "required": ["description", "github", "id", "name", "slug"]
      },
      "Contract": {
        "type": "object",
        "properties": {
          "slug": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "address": {
            "type": "string"
          },
          "code": {
            "type": "integer"
          },
          "github": {
            "type": "string"
          }
        },
        "required": ["address", "code", "description", "github", "name", "slug"]
      },
      "Module": {
        "type": "object",
        "properties": {
          "slug": {
            "type": "string"
          },
          "address": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "github": {
            "type": "string"
          }
        },
        "required": ["address", "description", "github", "name", "slug"]
      },
      "RawEntity": {
        "type": "object",
        "properties": {
          "slug": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "website": {
            "type": "string"
          },
          "logo": {
            "type": "string"
          },
          "github": {
            "type": "string"
          },
          "socials": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Social"
            }
          },
          "accounts": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Account"
            }
          },
          "codes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Code"
            }
          },
          "contracts": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Contract"
            }
          },
          "modules": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Module"
            }
          }
        },
        "required": ["description", "github", "logo", "name", "slug", "socials", "website"]
      },
      "Asset": {
        "type": "object",
        "properties": {
          "coingecko": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "logo": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "precision": {
            "type": "integer"
          },
          "slugs": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "symbol": {
            "type": "string"
          },
          "type": {
            "type": "string"
          }
        },
        "required": [
          "coingecko",
          "description",
          "id",
          "logo",
          "name",
          "precision",
          "slugs",
          "symbol",
          "type"
        ]
      },
      "EntityDetail": {
        "type": "object",
        "properties": {
          "description": {
            "type": "string"
          },
          "github": {
            "type": "string"
          },
          "logo": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "socials": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Social"
            }
          },
          "website": {
            "type": "string"
          }
        },
        "required": ["description", "github", "logo", "name", "socials", "website"]
      },
      "Entity": {
        "type": "object",
        "properties": {
          "slug": {
            "type": "string"
          },
          "details": {
            "$ref": "#/components/schemas/EntityDetail"
          },
          "accounts": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Account"
            }
          },
          "codes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Code"
            }
          },
          "contracts": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Contract"
            }
          },
          "modules": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Module"
            }
          }
        },
        "required": ["details", "slug"]
      }
    }
  }
}