Get credit balance

Query Parameters

apiTokenstring | null | null

Header Parameters

x-api-tokenstring | null | null

Response Body

Successful Response

TypeScript Definitions

Use the response body type in TypeScript.

creditsCredits

'Standard' credits balance.

emailCreditsCredits

'Email' credits balance.

phoneCreditsCredits

'Phone' credits balance.

dailyLimitRateLeftDailylimitrateleft

Number of requests left for the current day.

Default: 0

dailyLimitRateSecondsToResetDailylimitratesecondstoreset

Number of seconds left until the daily limit resets.

Default: 0

Bad Request

TypeScript Definitions

Use the response body type in TypeScript.

detailRequiredstring

Value in: "Conflicting API tokens provided in query parameters and headers"

Payment Required

TypeScript Definitions

Use the response body type in TypeScript.

detailRequiredstring

Value in:

"Insufficient email credits" | "Some email verifications are already in progress and might use all your remaining email credits. Please try again later." | "Insufficient phone credits" | "Some phone verifications are already in progress and might use all your remaining phone credits. Please try again later."

Forbidden

TypeScript Definitions

Use the response body type in TypeScript.

detailRequiredstring

Value in: "API token should be provided in headers or query parameters" | "Current API token is not registered in our database"

Not found

Validation Error

TypeScript Definitions

Use the response body type in TypeScript.

detailDetail

curl -X GET "https://api.ocean.io/v2/credits/balance?apiToken=string" \
  -H "x-api-token: string"

fetch("https://api.ocean.io/v2/credits/balance?apiToken=string", {
  headers: {
    "x-api-token": "string"
  }
})

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {
  url := "https://api.ocean.io/v2/credits/balance?apiToken=string"

  req, _ := http.NewRequest("GET", url, nil)
  req.Header.Add("x-api-token", "string")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}

import requests

url = "https://api.ocean.io/v2/credits/balance?apiToken=string"

response = requests.request("GET", url, headers = {
  "x-api-token": "string"
})

print(response.text)

{
  "credits": {
    "oneTime": 100,
    "recurrent": 100
  },
  "emailCredits": {
    "oneTime": 100,
    "recurrent": 100
  },
  "phoneCredits": {
    "oneTime": 100,
    "recurrent": 100
  },
  "dailyLimitRateLeft": 10,
  "dailyLimitRateSecondsToReset": 3600
}

{
  "detail": "Conflicting API tokens provided in query parameters and headers"
}

{
  "detail": "Insufficient email credits"
}

{
  "detail": "API token should be provided in headers or query parameters"
}

Empty

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