API documentation

BeeQuant provides RESTful APIs. Every endpoint returns JSON data.

Basics

Core configuration for API requests

Base URL

https://api.beequant.com/api

Authentication

Except for authentication endpoints, include a JWT token in the request header:Authorization: Bearer YOUR_TOKEN

Response format

All API responses use JSON and include a success field that indicates whether the request succeeded.

ID format

All resource IDs use the UUID format (for example: 550e8400-e29b-41d4-a716-446655440000).

POST/api/auth/register

POST /api/auth/register endpoint

Request body parameters

Name	Type	Required	Description
username	string	Yes	See the endpoint schema.
email	string	Yes	See the endpoint schema.
password	string	Yes	See the endpoint schema.

Response example

{
  "success": true,
  "message": "Example value",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "user": {
    "id": "uuid",
    "username": "newuser",
    "email": "user@example.com",
    "name": "newuser"
  }
}

POST/api/auth/login

POST /api/auth/login endpoint

Request body parameters

Name	Type	Required	Description
email	string	Yes	See the endpoint schema.
password	string	Yes	See the endpoint schema.

Response example

{
  "success": true,
  "message": "Example value",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "user": {
    "id": "uuid",
    "username": "admin",
    "email": "admin@gmail.com",
    "name": "admin"
  }
}

POST/api/auth/send-verification

POST /api/auth/send-verification endpoint

Request body parameters

Name	Type	Required	Description
email	string	Yes	See the endpoint schema.

Response example

{
  "success": true,
  "message": "Example value"
}

POST/api/auth/verify-code

POST /api/auth/verify-code endpoint

Request body parameters

Name	Type	Required	Description
email	string	Yes	See the endpoint schema.
code	string	Yes	See the endpoint schema.

Response example

{
  "success": true,
  "message": "Example value"
}

POST/api/auth/logout

POST /api/auth/logout endpoint

Response example

{
  "success": true,
  "message": "Example value"
}

POST/api/auth/forgot-password

POST /api/auth/forgot-password endpoint

Request body parameters

Name	Type	Required	Description
email	string	Yes	See the endpoint schema.

Response example

{
  "success": true,
  "message": "Example value"
}

POST/api/auth/reset-password

POST /api/auth/reset-password endpoint

Request body parameters

Name	Type	Required	Description
token	string	Yes	See the endpoint schema.
newPassword	string	Yes	See the endpoint schema.

Response example

{
  "success": true,
  "message": "Example value"
}

POST/api/auth/verify-reset-code

POST /api/auth/verify-reset-code endpoint

Request body parameters

Name	Type	Required	Description
email	string	Yes	See the endpoint schema.
code	string	Yes	See the endpoint schema.

Response example

{
  "success": true,
  "message": "Example value"
}

API documentation

BeeQuant provides RESTful APIs. Every endpoint returns JSON data.

Basics

Core configuration for API requests

Base URL

https://api.beequant.com/api

Authentication

Except for authentication endpoints, include a JWT token in the request header:Authorization: Bearer YOUR_TOKEN

Response format

All API responses use JSON and include a success field that indicates whether the request succeeded.

ID format

All resource IDs use the UUID format (for example: 550e8400-e29b-41d4-a716-446655440000).

POST/api/auth/register

POST /api/auth/register endpoint

Request body parameters

Name	Type	Required	Description
username	string	Yes	See the endpoint schema.
email	string	Yes	See the endpoint schema.
password	string	Yes	See the endpoint schema.

Response example

{
  "success": true,
  "message": "Example value",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "user": {
    "id": "uuid",
    "username": "newuser",
    "email": "user@example.com",
    "name": "newuser"
  }
}

POST/api/auth/login

POST /api/auth/login endpoint

Request body parameters

Name	Type	Required	Description
email	string	Yes	See the endpoint schema.
password	string	Yes	See the endpoint schema.

Response example

{
  "success": true,
  "message": "Example value",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "user": {
    "id": "uuid",
    "username": "admin",
    "email": "admin@gmail.com",
    "name": "admin"
  }
}

POST/api/auth/send-verification

POST /api/auth/send-verification endpoint

Request body parameters

Name	Type	Required	Description
email	string	Yes	See the endpoint schema.

Response example

{
  "success": true,
  "message": "Example value"
}

POST/api/auth/verify-code

POST /api/auth/verify-code endpoint

Request body parameters

Name	Type	Required	Description
email	string	Yes	See the endpoint schema.
code	string	Yes	See the endpoint schema.

Response example

{
  "success": true,
  "message": "Example value"
}

POST/api/auth/logout

POST /api/auth/logout endpoint

Response example

{
  "success": true,
  "message": "Example value"
}

POST/api/auth/forgot-password

POST /api/auth/forgot-password endpoint

Request body parameters

Name	Type	Required	Description
email	string	Yes	See the endpoint schema.

Response example

{
  "success": true,
  "message": "Example value"
}

POST/api/auth/reset-password

POST /api/auth/reset-password endpoint

Request body parameters

Name	Type	Required	Description
token	string	Yes	See the endpoint schema.
newPassword	string	Yes	See the endpoint schema.

Response example

{
  "success": true,
  "message": "Example value"
}

POST/api/auth/verify-reset-code

POST /api/auth/verify-reset-code endpoint

Request body parameters

Name	Type	Required	Description
email	string	Yes	See the endpoint schema.
code	string	Yes	See the endpoint schema.

Response example

{
  "success": true,
  "message": "Example value"
}