{ "openapi": "3.1.0", "info": { "title": "Adolfjon API", "version": "1.0.0-beta", "description": "Read-only API for Adolfjon.uz. Docs: https://dev.adolfjon.uz/docs" }, "servers": [ { "url": "https://dev.adolfjon.uz" } ], "security": [ { "bearer": [] } ], "tags": [ { "name": "Meta" }, { "name": "Catalog" }, { "name": "Account" } ], "paths": { "/v1/key": { "get": { "operationId": "key", "summary": "Inspect your key", "description": "Shows the key you are calling with: mode, scopes, limits, usage today and expiry. Needs no permission. A good first call.", "tags": [ "Meta" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "ok": true, "data": { "id": 12, "name": "My bot", "prefix": "ak_live_Ab3d", "mode": "live", "app": { "id": 4, "name": "Stock watcher", "status": "approved" }, "scopes": [ "catalog:read", "balance:read" ], "ip_allowlist": [], "limits": { "per_minute": 30, "per_day": 2000, "used_today": 17 }, "expires_at": "2027-01-24T02:00:00+05:00" }, "meta": { "request_id": "req_3f9a0c1d2e4b5a6978c0", "mode": "live" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/ping": { "get": { "operationId": "ping", "summary": "Ping", "description": "Health check. No key needed. Limited to 60 calls per minute per IP.", "tags": [ "Meta" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "ok": true, "data": { "pong": true, "version": "v1", "time": "2026-10-26T14:05:00+05:00" }, "meta": { "request_id": "req_3f9a0c1d2e4b5a6978c0", "mode": "live" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [] } }, "/v1/catalog/categories": { "get": { "operationId": "categories", "summary": "List categories", "description": "All store categories that are on, with the number of products on sale in each.\n\nPermission: `catalog:read`", "tags": [ "Catalog" ], "parameters": [ { "name": "lang", "in": "query", "required": false, "description": "Language of names. Default en.", "schema": { "type": "string", "enum": [ "uz", "ru", "en" ], "example": "en" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "ok": true, "data": [ { "id": 2, "name": "Subscriptions", "slug": "subscriptions", "products": 6 }, { "id": 5, "name": "Steam accounts", "slug": "accounts", "products": 14 } ], "meta": { "request_id": "req_3f9a0c1d2e4b5a6978c0", "mode": "live" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/catalog/products": { "get": { "operationId": "products", "summary": "List products", "description": "Products on sale, newest first. Prices are the public price in UZS, including active sales.\n\nPermission: `catalog:read`", "tags": [ "Catalog" ], "parameters": [ { "name": "category", "in": "query", "required": false, "description": "Only this category id.", "schema": { "type": "integer" } }, { "name": "type", "in": "query", "required": false, "description": "Only this product type.", "schema": { "type": "string", "enum": [ "account", "token", "coupon", "service", "boost", "design" ] } }, { "name": "limit", "in": "query", "required": false, "description": "Items per page, 1 to 100. Default 20.", "schema": { "type": "integer", "example": 20 } }, { "name": "cursor", "in": "query", "required": false, "description": "meta.next_cursor from the previous page.", "schema": { "type": "string" } }, { "name": "lang", "in": "query", "required": false, "description": "Language of titles and texts. Default en.", "schema": { "type": "string", "enum": [ "uz", "ru", "en" ], "example": "en" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "ok": true, "data": [ { "id": 341, "title": "VIP 30 days", "type": "token", "category_id": 2, "price": { "uzs": 59000, "original_uzs": 59000, "discount_percent": 0, "sale_ends_at": null }, "in_stock": true, "stock": null, "featured": true, "sold": 1840, "image_url": "https://adolfjon.uz/storage/uploads/vip.webp", "description": "VIP access for 30 days. Activates instantly.", "tags": [ "vip" ], "url": "https://adolfjon.uz/store/product/341", "created_at": "2026-10-26T14:05:00+05:00" } ], "meta": { "request_id": "req_3f9a0c1d2e4b5a6978c0", "mode": "live", "has_more": false, "next_cursor": null } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/catalog/products/{id}": { "get": { "operationId": "product", "summary": "Get a product", "description": "One product by id. Returns not_found when it is hidden or sold out for good.\n\nPermission: `catalog:read`", "tags": [ "Catalog" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Product id.", "schema": { "type": "integer", "example": 341 } }, { "name": "lang", "in": "query", "required": false, "description": "Language. Default en.", "schema": { "type": "string", "enum": [ "uz", "ru", "en" ], "example": "en" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "ok": true, "data": { "id": 341, "title": "VIP 30 days", "type": "token", "category_id": 2, "price": { "uzs": 59000, "original_uzs": 59000, "discount_percent": 0, "sale_ends_at": null }, "in_stock": true, "stock": null, "featured": true, "sold": 1840, "image_url": "https://adolfjon.uz/storage/uploads/vip.webp", "description": "VIP access for 30 days. Activates instantly.", "tags": [ "vip" ], "url": "https://adolfjon.uz/store/product/341", "created_at": "2026-10-26T14:05:00+05:00" }, "meta": { "request_id": "req_3f9a0c1d2e4b5a6978c0", "mode": "live" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/news": { "get": { "operationId": "news", "summary": "List news", "description": "Published news posts, newest first.\n\nPermission: `catalog:read`", "tags": [ "Catalog" ], "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "Items per page, 1 to 100. Default 20.", "schema": { "type": "integer", "example": 20 } }, { "name": "cursor", "in": "query", "required": false, "description": "meta.next_cursor from the previous page.", "schema": { "type": "string" } }, { "name": "lang", "in": "query", "required": false, "description": "Language of titles and texts. Default en.", "schema": { "type": "string", "enum": [ "uz", "ru", "en" ], "example": "en" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "ok": true, "data": [ { "id": 60, "type": "update", "pinned": false, "title": "Automatic card top-up", "body": "Top up with HUMO and the balance arrives by itself.", "image_url": null, "link": null, "url": "https://adolfjon.uz/news/60", "created_at": "2026-10-26T14:05:00+05:00" } ], "meta": { "request_id": "req_3f9a0c1d2e4b5a6978c0", "mode": "live", "has_more": false, "next_cursor": null } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/me": { "get": { "operationId": "me", "summary": "Your profile", "description": "The account that owns the key. No email, phone or login details are ever returned.\n\nPermission: `account:read`", "tags": [ "Account" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "ok": true, "data": { "id": 5821, "public_id": "K3M9QX2A", "nickname": "jasur", "plan": "VIP", "level": 7, "xp_total": 4820, "language": "uz", "avatar_url": null, "linked": { "telegram": true, "google": false, "steam": true, "discord": false }, "created_at": "2025-03-14T18:20:00+05:00" }, "meta": { "request_id": "req_3f9a0c1d2e4b5a6978c0", "mode": "live" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/me/balance": { "get": { "operationId": "balance", "summary": "Your balance", "description": "Current balance in UZS.\n\nPermission: `balance:read`", "tags": [ "Account" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "ok": true, "data": { "balance": 245000, "currency": "UZS", "as_of": "2026-10-26T14:05:00+05:00" }, "meta": { "request_id": "req_3f9a0c1d2e4b5a6978c0", "mode": "live" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/me/balance/transactions": { "get": { "operationId": "transactions", "summary": "Balance history", "description": "Every change to your balance, newest first. type is topup, purchase, refund or adjustment. amount is negative when money left the balance.\n\nPermission: `balance:read`", "tags": [ "Account" ], "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "Items per page, 1 to 100. Default 20.", "schema": { "type": "integer", "example": 20 } }, { "name": "cursor", "in": "query", "required": false, "description": "meta.next_cursor from the previous page.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "ok": true, "data": [ { "id": 9000, "type": "topup", "amount": 150000, "balance_after": 245000, "reference": { "type": "humo", "id": 700 }, "created_at": "2026-10-26T14:05:00+05:00" } ], "meta": { "request_id": "req_3f9a0c1d2e4b5a6978c0", "mode": "live", "has_more": false, "next_cursor": null } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/me/orders": { "get": { "operationId": "orders", "summary": "Your orders", "description": "Your store orders, newest first. Order info only: delivered items (keys, logins, codes) are never returned by the API.\n\nPermission: `orders:read`", "tags": [ "Account" ], "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "Items per page, 1 to 100. Default 20.", "schema": { "type": "integer", "example": 20 } }, { "name": "cursor", "in": "query", "required": false, "description": "meta.next_cursor from the previous page.", "schema": { "type": "string" } }, { "name": "lang", "in": "query", "required": false, "description": "Language of titles and texts. Default en.", "schema": { "type": "string", "enum": [ "uz", "ru", "en" ], "example": "en" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "ok": true, "data": [ { "id": "A7K2M9", "status": "approved", "refunded": false, "cancelled": false, "payment_method": "balance", "total_uzs": 59000, "discount_uzs": 0, "coupon": null, "items": [ { "product_id": 341, "title": "VIP 30 days", "type": "token", "quantity": 1, "price_uzs": 59000, "delivery": "token" } ], "url": "https://adolfjon.uz/store/orders/A7K2M9", "created_at": "2026-10-26T14:05:00+05:00", "updated_at": "2026-10-26T14:05:00+05:00" } ], "meta": { "request_id": "req_3f9a0c1d2e4b5a6978c0", "mode": "live", "has_more": false, "next_cursor": null } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/me/orders/{id}": { "get": { "operationId": "order", "summary": "Get an order", "description": "One of your orders by its order number (the id field of the list).\n\nPermission: `orders:read`", "tags": [ "Account" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Order number, e.g. A7K2M9.", "schema": { "type": "string", "example": "TST000503" } }, { "name": "lang", "in": "query", "required": false, "description": "Language. Default en.", "schema": { "type": "string", "enum": [ "uz", "ru", "en" ], "example": "en" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "ok": true, "data": { "id": "A7K2M9", "status": "approved", "refunded": false, "cancelled": false, "payment_method": "balance", "total_uzs": 59000, "discount_uzs": 0, "coupon": null, "items": [ { "product_id": 341, "title": "VIP 30 days", "type": "token", "quantity": 1, "price_uzs": 59000, "delivery": "token" } ], "url": "https://adolfjon.uz/store/orders/A7K2M9", "created_at": "2026-10-26T14:05:00+05:00", "updated_at": "2026-10-26T14:05:00+05:00" }, "meta": { "request_id": "req_3f9a0c1d2e4b5a6978c0", "mode": "live" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/me/licenses": { "get": { "operationId": "licenses", "summary": "Your plan", "description": "Your VIP / LITE plan. plan is what is active right now; paid_plan and expires_at show the paid plan even after it ended.\n\nPermission: `licenses:read`", "tags": [ "Account" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "ok": true, "data": { "plan": "VIP", "paid_plan": "VIP", "active": true, "expires_at": "2026-11-07T14:00:00+05:00", "days_left": 12, "auto_renew": true }, "meta": { "request_id": "req_3f9a0c1d2e4b5a6978c0", "mode": "live" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/me/boost": { "get": { "operationId": "boost", "summary": "Your Hour Boost", "description": "Your Hour Boost plans with hours, games (Steam app ids) and the linked account status. Read only in v1.\n\nPermission: `boost:read`", "tags": [ "Account" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "ok": true, "data": [ { "id": 4401, "tier": "custom", "status": "active", "hours": { "total": 1000, "used": 312.75, "left": 687.25 }, "max_games": 32, "games": [ 730, 570, 440 ], "card_farming": true, "account": { "status": "active", "steam_id": "76561198000000000", "boosting": true, "started_at": "2026-10-26T14:05:00+05:00", "last_tick_at": "2026-10-26T14:05:00+05:00" }, "created_at": "2026-10-26T14:05:00+05:00" } ], "meta": { "request_id": "req_3f9a0c1d2e4b5a6978c0", "mode": "live" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/me/notifications": { "get": { "operationId": "notifications", "summary": "Your notifications", "description": "Site notifications, newest first. Reading them here does not mark them as read.\n\nPermission: `notifications:read`", "tags": [ "Account" ], "parameters": [ { "name": "unread", "in": "query", "required": false, "description": "Only unread ones.", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "limit", "in": "query", "required": false, "description": "Items per page, 1 to 100. Default 20.", "schema": { "type": "integer", "example": 20 } }, { "name": "cursor", "in": "query", "required": false, "description": "meta.next_cursor from the previous page.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "ok": true, "data": [ { "id": 80000, "type": "order", "title": "Order approved", "body": "Your order A7K2M9 is ready.", "url": "https://adolfjon.uz/store/orders/A7K2M9", "read": false, "created_at": "2026-10-26T14:05:00+05:00" } ], "meta": { "request_id": "req_3f9a0c1d2e4b5a6978c0", "mode": "live", "has_more": false, "next_cursor": null } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "components": { "securitySchemes": { "bearer": { "type": "http", "scheme": "bearer", "description": "ak_live_... or ak_test_..." } }, "schemas": { "Error": { "type": "object", "properties": { "ok": { "type": "boolean", "const": false }, "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "unauthorized", "key_expired", "key_revoked", "account_blocked", "app_not_approved", "app_rejected", "app_suspended", "insufficient_scope", "ip_not_allowed", "not_found", "method_not_allowed", "rate_limited", "daily_quota_exceeded", "server_error", "api_disabled", "api_unavailable" ] }, "message": { "type": "string" }, "docs": { "type": "string" } } }, "meta": { "type": "object", "properties": { "request_id": { "type": "string" } } } } } } } }