Root endpoint

GET /

Root endpoint has no other function than to point end users to documentation.

Request

Responses

• 200
• 400
• 403
• 418
• 429
• 500

---

Information pointing to the documentation.

application/json

Schema

Example (from schema)

---

Schema

url string required
version string required

{
  "url": "https://blockfrost.io/",
  "version": "0.1.0"
}

Bad request

application/json

Schema

Example (from schema)

---

Schema

status_code integer required
error string required
message string required

{
  "status_code": 400,
  "error": "Bad Request",
  "message": "Backend did not understand your request."
}

Authentication secret is missing or invalid

application/json

Schema

Example (from schema)

---

Schema

status_code integer required
error string required
message string required

{
  "status_code": 403,
  "error": "Forbidden",
  "message": "Invalid project token."
}

IP has been auto-banned for extensive sending of requests after usage limit has been reached

application/json

Schema

Example (from schema)

---

Schema

status_code integer required
error string required
message string required

{
  "status_code": 418,
  "error": "Requested Banned",
  "message": "IP has been auto-banned for flooding."
}

Usage limit reached

application/json

Schema

Example (from schema)

---

Schema

status_code integer required
error string required
message string required

{
  "status_code": 429,
  "error": "Project Over Limit",
  "message": "Usage is over limit."
}

Internal Server Error

application/json

Schema

Example (from schema)

---

Schema

status_code integer required
error string required
message string required

{
  "status_code": 500,
  "error": "Internal Server Error",
  "message": "An unexpected response was received from the backend."
}

Loading...