API Documentation

Overview

Base URL: https://api.socialferret.com

All requests use JSON. Include Content-Type: application/json and your API key in the Authorization header.

Authentication

Use a Bearer token in the Authorization header. Get your API key from the dashboard.

Authorization: Bearer pk_your_api_key_here

Enrich

Submit a list of Instagram usernames to enrich. Returns verified emails, follower counts, engagement rates, and profile data. You are charged per email found.

Request body

Example request

curl -X POST https://api.socialferret.com/v1/enrich \
  -H "Authorization: Bearer pk_..." \
  -H "Content-Type: application/json" \
  -d '{"usernames": ["@sarahcreates", "@fashionbyjane"]}'

Response

Each result object: username, name, email, followers, following, engagement_rate, bio

Example response

{
  "results": [
    {
      "username": "sarahcreates",
      "name": "Sarah Creates",
      "email": "sarah@sarahcreates.com",
      "followers": 142391,
      "following": 847,
      "engagement_rate": 4.2,
      "bio": "🎨 Artist & designer · Prints & commissions..."
    }
  ],
  "credits_used": 1
}

Errors

Errors return a JSON body with error and code.