Skip to main content
GET
Get API information
curl --request GET \
  --url https://api-testnet.mayybee.com/
{
  "name": "Mayybee API",
  "version": "1.0.0",
  "description": "Professional Prediction Market API on BNB Chain",
  "documentation": "https://docs.mayybee.com",
  "endpoints": {
    "testnet": "https://api-testnet.mayybee.com",
    "mainnet": "https://api.mayybee.com (coming soon)"
  },
  "status": "beta",
  "rateLimit": {
    "testnet": "240 requests/minute (no API key required)",
    "mainnet": "240 requests/minute (API key required)"
  }
}

Response

200 - application/json

API information

API information returned by the root endpoint. Contains metadata about the API, available endpoints, rate limits, and support channels.

​
name
string

API name identifier.

Example:

"Mayybee API"

​
version
string

Current API version following semantic versioning (major.minor.patch).

Example:

"1.1.0"

​
description
string

Human-readable description of the API and its purpose.

Example:

"Professional Prediction Market API on BNB Chain"

​
documentation
string<uri>

URL to the full API documentation site.

Example:

"https://docs.mayybee.com"

​
endpoints
object

Available API endpoints for different environments.

​
status
enum<string>

Current API lifecycle status.

Available options:
alpha,
beta,
stable,
deprecated
Example:

"beta"

​
rateLimit
object

Rate limiting configuration for different environments.

​
support
object

Support and community channels.