Account Reporter V2
curl --request GET \
--url https://api.waterfall.io/v2/account \
--header 'x-api-key: <api-key>'import requests
url = "https://api.waterfall.io/v2/account"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.waterfall.io/v2/account', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.waterfall.io/v2/account",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$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"
)
func main() {
url := "https://api.waterfall.io/v2/account"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.waterfall.io/v2/account")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.waterfall.io/v2/account")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"key_usage": {
"start_date": "2023-12-25",
"end_date": "2023-12-25",
"prospector_requests": 123,
"prospector_persons": 123,
"prospector_persons_phones": 123,
"enrichment_contact_requests": 123,
"enrichment_contact_persons": 123,
"enrichment_contact_persons_phones": 123,
"enrichment_phone_requests": 123,
"enrichment_phone_phones": 123,
"enrichment_company_requests": 123,
"enrichment_company_companies": 123,
"search_contact_requests": 123,
"search_contact_found": 123,
"search_company_requests": 123,
"search_company_found": 123,
"company_reveal_requests": 123,
"company_reveal_found": 123,
"company_titles_requests": 123,
"company_titles_found": 123,
"job_change_requests": 123,
"job_change_found": 123,
"verify_email_requests": 123,
"verify_email_verified": 123
},
"account_usage": {
"start_date": "2023-12-25",
"end_date": "2023-12-25",
"prospector_requests": 123,
"prospector_persons": 123,
"prospector_persons_phones": 123,
"enrichment_contact_requests": 123,
"enrichment_contact_persons": 123,
"enrichment_contact_persons_phones": 123,
"enrichment_phone_requests": 123,
"enrichment_phone_phones": 123,
"enrichment_company_requests": 123,
"enrichment_company_companies": 123,
"search_contact_requests": 123,
"search_contact_found": 123,
"search_company_requests": 123,
"search_company_found": 123,
"company_reveal_requests": 123,
"company_reveal_found": 123,
"company_titles_requests": 123,
"company_titles_found": 123,
"job_change_requests": 123,
"job_change_found": 123,
"verify_email_requests": 123,
"verify_email_verified": 123
},
"balance_remaining_usd": 123
}{
"status": "error",
"message": "Bad request",
"category": "VALIDATION",
"code": "VALIDATION_BAD_REQUEST"
}{
"status": "error",
"message": "Missing api key",
"category": "AUTH",
"code": "AUTH_MISSING_API_KEY",
"error": "Missing api key"
}{
"status": "error",
"message": "Your account is over its quota. Please contact your account manager to discuss an upgrade.",
"category": "QUOTA",
"code": "QUOTA_ACCOUNT_OVER_QUOTA"
}{
"status": "error",
"message": "Bad api key",
"category": "AUTH",
"code": "AUTH_BAD_API_KEY",
"error": "Bad api key"
}{
"status": "error",
"message": "Account or key not found",
"category": "NOT_FOUND",
"code": "NOT_FOUND_ACCOUNT_OR_KEY_NOT_FOUND"
}{
"status": "error",
"message": "Too many requests. Try again after 12.34 seconds",
"error": "Rate limit exceeded",
"category": "RATE_LIMIT",
"code": "RATE_LIMIT_RATE_LIMIT_EXCEEDED"
}Account
Account Reporter v2
Get key-level and account-level usage metrics for the current or any past month.
GET
/
v2
/
account
Account Reporter V2
curl --request GET \
--url https://api.waterfall.io/v2/account \
--header 'x-api-key: <api-key>'import requests
url = "https://api.waterfall.io/v2/account"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.waterfall.io/v2/account', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.waterfall.io/v2/account",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$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"
)
func main() {
url := "https://api.waterfall.io/v2/account"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.waterfall.io/v2/account")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.waterfall.io/v2/account")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"key_usage": {
"start_date": "2023-12-25",
"end_date": "2023-12-25",
"prospector_requests": 123,
"prospector_persons": 123,
"prospector_persons_phones": 123,
"enrichment_contact_requests": 123,
"enrichment_contact_persons": 123,
"enrichment_contact_persons_phones": 123,
"enrichment_phone_requests": 123,
"enrichment_phone_phones": 123,
"enrichment_company_requests": 123,
"enrichment_company_companies": 123,
"search_contact_requests": 123,
"search_contact_found": 123,
"search_company_requests": 123,
"search_company_found": 123,
"company_reveal_requests": 123,
"company_reveal_found": 123,
"company_titles_requests": 123,
"company_titles_found": 123,
"job_change_requests": 123,
"job_change_found": 123,
"verify_email_requests": 123,
"verify_email_verified": 123
},
"account_usage": {
"start_date": "2023-12-25",
"end_date": "2023-12-25",
"prospector_requests": 123,
"prospector_persons": 123,
"prospector_persons_phones": 123,
"enrichment_contact_requests": 123,
"enrichment_contact_persons": 123,
"enrichment_contact_persons_phones": 123,
"enrichment_phone_requests": 123,
"enrichment_phone_phones": 123,
"enrichment_company_requests": 123,
"enrichment_company_companies": 123,
"search_contact_requests": 123,
"search_contact_found": 123,
"search_company_requests": 123,
"search_company_found": 123,
"company_reveal_requests": 123,
"company_reveal_found": 123,
"company_titles_requests": 123,
"company_titles_found": 123,
"job_change_requests": 123,
"job_change_found": 123,
"verify_email_requests": 123,
"verify_email_verified": 123
},
"balance_remaining_usd": 123
}{
"status": "error",
"message": "Bad request",
"category": "VALIDATION",
"code": "VALIDATION_BAD_REQUEST"
}{
"status": "error",
"message": "Missing api key",
"category": "AUTH",
"code": "AUTH_MISSING_API_KEY",
"error": "Missing api key"
}{
"status": "error",
"message": "Your account is over its quota. Please contact your account manager to discuss an upgrade.",
"category": "QUOTA",
"code": "QUOTA_ACCOUNT_OVER_QUOTA"
}{
"status": "error",
"message": "Bad api key",
"category": "AUTH",
"code": "AUTH_BAD_API_KEY",
"error": "Bad api key"
}{
"status": "error",
"message": "Account or key not found",
"category": "NOT_FOUND",
"code": "NOT_FOUND_ACCOUNT_OR_KEY_NOT_FOUND"
}{
"status": "error",
"message": "Too many requests. Try again after 12.34 seconds",
"error": "Rate limit exceeded",
"category": "RATE_LIMIT",
"code": "RATE_LIMIT_RATE_LIMIT_EXCEEDED"
}This call is free — it does not consume credits or count against your rate limit.
What this endpoint does
Returns usage counters and remaining balance for both the authenticated API key (key_usage) and the entire account (account_usage). The two objects are identical if you only have one key. If you have multiple keys, account_usage reflects the sum across all keys.
Query parameter
Passmonth in YYYY-MM format to get usage for a specific month. If omitted, returns the current month.
GET /v2/account?month=2024-10
Usage fields
Bothkey_usage and account_usage return the same set of counters:
| Field | Description |
|---|---|
prospector_requests | Number of Prospector Launcher jobs submitted |
prospector_persons | Number of contacts returned by Prospector |
prospector_persons_phones | Phone numbers returned via Prospector phone enrichment |
enrichment_contact_requests | Contact Enrichment Launcher jobs submitted |
enrichment_contact_persons | Contacts successfully enriched |
enrichment_contact_persons_phones | Phone numbers returned via Contact Enrichment |
enrichment_phone_requests | Phone Enrichment Launcher jobs submitted |
enrichment_phone_phones | Phone numbers successfully returned |
enrichment_company_requests | Company Enrichment Launcher jobs submitted |
enrichment_company_companies | Companies successfully enriched |
search_contact_requests | Search Contact Launcher jobs submitted |
search_contact_found | Contacts returned by Search Contact |
verify_email_requests | Email Verifier calls made |
verify_email_verified | Emails that returned a definitive status (valid, invalid, risky) |
balance_remaining_usd | Remaining account balance in USD |
Authorizations
To access the API, provide your API key in x-api-key.
Query Parameters
Optional month in YYYY-MM format used to scope usage counters.
Required string length:
7Pattern:
^\d{4}-\d{2}$Response
Success. You can check usage.
⌘I