API Access Overview

The Wall API provides tools for authentication, file management, and cost tracking. This page provides a concise reference to its endpoints and rate limits.

1. Base URL

• Windows + Docker Desktop: http://localhost:8000/

• Linux + Docker + Docker Compose: http://<WSL2 IP>:8000/

2. Endpoints

Endpoint	URL	Requires token authentication	Rate limit scopes
Create User	/api/v2/auth/users/	No	Unauthenticated
Set Password	/api/v2/auth/users/set_password/	Yes	User management
Login (authenticate)	/api/v2/auth/token/login/	No	Authenticated + Unauthenticated1️⃣
Logout (revoke token)	/api/v2/auth/token/logout/	Yes	User management
Delete User	/api/v2/auth/users/me/{username}/	Yes	User management + Unauthenticated2️⃣
Upload File	/api/v2/wallconfig-files/upload/	Yes	File management
List Files	/api/v2/wallconfig-files/list/	Yes	Authenticated
Delete File	/api/v2/wallconfig-files/delete/	Yes	File management
Daily Profile Cost	/api/v2/profiles/<int:profile_id>/overview/<int:day>/	Yes	Authenticated
Daily Wall Cost	/api/v2/profiles/overview/<int:day>/	Yes	Authenticated
Total Wall Cost	/api/v2/profiles/overview/	Yes	Authenticated
Daily Profile Ice Amount	/api/v2/profiles/<int:profile_id>/days/<int:day>/	Yes	Authenticated

Notes

1️⃣ Unauthenticated and Authenticated rate limits are tracked separately, and the counters do not reset. Instead, they dynamically switch depending on the user's authentication state.

2️⃣ Deleting a user requires authentication at the start of the request. However, once the user account is deleted, the session token is invalidated, and the user becomes unauthenticated. Any subsequent requests to this endpoint will fall under the "Unauthenticated" rate limit scope.

💡 For comprehensive details on each endpoint and its parameters, please refer to the Detailed OpenAPI Documentation.

3. Rate Limit Scopes

Scope	Limit
Unauthenticated (The user is not logged in)	5 / min
Authenticated (The user is logged in with a valid token)	100 / min
File management	5 / min
User management	10 / min

4. Detailed OpenAPI Documentation

Endpoint	URL
Swagger UI	/api/v2/swagger-ui/
ReDoc	/api/v2/redoc/
Schema	/api/v2/schema/

💡 For more details on OpenAPI schema generation, see the DRF Spectacular page.

---

Next:   Detailed Functional Specification
Back to: Installation Instructions Index

Return to Top
Home Page

---