Skip to content

Core API Concepts (1.0.0)

Discovery

Identify and evaluate creators using structured, platform-specific search criteria. Responses are intentionally constrained to support ranking, filtering, and selection at scale rather than full profile hydration.

Enrichment

Retrieve complete creator-level data once a candidate has been identified. Enrichment responses provide the depth required for analysis, activation, and downstream data workflows.

Execution modes

Enrichment is available in both synchronous and asynchronous forms. Single enrichment supports real-time use cases, while batch enrichment is optimized for high-throughput, non-interactive processing.

Typical usage

Discovery and enrichment are designed as complementary stages. Discovery narrows the candidate set; enrichment supplies detailed data for creators that have already been qualified.

Languages
Servers
Production
https://api-dashboard.influencers.club
Operations
Operations

Provides the complete set of supported filter values used by the Discovery and Similar Creators endpoints.

These endpoints return all valid, platform-specific values (such as languages, locations, brands, YouTube topics, and Twitch games) that can be used when constructing discovery queries.

Clients should retrieve dictionary values programmatically to ensure only supported values are sent in requests. Available values may vary by platform and can evolve over time.

Operations
Operations
Operations
Operations
Operations

Bulk enrichment jobs: create, check status, resume, and download results.

Operations

Request

Create a batch enrichment job by uploading a CSV.

How it works

  1. Upload a .csv file (one column: handle or email)
  2. Choose the enrichment mode (handle: raw/full, email: basic/advanced)
  3. Use the returned batch_id to check status and download results

Request

  • multipart/form-data
  • file: CSV (max 10MB)
  • Mode fields depend on whether you’re enriching by handle or email

Credits

  • Credits are deducted per successfully enriched record
  • The credit rate follows the corresponding single-enrichment mode (raw/full/basic/advanced)
  • If no data is returned for a record, 0 credits are deducted for that record
Security
Bearer
Bodymultipart/form-datarequired
filestring(binary)required

CSV file containing creators to enrich (max 10MB, single column: handle or email)

platformstring
Enum"instagram""youtube""tiktok""twitter""twitch""onlyfans"
enrichment_modestringrequired
Enum"raw""full""basic""advanced"
metadataobject or null

Optional metadata as JSON object (e.g., {"campaign": "Q4 Outreach"})

email_requiredstring
Enum"must_have""preferred"
include_lookalikesboolean

Include lookalike creators for handle-based full enrichment. Default: true

include_audience_databoolean

Include audience insights in the response. Available for Instagram, Tiktok and Youtube for the Enrich by handle full mode.

exclude_platformsstring
Enum"instagram""youtube""tiktok""twitter""twitch""onlyfans"
min_followersinteger
curl -i -X POST \
  https://api-dashboard.influencers.club/public/v1/enrichment/batch/ \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F file=string \
  -F platform=instagram \
  -F enrichment_mode=raw \
  -F 'metadata[property1]=null' \
  -F 'metadata[property2]=null' \
  -F email_required=must_have \
  -F include_lookalikes=true \
  -F include_audience_data=true \
  -F exclude_platforms=instagram \
  -F min_followers=0

Responses

Bodyapplication/json
batch_idstringrequired

Unique identifier for the batch enrichment job

statusstringrequired

Current status of the batch job (processing, finished, failed, validating)

created_atstring(date-time)required

Timestamp when the batch was created

platformstring or null

Platform used for enrichment (for handle-based enrichment)

metadataobject or null

Metadata provided with the batch

og_input_numberintegerrequired

Total number of records in the input file

type_reportstringrequired

Type of enrichment: ENRICH_BY_HANDLE or ENRICH_BY_EMAIL

enrichment_modestring or null

Enrichment mode: raw, full, basic, or advanced

messagestringrequired

Human-readable message about the batch status

Response
application/json
{ "batch_id": "string", "status": "string", "created_at": "2019-08-24T14:15:22Z", "platform": "string", "metadata": { "property1": null, "property2": null }, "og_input_number": 0, "type_report": "string", "enrichment_mode": "string", "message": "string" }

Request

Download the results for a completed batch enrichment job.

When to use

  • After the batch reaches a completed state in the status endpoint

Credits

  • 0 credits (download only)
Security
Bearer
Path
batch_idstringrequired

Unique batch identifier returned when creating the enrichment batch

Headers
Authorizationstringrequired

Bearer << Client JWT Token >>

curl -i -X GET \
  'https://api-dashboard.influencers.club/public/v1/enrichment/batch/{batch_id}/' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

CSV file with enriched results

Bodyapplication/json
string(binary)
Response
application/json
"string"

Request

Resume a paused or interrupted batch enrichment job.

When to use

  • If a batch was paused or failed mid-run and needs to continue processing

Credits

  • 0 credits to resume (credits apply only to successfully enriched records)
Security
Bearer
Path
batch_idstringrequired

Unique batch identifier returned when creating the enrichment batch

Headers
Authorizationstringrequired

Bearer << Client JWT Token >>

curl -i -X POST \
  'https://api-dashboard.influencers.club/public/v1/enrichment/batch/{batch_id}/resume/' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Batch resumed successfully

Bodyapplication/json
property name*anyadditional property
Response
application/json
{ "property1": null, "property2": null }
Operations

Account-level endpoints (credits, usage).

Operations