Get User Info - Scrapeless API

Request

Authorization

Add parameter in header

x-api-token

Example:

x-api-token: 2f68dbbf-519d-4f01-9636-e2421b68f379

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200Success

application/json

Body

credits

string

required

The user's account balance as a string.

excessCredits

string

required

The user's remaining credits (if applicable), as a string.

plan

object

required

Details about the user's subscription plan.

credits

string

required

Remaining balance within the subscription plan, as a string.

endAt

string

required

Subscription plan expiry date in ISO 8601 format.

price

integer

required

The price of the subscription plan, as a number.

status

integer

required

The status of the subscription plan (0 for inactive).

usage

integer

required

The current usage of the subscription plan, as a number.

status

integer

required

General user status (1 for active users).

userId

string

required

The unique identifier of the user.

Example

{
  "credits": "82.1495994348",
  "excessCredits": "0",
  "plan": {
    "credits": "0",
    "endAt": "2099-12-31T23:59:59.999Z",
    "price": 0,
    "status": 0,
    "usage": 0
  },
  "status": 1,
  "userId": "fad03c7e-xxxx-xxxx-b066-ece80f03d5d5"
}