{
  "openapi": "3.0.1",
  "info": {
    "title": "Tiktok Livestream Scraper",
    "description": "Extract livestream data, including chat, gifts, battles, likes, emotes, questions, members, envelopes, subscriptions, and sharing. Optimize your TikTok presence and engagement with ease. Perfect for data-driven decisions and maximizing your livestream potential.",
    "version": "0.0",
    "x-build-id": "ReeCBG1jtc3ee8Kpw"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/matyas~tiktok-livestream-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-matyas-tiktok-livestream-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/matyas~tiktok-livestream-scraper/runs": {
      "post": {
        "operationId": "runs-sync-matyas-tiktok-livestream-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/matyas~tiktok-livestream-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-matyas-tiktok-livestream-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "required": [
          "usernames"
        ],
        "properties": {
          "usernames": {
            "title": "Usernames of Livestreamers",
            "type": "array",
            "description": "List of usernames whose livestreams should be scraped.",
            "items": {
              "type": "string"
            }
          },
          "event_chat": {
            "title": "Chats",
            "type": "boolean",
            "description": "When set to true, the scraper will record all chat messages from the TikTok livestream.",
            "default": true
          },
          "event_gift": {
            "title": "Gifts",
            "type": "boolean",
            "description": "When set to true, the scraper will record all gifts given during the livestream.",
            "default": false
          },
          "event_member": {
            "title": "New user",
            "type": "boolean",
            "description": "When set to true, the scraper will record when a new user joins the livestream.",
            "default": false
          },
          "event_follow": {
            "title": "Follow",
            "type": "boolean",
            "description": "When set to true, the scraper will record when a user starts following the streamer.",
            "default": false
          },
          "event_share": {
            "title": "Shares",
            "type": "boolean",
            "description": "When set to true, the scraper will record when the livestream is shared using the share button.",
            "default": false
          },
          "event_like": {
            "title": "Likes",
            "type": "boolean",
            "description": "When set to true, the scraper will record when the livestream receives a like.",
            "default": false
          },
          "event_subscribe": {
            "title": "Subscriptions",
            "type": "boolean",
            "description": "When set to true, the scraper will record when a user subscribes to the streamer.",
            "default": false
          },
          "event_roomUser": {
            "title": "Viewer count",
            "type": "boolean",
            "description": "When set to true, the scraper will record when viewer count arrives.",
            "default": false
          },
          "event_emote": {
            "title": "Emotes",
            "type": "boolean",
            "description": "When set to true, the scraper will record when a user sends a emote (sticker).",
            "default": false
          },
          "event_envelope": {
            "title": "Envelope",
            "type": "boolean",
            "description": "When set to true, the scraper will record when a user sends a tresure chest.",
            "default": false
          },
          "event_questionNew": {
            "title": "Questions",
            "type": "boolean",
            "description": "When set to true, the scraper will record when a user sends a new question via the question feature.",
            "default": false
          },
          "event_liveIntro": {
            "title": "Intro",
            "type": "boolean",
            "description": "When set to true, the scraper will record when a stream sends intro message.",
            "default": false
          },
          "event_status": {
            "title": "Status",
            "type": "boolean",
            "description": "When set to true, the scraper will send important events about livestream like creation and end of livestream",
            "default": true
          },
          "event_linkMicBattle": {
            "title": "Gift battle start",
            "type": "boolean",
            "description": "When set to true, the scraper will record when battle starts.",
            "default": false
          },
          "event_linkMicArmies": {
            "title": "Gift battle stats",
            "type": "boolean",
            "description": "When set to true, the scraper will record when a TikTok sends a battle stats (fye. number of gifts on each side)",
            "default": false
          },
          "event_connected": {
            "title": "Connected event",
            "type": "boolean",
            "description": "When set to true, the scraper will record 'connected' event which TikTok sends.",
            "default": false
          },
          "event_disconnected": {
            "title": "Disconnected event",
            "type": "boolean",
            "description": "When set to true, the scraper will record 'disconnected' event which TikTok sends.",
            "default": false
          },
          "event_streamEnd": {
            "title": "StreamEnd event",
            "type": "boolean",
            "description": "When set to true, the scraper will record 'streamEnd' event which TikTok sends.",
            "default": false
          },
          "end_allStreamsEnds": {
            "title": "Stop Scraper When none of the livestreams is running",
            "type": "boolean",
            "description": "When enabled, the scraper will stop when no livestream is active. If disabled, it will keep running and wait for a livestream to start.",
            "default": true
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Select proxies to be used by your scraper."
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}