Account and Credits

Qoest exposes a small account surface alongside the scraping endpoints.

Credits are only deducted when a request succeeds.

#Endpoints

• GET /me
• PATCH /me
• POST /add-credits
• GET /requests

#Get Current Account

GET /me

Returns the authenticated user profile, including current credit balance.

{
  "user": {
    "id": 1,
    "name": "Jane Developer",
    "email": "[email protected]",
    "credits": 100,
    "created_at": "2026-03-23T00:00:00.000000Z",
    "updated_at": "2026-03-23T00:00:00.000000Z"
  }
}

#Update Email

PATCH /me

{
  "email": "[email protected]",
  "secret_key": "your-secret-key"
}

#Set Credit Balance

POST /add-credits

{
  "amount": 500
}

Important: the current implementation sets the user balance to the provided amount. It does not increment the previous value.

#Request History

GET /requests

Returns a lightweight paginated list of saved request records when available.