API - Get Credits – SURFE

When using Surfe’s enrichment features, every lookup. Whether for a mobile number or an email, consumes credits. To help you stay on top of your usage and plan ahead, we’ve made it easy to check your current credit balance.

This article will walk you through how to retrieve your available credits and explain why it matters.

Why Track Credits?

Surfe uses a credit-based system to power enrichments. Each time you enrich a profile, credits are deducted based on the type of data you're requesting - email, mobile and search credits.

Knowing your credit balance helps you:

Avoid running out of credits mid-operation
Forecast usage for larger enrichment jobs
Keep your team aligned on resource consumption

The Endpoint You’ll Use

To retrieve your current balance, you’ll use the Get Credits endpoint.

This is a simple GET request. No payload needed just your API token in the header!

Example Request

curl --location 'https://api.surfe.com/v1/credits' \
--header 'Authorization: Bearer YOUR_API_TOKEN'

Replace YOUR_API_TOKEN with your Surfe API key. You can find instructions for locating your API token here.

Example Response

{
  "message": "You are out of {email | mobile | email and mobile} credits, buy more here: https://surfe.com/buy-credits",
  "totalEmail": 42,
  "totalMobile": 43,
  "totalSearch": 44
}

This response tells you how many email, mobile and search enrichment credits you currently have available.

When Should You Check?

We recommend checking your credit balance:

Before running a large enrichment request.
On a schedule (e.g., daily or weekly) You can build this into your API flow to check this endpoint before running enrichment requests.
After purchasing new credits to confirm they’ve been added.

Summary

Use this endpoint to check how many email, mobile and search enrichment credits you have.
It’s a fast and easy GET request. Just include your API token.
Tracking your credits helps avoid interruptions in your enrichment workflows.

Need Help?

If you have any questions or need further assistance, feel free to reach out to our support team via Intercom.

Additional Resources