Get remaining credits for your API key

GET

/account/credits

const url = 'https://api.relayxapi.com/account/credits';
const options = {
  method: 'GET',
  headers: { 'X-API-Key': '<api-key>' },
};

try {
  const res = await fetch(url, options);
  const data = await res.json();
  console.log(data);
} catch (err) {
  console.error(err);
}

Return the credits remaining on the API key making the request. Always free.

Parameters

Header Parameters

x-api-key

X-Api-Key

string

Responses

200

Successful Response

Media typeapplication/json

Example

{
  "status": "success",
  "msg": "",
  "credits": 94700
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}