View raw JSON
{
"type": "object",
"required": [],
"properties": {
"body": {
"type": "object",
"title": "TikTok Scraper",
"properties": {
"keywords": {
"type": "array",
"title": "Search Keywords",
"editor": "stringList",
"prefill": [
"Artificial Intelligence",
"podcast"
],
"description": "Optional keyword-query list for finding matching TikTok posts. The prefilled terms are examples, not automatic search targets. Current use requires requesting at least 10 posts per query; choose a bounded output cap and do not assume URL inputs and keywords will be merged.",
"sectionCaption": "Query Builder for Search (Optional)",
"sectionDescription": "An easy way to build your search queries."
},
"location": {
"enum": [
"AF",
"AL",
"DZ",
"AS",
"AD",
"AO",
"AI",
"AQ",
"AG",
"AR",
"AM",
"AW",
"AU",
"AT",
"AZ",
"BS",
"BH",
"BD",
"BB",
"BY",
"BE",
"BZ",
"BJ",
"BM",
"BT",
"BO",
"BQ",
"BA",
"BW",
"BV",
"BR",
"IO",
"BN",
"BG",
"BF",
"BI",
"CV",
"KH",
"CM",
"CA",
"KY",
"CF",
"TD",
"CL",
"CN",
"CX",
"CC",
"CO",
"KM",
"CD",
"CG",
"CK",
"CR",
"HR",
"CU",
"CW",
"CY",
"CZ",
"CI",
"DK",
"DJ",
"DM",
"DO",
"EC",
"EG",
"SV",
"GQ",
"ER",
"EE",
"SZ",
"ET",
"FK",
"FO",
"FJ",
"FI",
"FR",
"GF",
"PF",
"TF",
"GA",
"GM",
"GE",
"DE",
"GH",
"GI",
"GR",
"GL",
"GD",
"GP",
"GU",
"GT",
"GG",
"GN",
"GW",
"GY",
"HT",
"HM",
"VA",
"HN",
"HK",
"HU",
"IS",
"IN",
"ID",
"IR",
"IQ",
"IE",
"IM",
"IL",
"IT",
"JM",
"JP",
"JE",
"JO",
"KZ",
"KE",
"KI",
"KP",
"KR",
"KW",
"KG",
"LA",
"LV",
"LB",
"LS",
"LR",
"LY",
"LI",
"LT",
"LU",
"MO",
"MG",
"MW",
"MY",
"MV",
"ML",
"MT",
"MH",
"MQ",
"MR",
"MU",
"YT",
"MX",
"FM",
"MD",
"MC",
"MN",
"ME",
"MS",
"MA",
"MZ",
"MM",
"NA",
"NR",
"NP",
"NL",
"NC",
"NZ",
"NI",
"NE",
"NG",
"NU",
"NF",
"MP",
"NO",
"OM",
"PK",
"PW",
"PS",
"PA",
"PG",
"PY",
"PE",
"PH",
"PN",
"PL",
"PT",
"PR",
"QA",
"MK",
"RO",
"RU",
"RW",
"RE",
"BL",
"SH",
"KN",
"LC",
"MF",
"PM",
"VC",
"WS",
"SM",
"ST",
"SA",
"SN",
"RS",
"SC",
"SL",
"SG",
"SX",
"SK",
"SI",
"SB",
"SO",
"ZA",
"GS",
"SS",
"ES",
"LK",
"SD",
"SR",
"SJ",
"SE",
"CH",
"SY",
"TW",
"TJ",
"TZ",
"TH",
"TL",
"TG",
"TK",
"TO",
"TT",
"TN",
"TR",
"TM",
"TC",
"TV",
"UG",
"UA",
"AE",
"GB",
"UM",
"US",
"UY",
"UZ",
"VU",
"VE",
"VN",
"VG",
"VI",
"WF",
"EH",
"YE",
"ZM",
"ZW",
"AX"
],
"type": "string",
"title": "Location / Region",
"editor": "select",
"prefill": "US",
"enumTitles": [
"Afghanistan",
"Albania",
"Algeria",
"American Samoa",
"Andorra",
"Angola",
"Anguilla",
"Antarctica",
"Antigua and Barbuda",
"Argentina",
"Armenia",
"Aruba",
"Australia",
"Austria",
"Azerbaijan",
"Bahamas (the)",
"Bahrain",
"Bangladesh",
"Barbados",
"Belarus",
"Belgium",
"Belize",
"Benin",
"Bermuda",
"Bhutan",
"Bolivia (Plurinational State of)",
"Bonaire, Sint Eustatius and Saba",
"Bosnia and Herzegovina",
"Botswana",
"Bouvet Island",
"Brazil",
"British Indian Ocean Territory (the)",
"Brunei Darussalam",
"Bulgaria",
"Burkina Faso",
"Burundi",
"Cabo Verde",
"Cambodia",
"Cameroon",
"Canada",
"Cayman Islands (the)",
"Central African Republic (the)",
"Chad",
"Chile",
"China",
"Christmas Island",
"Cocos (Keeling) Islands (the)",
"Colombia",
"Comoros (the)",
"Congo (the Democratic Republic of the)",
"Congo (the)",
"Cook Islands (the)",
"Costa Rica",
"Croatia",
"Cuba",
"Curaçao",
"Cyprus",
"Czechia",
"Côte d'Ivoire",
"Denmark",
"Djibouti",
"Dominica",
"Dominican Republic (the)",
"Ecuador",
"Egypt",
"El Salvador",
"Equatorial Guinea",
"Eritrea",
"Estonia",
"Eswatini",
"Ethiopia",
"Falkland Islands (the) [Malvinas]",
"Faroe Islands (the)",
"Fiji",
"Finland",
"France",
"French Guiana",
"French Polynesia",
"French Southern Territories (the)",
"Gabon",
"Gambia (the)",
"Georgia",
"Germany",
"Ghana",
"Gibraltar",
"Greece",
"Greenland",
"Grenada",
"Guadeloupe",
"Guam",
"Guatemala",
"Guernsey",
"Guinea",
"Guinea-Bissau",
"Guyana",
"Haiti",
"Heard Island and McDonald Islands",
"Holy See (the)",
"Honduras",
"Hong Kong",
"Hungary",
"Iceland",
"India",
"Indonesia",
"Iran (Islamic Republic of)",
"Iraq",
"Ireland",
"Isle of Man",
"Israel",
"Italy",
"Jamaica",
"Japan",
"Jersey",
"Jordan",
"Kazakhstan",
"Kenya",
"Kiribati",
"Korea (the Democratic People's Republic of)",
"Korea (the Republic of)",
"Kuwait",
"Kyrgyzstan",
"Lao People's Democratic Republic (the)",
"Latvia",
"Lebanon",
"Lesotho",
"Liberia",
"Libya",
"Liechtenstein",
"Lithuania",
"Luxembourg",
"Macao",
"Madagascar",
"Malawi",
"Malaysia",
"Maldives",
"Mali",
"Malta",
"Marshall Islands (the)",
"Martinique",
"Mauritania",
"Mauritius",
"Mayotte",
"Mexico",
"Micronesia (Federated States of)",
"Moldova (the Republic of)",
"Monaco",
"Mongolia",
"Montenegro",
"Montserrat",
"Morocco",
"Mozambique",
"Myanmar",
"Namibia",
"Nauru",
"Nepal",
"Netherlands (the)",
"New Caledonia",
"New Zealand",
"Nicaragua",
"Niger (the)",
"Nigeria",
"Niue",
"Norfolk Island",
"Northern Mariana Islands (the)",
"Norway",
"Oman",
"Pakistan",
"Palau",
"Palestine, State of",
"Panama",
"Papua New Guinea",
"Paraguay",
"Peru",
"Philippines (the)",
"Pitcairn",
"Poland",
"Portugal",
"Puerto Rico",
"Qatar",
"Republic of North Macedonia",
"Romania",
"Russian Federation (the)",
"Rwanda",
"Réunion",
"Saint Barthélemy",
"Saint Helena, Ascension and Tristan da Cunha",
"Saint Kitts and Nevis",
"Saint Lucia",
"Saint Martin (French part)",
"Saint Pierre and Miquelon",
"Saint Vincent and the Grenadines",
"Samoa",
"San Marino",
"Sao Tome and Principe",
"Saudi Arabia",
"Senegal",
"Serbia",
"Seychelles",
"Sierra Leone",
"Singapore",
"Sint Maarten (Dutch part)",
"Slovakia",
"Slovenia",
"Solomon Islands",
"Somalia",
"South Africa",
"South Georgia and the South Sandwich Islands",
"South Sudan",
"Spain",
"Sri Lanka",
"Sudan (the)",
"Suriname",
"Svalbard and Jan Mayen",
"Sweden",
"Switzerland",
"Syrian Arab Republic",
"Taiwan (Province of China)",
"Tajikistan",
"Tanzania, United Republic of",
"Thailand",
"Timor-Leste",
"Togo",
"Tokelau",
"Tonga",
"Trinidad and Tobago",
"Tunisia",
"Turkey",
"Turkmenistan",
"Turks and Caicos Islands (the)",
"Tuvalu",
"Uganda",
"Ukraine",
"United Arab Emirates (the)",
"United Kingdom of Great Britain and Northern Ireland (the)",
"United States Minor Outlying Islands (the)",
"United States of America (the)",
"Uruguay",
"Uzbekistan",
"Vanuatu",
"Venezuela (Bolivarian Republic of)",
"Viet Nam",
"Virgin Islands (British)",
"Virgin Islands (U.S.)",
"Wallis and Futuna",
"Western Sahara",
"Yemen",
"Zambia",
"Zimbabwe",
"Åland Islands"
],
"description": "Requests results from the selected ISO 3166-1 two-letter country code, such as US, GB or DE. US is prefilled, not an automatic default; omit this setting if no region is requested. It does not verify a creator's residence, nationality or the precise location of each post."
},
"maxItems": {
"type": "integer",
"title": "Maximum number of items on output",
"editor": "number",
"prefill": 1000,
"description": "Maximum output-post count across the request, not a per-URL quota. The prefilled 1000 is an example, not an automatic default; omitting a cap leaves available collection unbounded at the service. Current use requires at least 10 posts per query or collection URL, but a requested cap does not guarantee that many posts will be returned."
},
"sortType": {
"enum": [
"RELEVANCE",
"MOST_LIKED",
"DATE_POSTED"
],
"type": "string",
"title": "Sort Type",
"editor": "select",
"prefill": "RELEVANCE",
"enumTitles": [
"Relevance",
"Most Liked",
"Date Posted"
],
"description": "Keyword-only sorting: RELEVANCE, MOST_LIKED or DATE_POSTED. The service normally uses RELEVANCE, which is also prefilled. This setting does not apply to start URLs, including a search-page URL, and does not guarantee a globally newest or most-liked collection."
},
"dateRange": {
"enum": [
"DEFAULT",
"ALL_TIME",
"YESTERDAY",
"THIS_WEEK",
"THIS_MONTH",
"LAST_THREE_MONTHS",
"LAST_SIX_MONTHS"
],
"type": "string",
"title": "Date Range (Only works in Search)",
"editor": "select",
"prefill": "DEFAULT",
"enumTitles": [
"Default",
"All Time",
"Yesterday",
"This Week",
"This Month",
"Last Three Months",
"Last Six Months"
],
"description": "Optional TikTok search-date choice: DEFAULT, ALL_TIME, YESTERDAY, THIS_WEEK, THIS_MONTH, LAST_THREE_MONTHS or LAST_SIX_MONTHS. DEFAULT is prefilled; its precise time span is not specified. These are platform search filters, not a general archive control, and ALL_TIME does not guarantee all historical posts. Exact timezone and date edges are not guaranteed."
},
"startUrls": {
"type": "array",
"title": "Start URLs",
"editor": "stringList",
"prefill": [
"https://www.tiktok.com/@billieeilish/video/7050551461734042926",
"https://www.tiktok.com/@rabbitbrandmy/photo/7553874290735729940",
"https://www.tiktok.com/@gordonramsayofficial",
"https://www.tiktok.com/search?q=Recipes",
"https://www.tiktok.com/tag/duet",
"https://www.tiktok.com/music/original-sound-Newcastle-United-7297730198175402784",
"https://www.tiktok.com/place/New-York-22535796481546927"
],
"description": "List of full TikTok profile, hashtag/tag, music, place/location or search-page URLs. Current use excludes individual post URLs and requires requesting at least 10 posts per collection URL. Select eligible collection entries for your request; the form's prefilled links do not imply every displayed single-post link can be used."
},
"customMapFunction": {
"type": "string",
"title": "Custom map function",
"editor": "javascript",
"prefill": "(object) => { return {...object} }",
"nullable": true,
"description": "Optional function that maps each returned record to transformed output. It is not a filter; omit it to retain standard unmapped records. The prefilled identity function is an example, not a required processing step.",
"sectionCaption": "Advanced Options",
"sectionDescription": "The section where you can tweak your output in an advanced way."
},
"includeSearchKeywords": {
"type": "boolean",
"title": "Include Search Keywords",
"editor": "checkbox",
"description": "Optional annotation of the keyword query that found a post, normally off at the service. It adds context to keyword-search results; it does not run another query, broaden the request or enable URL-to-keyword fallback."
}
},
"description": "Optional settings for collecting accessible post records. Choose an eligible collection URL or keyword queries; usable input is needed even though these settings are optional. Current use excludes single-post URLs and requires requesting at least 10 posts per query or collection URL, without guaranteeing 10 available results.",
"schemaVersion": 1
}
},
"additionalProperties": false
}
