Getting Started

Quick Start

Go from zero to a working Outfame integration in about five minutes. You'll install an SDK, authenticate, spin up a growth campaign, and pull your first analytics data.

Prerequisites — An Outfame account and an API key. Sign up at dashboard.outfame.com if you haven't yet.

Step 1 — Get your API key

Go to Settings → API Keys in the Outfame dashboard. Click Create new key, name it, and copy the value. Keys are prefixed with sk_live_ for production or sk_test_ for sandbox.

Store your API key in an environment variable. Never hard-code it into client-side code or commit it to version control.

Step 2 — Install the SDK

Pick the SDK for your language:

Node.js

npm install @outfame/sdk
# or
yarn add @outfame/sdk
# or
pnpm add @outfame/sdk

Python

pip install outfame
# or
poetry add outfame

PHP

composer require outfame/outfame-php

Step 3 — Initialize the client

Node.js

import Outfame from "@outfame/sdk";

const outfame = new Outfame({
  apiKey: process.env.OUTFAME_API_KEY,
});

Python

import outfame

client = outfame.Client(api_key="sk_live_your_api_key")

Step 4 — Create your first growth campaign

Connect an Instagram account and set up basic targeting. Once the account status moves to active, organic growth kicks in automatically.

Request

curl -X POST https://api.outfame.com/v1/accounts \
  -H "Authorization: Bearer sk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "instagram_username": "your_handle",
    "platform": "instagram",
    "targeting_config": {
      "competitor_accounts": ["competitor1", "competitor2"],
      "hashtags": ["fitness", "healthylifestyle"],
      "locations": [
        { "name": "Los Angeles, CA", "radius_km": 50 }
      ]
    }
  }'

Response

{
  "id": "acc_7Gx2kLm9Qr",
  "instagram_username": "your_handle",
  "platform": "instagram",
  "status": "setup",
  "followers_count": 1243,
  "following_count": 847,
  "engagement_rate": 3.42,
  "growth_rate": 0,
  "targeting_config": {
    "competitor_accounts": ["competitor1", "competitor2"],
    "hashtags": ["fitness", "healthylifestyle"],
    "locations": [
      { "name": "Los Angeles, CA", "radius_km": 50 }
    ]
  },
  "created_at": "2026-02-09T14:22:31Z",
  "updated_at": "2026-02-09T14:22:31Z"
}

The account starts in setup status while Outfame validates the username and analyzes the audience graph. Within a few minutes it'll move to active and growth begins.

Step 5 — Monitor results

Once the account is active, pull real-time analytics to see followers gained, engagement rate, and audience breakdown.

Node.js

const analytics = await outfame.analytics.overview("acc_7Gx2kLm9Qr", {
  period: "7d",
});

console.log(analytics);
// {
//   followers_gained: 312,
//   followers_lost: 18,
//   net_growth: 294,
//   engagement_rate: 4.17,
//   growth_rate: 23.65,
//   period: "7d"
// }

cURL

curl https://api.outfame.com/v1/analytics/overview?account_id=acc_7Gx2kLm9Qr&period=7d \
  -H "Authorization: Bearer sk_live_your_api_key"

Next steps