FansquareAPI reference
Open the app

Analytics

Get the revenue summary

GET/v1/analytics/revenue

Net revenue over the window, split by order type. Same numbers as the Fansquare dashboard: EUR cents, affiliate revenue under affiliation.

Required scoperead:analytics
Rate limit20 requests per minute
curl 'https://api.fansquare.so/v1/analytics/revenue?start=2026-09-01&end=2026-09-30&timezone=Europe%2FParis' \
  -H "Authorization: Bearer $API_KEY" \
  -H "Fansquare-Version: Amethyste"
{
  "total": 1284000,
  "currency": "EUR",
  "by_type": {
    "tip": 312000,
    "subscription": 420000,
    "subscription_renewal": 238000,
    "booking": 0,
    "push": 214000,
    "mod": 0,
    "fan_to_creator": 100000,
    "creator_to_fan": 0,
    "affiliate": 0,
    "affiliation": 0
  }
}

Parameters

Headers

  • Fansquare-Versionstringrequired

    API version to pin. Accepts the mineral name or the release date of a version.

Query

  • startstringrequired

    First day of the window (inclusive), e.g. 2026-07-01. Interpreted in timezone. A date-time is accepted too and floored to its local day.

  • endstringrequired

    Last day of the window (inclusive: the whole day is covered), e.g. 2026-07-31. Interpreted in timezone. The window cannot exceed 365 days (and less for the finer bucket sizes of the timeseries endpoint); fetch older history with additional requests.

  • timezonestring

    IANA timezone the window and buckets are computed in, canonical Area/Location form (e.g. Europe/Paris). Abbreviations like CET are rejected. Defaults to UTC.

  • creator_idsstring

    Restrict to these creators (Fansquare ids from GET /v1/creators). Omit for every creator the key can see. Comma-separated, 50 max.

Response

OK, application/json

  • totalintegerrequired

    Total net revenue over the window, EUR cents.

  • currency"EUR"required
  • by_typeobjectrequired

    Net revenue in EUR cents per order type, every type present and zero-filled (affiliate revenue is grouped under affiliation).

    • tipintegerrequired
    • subscriptionintegerrequired
    • subscription_renewalintegerrequired
    • bookingintegerrequired
    • pushintegerrequired
    • modintegerrequired
    • fan_to_creatorintegerrequired
    • creator_to_fanintegerrequired
    • affiliateintegerrequired
    • affiliationintegerrequired
curl 'https://api.fansquare.so/v1/analytics/revenue?start=2026-09-01&end=2026-09-30&timezone=Europe%2FParis' \
  -H "Authorization: Bearer $API_KEY" \
  -H "Fansquare-Version: Amethyste"
{
  "total": 1284000,
  "currency": "EUR",
  "by_type": {
    "tip": 312000,
    "subscription": 420000,
    "subscription_renewal": 238000,
    "booking": 0,
    "push": 214000,
    "mod": 0,
    "fan_to_creator": 100000,
    "creator_to_fan": 0,
    "affiliate": 0,
    "affiliation": 0
  }
}