Played TTS history

TTS entries that finished playing, most recent first, cursor-paginated. Requires tts:read.

GET/tts/history

Authorization

AuthorizationBearer token (tp_live_... or tpat_...) · headerrequired

A TipPage API key (`tp_live_...`, created in Dashboard → Settings → Developer) or an OAuth 2.0 access token (`tpat_...`, see the OAuth guide). Both carry the same scopes and are accepted on every endpoint.

Query parameters

limitinteger

min 1 · max 100 · default: 25

beforestring

Cursor - an `order_id` from a previous page (`next_cursor`). Returns rows strictly older than it.

Responses

200One page of history.

tipsHistoryTip[]

Show properties

Array of HistoryTip

order_idstring

namestring

amountnumber | null

messagestring | null

tts_urlstring<uri> | null

is_replayboolean

is_sub_rewardboolean

sourcestring

Where the tip came from: `stripe`, `paypal`, `manual` (dashboard manual tip), `api` (POST /tips), `sub_reward`, `replay`, `test`, `ayupcc`, or `unknown` for tips older than source tracking.

external_sourcestring | null

Developer-API tips only - the `source` label the caller sent (`kofi`, `ayupcc`); `null` for every other source. Says where the tip came from, not whether money moved - see `is_paid`.

external_refstring | null

Developer-API tips only - the caller's own payment reference.

is_paidboolean

Real money changed hands (Stripe, PayPal, or a developer-API tip sent with `paid: true`). `false` for manual tips, free integration tips and sub rewards - those never count toward the streamer's totals.

platformstring | null

Platform of the signed-in donor

Allowed:twitchkicknull

platform_user_idstring | null

The donor's id on that platform

name_was_filteredboolean

message_was_filteredboolean

queued_atstring<date-time>

When the tip entered the queue.

played_atstring<date-time>

When it finished playing on stream.

has_moreboolean

next_cursorstring | null

Pass as `?before=` to fetch the next page.

400Unknown cursor.

errorstringrequired

Human-readable message.

codestring

Machine-readable code (e.g. `missing_scope`, `not_in_queue`).

401Missing or invalid credential (`missing_api_key` / `invalid_api_key`, or `invalid_token` for an expired/revoked OAuth access token).

errorstringrequired

Human-readable message.

codestring

Machine-readable code (e.g. `missing_scope`, `not_in_queue`).

403The key lacks the required scope (`missing_scope`).

errorstringrequired

Human-readable message.

codestring

Machine-readable code (e.g. `missing_scope`, `not_in_queue`).

required_scopestring

429Rate limit exceeded - check the `RateLimit-*` headers.

errorstring

Request

curl -X GET "https://api.tippage.com/v1/tts/history" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://api.tippage.com/v1/tts/history", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.tippage.com/v1/tts/history",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "tips": [
    {
      "order_id": "string",
      "name": "string",
      "amount": 0,
      "message": "string",
      "tts_url": "http://example.com",
      "is_replay": true,
      "is_sub_reward": true,
      "source": "string",
      "external_source": "string",
      "external_ref": "string",
      "is_paid": true,
      "platform": "twitch",
      "platform_user_id": "string",
      "name_was_filtered": true,
      "message_was_filtered": true,
      "queued_at": "2019-08-24T14:15:22Z",
      "played_at": "2019-08-24T14:15:22Z"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}