GET API USAGE (V2)

GET /v2/getapiusage

API DEFAULT URL: https://api.zerobounce.net/v2/getapiusage
API U.S.A. URL*: https://api-us.zerobounce.net/v2/getapiusage

*This endpoint uses servers located within the United States. By utilizing this endpoint, you acknowledge and consent to your data being processed on servers in the United States.

URL Parameters

  • Parameter
    Description
  • api_key
    Your API Key, found in your account.
  • start_date
    The start date of when you want to view API usage. (format: yyyy-mm-dd)
  • end_date
    The end date of when you want to view API usage. (format: yyyy-mm-dd)
  • https://api.zerobounce.net/v2/getapiusage?api_key=your-api-key&start_date=2018-01-01&end_date=2019-12-12
  • https://api-us.zerobounce.net/v2/getapiusage?api_key=your-api-key&start_date=2018-01-01&end_date=2019-12-12

The API will return these results in a JSON format using the "getapiusage" method.

The API will return these results in a JSON format using the "getapiusage" method.

  • Parameter
    Description
  • total
    Total number of times the API has been called
  • status_valid
    Total valid email addresses returned by the API
  • status_invalid
    Total invalid email addresses returned by the API
  • status_catch_all
    Total catch-all email addresses returned by the API
  • status_do_not_mail
    Total do not mail email addresses returned by the API
  • status_spamtrap
    Total spamtrap email addresses returned by the API
  • status_unknown
    Total unknown email addresses returned by the API
  • sub_status_toxic
    Total number of times the API has a sub status of "toxic"
  • sub_status_disposable
    Total number of times the API has a sub status of "disposable"
  • sub_status_role_based
    Total number of times the API has a sub status of "role_based"
  • sub_status_possible_trap
    Total number of times the API has a sub status of "possible_trap"
  • sub_status_global_suppression
    Total number of times the API has a sub status of "global_suppression"
  • sub_status_timeout_exceeded
    Total number of times the API has a sub status of "timeout_exceeded"
  • sub_status_mail_server_temporary_error
    Total number of times the API has a sub status of "mail_server_temporary_error"
  • sub_status_mail_server_did_not_respond
    Total number of times the API has a sub status of "mail_server_did_not_respond"
  • sub_status_greylisted
    Total number of times the API has a sub status of "greylisted"
  • sub_status_antispam_system
    Total number of times the API has a sub status of "antispam_system"
  • sub_status_does_not_accept_mail
    Total number of times the API has a sub status of "does_not_accept_mail"
  • sub_status_exception_occurred
    Total number of times the API has a sub status of "exception_occurred"
  • sub_status_failed_syntax_check
    Total number of times the API has a sub status of "failed_syntax_check"
  • sub_status_mailbox_not_found
    Total number of times the API has a sub status of "mailbox_not_found"
  • sub_status_unroutable_ip_address
    Total number of times the API has a sub status of "unroutable_ip_address"
  • sub_status_possible_typo
    Total number of times the API has a sub status of "possible_typo"
  • sub_status_no_dns_entries
    Total number of times the API has a sub status of "no_dns_entries"
  • sub_status_role_based_catch_all
    Total role based catch alls the API has a sub status of "role_based_catch_all"
  • sub_status_mailbox_quota_exceeded
    Total number of times the API has a sub status of "mailbox_quota_exceeded"
  • sub_status_forcible_disconnect
    Total forcible disconnects the API has a sub status of "forcible_disconnect"
  • sub_status_failed_smtp_connection
    Total failed SMTP connections the API has a sub status of "failed_smtp_connection"
  • sub_status_mx_forward
    Total number times the API has a sub status "mx_forward"
  • start_date
    Start date of query. (format: yyyy/mm/dd)
  • end_date
    End date of query. (format: yyyy/mm/dd)

GET API USAGE CODE SAMPLES

ENDPOINT RESPONSE

Successful Response
 {
      "total": 120,
      "status_valid": 17,
      "status_invalid": 69,
      "status_catch_all": 9,
      "status_do_not_mail": 16,
      "status_spamtrap": 0,
      "status_unknown": 6,
      "sub_status_toxic": 0,
      "sub_status_disposable": 1,
      "sub_status_role_based": 1,
      "sub_status_possible_trap": 0,
      "sub_status_global_suppression": 14,
      "sub_status_timeout_exceeded": 0,
      "sub_status_mail_server_temporary_error": 0,
      "sub_status_mail_server_did_not_respond": 0,
      "sub_status_greylisted": 6,
      "sub_status_antispam_system": 0,
      "sub_status_does_not_accept_mail": 27,
      "sub_status_exception_occurred": 0,
      "sub_status_failed_syntax_check": 20,
      "sub_status_mailbox_not_found": 12,
      "sub_status_unroutable_ip_address": 0,
      "sub_status_possible_typo": 0,
      "sub_status_no_dns_entries": 10,
      "sub_status_role_based_catch_all": 0,
      "sub_status_mailbox_quota_exceeded": 0,
      "sub_status_forcible_disconnect": 0,
      "sub_status_failed_smtp_connection": 0,
      "sub_status_leading_period_removed": 0,
      "sub_status_alias_address": 2,
      "sub_status_mx_forward": 0,
      "sub_status_alternate": 0,
      "sub_status_blocked": 0,
      "sub_status_allowed": 0,
      "start_date": "1/1/2023",
      "end_date": "1/30/2024"
    }
Error Response - API Key

    {"error":"Invalid API Key"}
Error Response - Date

    {"error":"Invalid Date"}

GetApiUsage V2 Rate Limits

Bad requests to https://api.zerobounce.net/v2/getapiusage and https://api-us.zerobounce.net/v2/getapiusage 200 times in 1 hour will result in a temporary block for 1 hour.

*This endpoint uses servers located within the United States. By utilizing this endpoint, you acknowledge and consent to your data being processed on servers in the United States.