API — Enrichment

Retrieve Current Credit Balance

Use this endpoint to check the available credit balance in your Deep Enrich workspace.

  • Endpoint:
    GET /account/credits
Authorization

A valid authentication key is required in the request header.

Format:

  • Authorization: Bearer
    < your_api_key >
Response

200 OK – Successful Request

  • balance (number)
    – The total number of credits available in your workspace.

Example Response:

							
							{
								  "balance": 7200
							}
						

 

 

 

											
												curl --request GET \
												  --url https://app.Deepenrich.com/api/v1/account/credits \
												  --header 'Authorization: Bearer '
											
										
											
												import requests

												url = "https://app.Deepenrich.com/api/v1/account/credits"

												headers = {"Authorization": "Bearer "}

												response = requests.request("GET", url, headers=headers)

												print(response.text)
											
										
											
												const options = {method: 'GET', headers: {Authorization: 'Bearer '}};

												fetch('https://app.Deepenrich.com/api/v1/account/credits', options)
												  .then(response => response.json())
												  .then(response => console.log(response))
												  .catch(err => console.error(err));
											
										
											
											<?php 

											$curl = curl_init();

											curl_setopt_array($curl, [
											  CURLOPT_URL => "https://app.Deepenrich.com/api/v1/account/credits",
											  CURLOPT_RETURNTRANSFER => true,
											  CURLOPT_ENCODING => "",
											  CURLOPT_MAXREDIRS => 10,
											  CURLOPT_TIMEOUT => 30,
											  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
											  CURLOPT_CUSTOMREQUEST => "GET",
											  CURLOPT_HTTPHEADER => [
											    "Authorization: Bearer "
											  ],
											]);

											$response = curl_exec($curl);
											$err = curl_error($curl);

											curl_close($curl);

											if ($err) {
											  echo "cURL Error #:" . $err;
											} else {
											  echo $response;
											}
											
											
										
											
											
												package main

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

												func main() {

													url := "https://app.Deepenrich.com/api/v1/account/credits"

													req, _ := http.NewRequest("GET", url, nil)

													req.Header.Add("Authorization", "Bearer ")

													res, _ := http.DefaultClient.Do(req)

													defer res.Body.Close()
													body, _ := ioutil.ReadAll(res.Body)

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

												}
											
										
											
												HttpResponse response = Unirest.get("https://app.Deepenrich.com/api/v1/account/credits")
												  .header("Authorization", "Bearer ")
												  .asString();
											
										
example
											
												{
												  "balance": 5000
												}
											
										
													
														{
														  "code": "error.authorization.not_set",
														  "message": "Authorization headers not set"
														}
													
												
													
														{
														  "code": "error.authorization.not_bearer",
														  "message": "Authorization headers not have prefix 'bearer'"
														}
													
												
													
														{
														  "code": "error.api.key",
														  "message": "Unknown api key"
														}
													
												
											This response does not have an example.