@crawlora-org/sdk 1.47.0-sdk.1 → 1.47.1-sdk.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +6 -0
- package/docs/operations.md +2 -2
- package/openapi/public.json +261 -79
- package/package.json +1 -1
- package/src/client.js +1 -1
- package/src/operations.js +35 -0
- package/src/types.d.ts +29 -3
package/openapi/public.json
CHANGED
|
@@ -14313,6 +14313,10 @@
|
|
|
14313
14313
|
"name": {
|
|
14314
14314
|
"type": "string"
|
|
14315
14315
|
},
|
|
14316
|
+
"notice": {
|
|
14317
|
+
"example": "This business profile is under review.",
|
|
14318
|
+
"type": "string"
|
|
14319
|
+
},
|
|
14316
14320
|
"phone": {
|
|
14317
14321
|
"type": "string"
|
|
14318
14322
|
},
|
|
@@ -14322,6 +14326,10 @@
|
|
|
14322
14326
|
},
|
|
14323
14327
|
"type": "array"
|
|
14324
14328
|
},
|
|
14329
|
+
"profile_under_review": {
|
|
14330
|
+
"description": "ProfileUnderReview is true when BBB is updating the profile. The page\nthen shows \"This business profile is under review.\" (Notice) in place\nof the rating and accreditation, so Rating is \"NR\", RatingReasons holds\nBBB's sentence saying why, and \"accredited\" is left out of the JSON:\nthe page does not say, and false would be a claim BBB is not making.\nSeen live 2026-10-12. The state is BBB's and lasts until the review\nends, so asking again returns the same answer.",
|
|
14331
|
+
"type": "boolean"
|
|
14332
|
+
},
|
|
14325
14333
|
"rating": {
|
|
14326
14334
|
"example": "A+",
|
|
14327
14335
|
"type": "string"
|
|
@@ -14520,6 +14528,10 @@
|
|
|
14520
14528
|
"example": 408,
|
|
14521
14529
|
"type": "integer"
|
|
14522
14530
|
},
|
|
14531
|
+
"notice": {
|
|
14532
|
+
"example": "This profile is currently being updated. You will not be able to read any existing complaints at this time, but you may file a complaint.",
|
|
14533
|
+
"type": "string"
|
|
14534
|
+
},
|
|
14523
14535
|
"page": {
|
|
14524
14536
|
"description": "Page is the page of the complaint list this response holds. TotalPages\nis the last page BBB's own pager links to; it is omitted when BBB\nrenders no list (no complaints, or a page past the end). BBB lists\nfewer complaints than TotalComplaints counts, so TotalPages can be\nsmaller than TotalComplaints/10. HasMore is true while Page is before\nTotalPages.",
|
|
14525
14537
|
"example": 1,
|
|
@@ -14529,6 +14541,10 @@
|
|
|
14529
14541
|
"example": "in the last 3 years.",
|
|
14530
14542
|
"type": "string"
|
|
14531
14543
|
},
|
|
14544
|
+
"profile_under_review": {
|
|
14545
|
+
"description": "ProfileUnderReview is true when BBB is updating the profile and has\ntaken the complaint summary and list off the page for the duration.\nNotice is BBB's own sentence saying so. TotalComplaints and\nClosedLast12Months then come from the counts BBB still embeds in the\npage and stay zero when it embeds none; Complaints is empty and\nComplaintsListIncomplete is true. Seen live 2026-10-12; the state is\nBBB's, so asking again returns the same answer until the review ends.",
|
|
14546
|
+
"type": "boolean"
|
|
14547
|
+
},
|
|
14532
14548
|
"published_complaints": {
|
|
14533
14549
|
"description": "PublishedComplaints is how many complaints BBB publishes details for,\nthe ones the pages list. HiddenComplaints is how many it counts in\nTotalComplaints without publishing them. Both come from the page's\nembedded state and are left out when it does not carry them.",
|
|
14534
14550
|
"example": 3778,
|
|
@@ -14977,6 +14993,11 @@
|
|
|
14977
14993
|
"example": "BBB Heart of Texas",
|
|
14978
14994
|
"type": "string"
|
|
14979
14995
|
},
|
|
14996
|
+
"news_url": {
|
|
14997
|
+
"description": "The chapter's own newsroom; pass it to bbb-news or bbb-news-topics.",
|
|
14998
|
+
"example": "https://www.bbb.org/local-bbb/bbb-serving-the-heart-of-texas/news",
|
|
14999
|
+
"type": "string"
|
|
15000
|
+
},
|
|
14980
15001
|
"offices": {
|
|
14981
15002
|
"items": {
|
|
14982
15003
|
"$ref": "#/definitions/bbbdirectory.Office"
|
|
@@ -15023,6 +15044,11 @@
|
|
|
15023
15044
|
"example": "BBB Heart of Texas",
|
|
15024
15045
|
"type": "string"
|
|
15025
15046
|
},
|
|
15047
|
+
"news_url": {
|
|
15048
|
+
"description": "The chapter's own newsroom; pass it to bbb-news or bbb-news-topics.",
|
|
15049
|
+
"example": "https://www.bbb.org/local-bbb/bbb-serving-the-heart-of-texas/news",
|
|
15050
|
+
"type": "string"
|
|
15051
|
+
},
|
|
15026
15052
|
"offices": {
|
|
15027
15053
|
"items": {
|
|
15028
15054
|
"$ref": "#/definitions/bbbdirectory.Office"
|
|
@@ -15325,6 +15351,8 @@
|
|
|
15325
15351
|
"type": "string"
|
|
15326
15352
|
},
|
|
15327
15353
|
"id": {
|
|
15354
|
+
"description": "BBB's id of the story or event.",
|
|
15355
|
+
"example": "32431",
|
|
15328
15356
|
"type": "string"
|
|
15329
15357
|
},
|
|
15330
15358
|
"image": {
|
|
@@ -15340,6 +15368,8 @@
|
|
|
15340
15368
|
"type": "string"
|
|
15341
15369
|
},
|
|
15342
15370
|
"type": {
|
|
15371
|
+
"description": "BBB's content type: Article for a story, or an event type for a record that carries event_start_date.",
|
|
15372
|
+
"example": "Article",
|
|
15343
15373
|
"type": "string"
|
|
15344
15374
|
},
|
|
15345
15375
|
"url": {
|
|
@@ -15350,28 +15380,64 @@
|
|
|
15350
15380
|
},
|
|
15351
15381
|
"bbbnews.NewsResponse": {
|
|
15352
15382
|
"properties": {
|
|
15383
|
+
"city": {
|
|
15384
|
+
"description": "City slug; present for a city URL.",
|
|
15385
|
+
"example": "san-francisco",
|
|
15386
|
+
"type": "string"
|
|
15387
|
+
},
|
|
15353
15388
|
"country": {
|
|
15389
|
+
"description": "Country of the newsroom: us or ca.",
|
|
15390
|
+
"enum": [
|
|
15391
|
+
"us",
|
|
15392
|
+
"ca"
|
|
15393
|
+
],
|
|
15394
|
+
"example": "us",
|
|
15354
15395
|
"type": "string"
|
|
15355
15396
|
},
|
|
15356
15397
|
"items": {
|
|
15398
|
+
"description": "The stories on this page, in BBB's order.",
|
|
15357
15399
|
"items": {
|
|
15358
15400
|
"$ref": "#/definitions/bbbnews.NewsItem"
|
|
15359
15401
|
},
|
|
15360
15402
|
"type": "array"
|
|
15361
15403
|
},
|
|
15404
|
+
"local_bbb_id": {
|
|
15405
|
+
"description": "Id of the local BBB chapter; present for a chapter URL.",
|
|
15406
|
+
"example": "1116",
|
|
15407
|
+
"type": "string"
|
|
15408
|
+
},
|
|
15409
|
+
"local_bbb_name": {
|
|
15410
|
+
"description": "Name of the local BBB chapter; present for a chapter URL.",
|
|
15411
|
+
"type": "string"
|
|
15412
|
+
},
|
|
15362
15413
|
"page": {
|
|
15414
|
+
"description": "Page number that was returned, 1-based.",
|
|
15415
|
+
"example": 2,
|
|
15363
15416
|
"type": "integer"
|
|
15364
15417
|
},
|
|
15365
15418
|
"page_size": {
|
|
15419
|
+
"description": "BBB's page size. A page can hold fewer items than this with more pages after it.",
|
|
15420
|
+
"example": 10,
|
|
15366
15421
|
"type": "integer"
|
|
15367
15422
|
},
|
|
15368
15423
|
"source_url": {
|
|
15424
|
+
"description": "The newsroom URL that was read, page query included.",
|
|
15425
|
+
"example": "https://www.bbb.org/us/news/scams?page=2",
|
|
15426
|
+
"type": "string"
|
|
15427
|
+
},
|
|
15428
|
+
"state": {
|
|
15429
|
+
"description": "Two-letter state or province code; present for a state or city URL.",
|
|
15430
|
+
"example": "ca",
|
|
15369
15431
|
"type": "string"
|
|
15370
15432
|
},
|
|
15371
15433
|
"topic": {
|
|
15434
|
+
"description": "Topic name; present for a topic URL.",
|
|
15435
|
+
"example": "Scams",
|
|
15372
15436
|
"type": "string"
|
|
15373
15437
|
},
|
|
15374
15438
|
"total": {
|
|
15439
|
+
"description": "Number of stories in the list across all pages.",
|
|
15440
|
+
"example": 279,
|
|
15375
15441
|
"type": "integer"
|
|
15376
15442
|
}
|
|
15377
15443
|
},
|
|
@@ -15380,12 +15446,18 @@
|
|
|
15380
15446
|
"bbbnews.Topic": {
|
|
15381
15447
|
"properties": {
|
|
15382
15448
|
"name": {
|
|
15449
|
+
"description": "Topic name as BBB shows it.",
|
|
15450
|
+
"example": "Scams",
|
|
15383
15451
|
"type": "string"
|
|
15384
15452
|
},
|
|
15385
15453
|
"slug": {
|
|
15454
|
+
"description": "Topic path segment.",
|
|
15455
|
+
"example": "scams",
|
|
15386
15456
|
"type": "string"
|
|
15387
15457
|
},
|
|
15388
15458
|
"url": {
|
|
15459
|
+
"description": "Newsroom URL of the topic in the requested scope; pass it to bbb-news.",
|
|
15460
|
+
"example": "https://www.bbb.org/us/news/scams",
|
|
15389
15461
|
"type": "string"
|
|
15390
15462
|
}
|
|
15391
15463
|
},
|
|
@@ -15393,13 +15465,41 @@
|
|
|
15393
15465
|
},
|
|
15394
15466
|
"bbbnews.TopicsResponse": {
|
|
15395
15467
|
"properties": {
|
|
15468
|
+
"city": {
|
|
15469
|
+
"description": "City slug; present for a city URL.",
|
|
15470
|
+
"example": "san-francisco",
|
|
15471
|
+
"type": "string"
|
|
15472
|
+
},
|
|
15396
15473
|
"country": {
|
|
15474
|
+
"description": "Country of the newsroom: us or ca.",
|
|
15475
|
+
"enum": [
|
|
15476
|
+
"us",
|
|
15477
|
+
"ca"
|
|
15478
|
+
],
|
|
15479
|
+
"example": "us",
|
|
15480
|
+
"type": "string"
|
|
15481
|
+
},
|
|
15482
|
+
"local_bbb_id": {
|
|
15483
|
+
"description": "Id of the local BBB chapter; present for a chapter URL.",
|
|
15484
|
+
"example": "1116",
|
|
15485
|
+
"type": "string"
|
|
15486
|
+
},
|
|
15487
|
+
"local_bbb_name": {
|
|
15488
|
+
"description": "Name of the local BBB chapter; present for a chapter URL.",
|
|
15397
15489
|
"type": "string"
|
|
15398
15490
|
},
|
|
15399
15491
|
"source_url": {
|
|
15492
|
+
"description": "The newsroom URL that was read.",
|
|
15493
|
+
"example": "https://www.bbb.org/us/news",
|
|
15494
|
+
"type": "string"
|
|
15495
|
+
},
|
|
15496
|
+
"state": {
|
|
15497
|
+
"description": "Two-letter state or province code; present for a state or city URL.",
|
|
15498
|
+
"example": "ca",
|
|
15400
15499
|
"type": "string"
|
|
15401
15500
|
},
|
|
15402
15501
|
"topics": {
|
|
15502
|
+
"description": "Every topic the page lists, in name order, the active one included.",
|
|
15403
15503
|
"items": {
|
|
15404
15504
|
"$ref": "#/definitions/bbbnews.Topic"
|
|
15405
15505
|
},
|
|
@@ -41270,16 +41370,55 @@
|
|
|
41270
41370
|
"datasets.BBBBusinessesFacetResponse": {
|
|
41271
41371
|
"properties": {
|
|
41272
41372
|
"dataset": {
|
|
41373
|
+
"description": "Dataset id, always bbb-businesses.",
|
|
41374
|
+
"example": "bbb-businesses",
|
|
41273
41375
|
"type": "string"
|
|
41274
41376
|
},
|
|
41275
41377
|
"facet": {
|
|
41378
|
+
"description": "The facet that was aggregated, as requested.",
|
|
41379
|
+
"example": "city",
|
|
41276
41380
|
"type": "string"
|
|
41277
41381
|
},
|
|
41382
|
+
"has_more": {
|
|
41383
|
+
"description": "True while another page exists; request offset + limit next.",
|
|
41384
|
+
"example": true,
|
|
41385
|
+
"type": "boolean"
|
|
41386
|
+
},
|
|
41278
41387
|
"items": {
|
|
41388
|
+
"description": "One page of values, most frequent first, ties in value order.",
|
|
41279
41389
|
"items": {
|
|
41280
41390
|
"$ref": "#/definitions/es.BBBBusinessesFacetItem"
|
|
41281
41391
|
},
|
|
41282
41392
|
"type": "array"
|
|
41393
|
+
},
|
|
41394
|
+
"limit": {
|
|
41395
|
+
"description": "Values per page that was applied.",
|
|
41396
|
+
"example": 50,
|
|
41397
|
+
"type": "integer"
|
|
41398
|
+
},
|
|
41399
|
+
"missing": {
|
|
41400
|
+
"description": "Number of matching records that have no value for this facet.",
|
|
41401
|
+
"example": 0,
|
|
41402
|
+
"type": "integer"
|
|
41403
|
+
},
|
|
41404
|
+
"offset": {
|
|
41405
|
+
"description": "Number of values skipped.",
|
|
41406
|
+
"example": 0,
|
|
41407
|
+
"type": "integer"
|
|
41408
|
+
},
|
|
41409
|
+
"total": {
|
|
41410
|
+
"description": "Number of records matching the filters.",
|
|
41411
|
+
"example": 44730,
|
|
41412
|
+
"type": "integer"
|
|
41413
|
+
},
|
|
41414
|
+
"total_values": {
|
|
41415
|
+
"description": "Number of distinct values of the facet across all pages.",
|
|
41416
|
+
"example": 1128,
|
|
41417
|
+
"type": "integer"
|
|
41418
|
+
},
|
|
41419
|
+
"values_truncated": {
|
|
41420
|
+
"description": "Present and true only when the facet has more than 10000 values, the furthest offset can reach; add a filter such as state to split it. total_values is then an estimate.",
|
|
41421
|
+
"type": "boolean"
|
|
41283
41422
|
}
|
|
41284
41423
|
},
|
|
41285
41424
|
"type": "object"
|
|
@@ -53246,9 +53385,13 @@
|
|
|
53246
53385
|
"es.BBBBusinessesFacetItem": {
|
|
53247
53386
|
"properties": {
|
|
53248
53387
|
"count": {
|
|
53388
|
+
"description": "Number of matching records with this value.",
|
|
53389
|
+
"example": 3438,
|
|
53249
53390
|
"type": "integer"
|
|
53250
53391
|
},
|
|
53251
53392
|
"value": {
|
|
53393
|
+
"description": "The facet value, to use as the matching search or facet filter. For the accredited and has_alerts facets it is 1 (true) or 0 (false).",
|
|
53394
|
+
"example": "san-diego",
|
|
53252
53395
|
"type": "string"
|
|
53253
53396
|
}
|
|
53254
53397
|
},
|
|
@@ -240877,7 +241020,7 @@
|
|
|
240877
241020
|
},
|
|
240878
241021
|
"/bbb/article": {
|
|
240879
241022
|
"get": {
|
|
240880
|
-
"description": "Returns published BBB article metadata, author names, body text, and useful links from a canonical public article URL.",
|
|
241023
|
+
"description": "Returns published BBB article metadata, author names, body text, and useful links from a canonical public article URL. Returns 404 when BBB no longer has the article, including a story BBB has moved to one of its evergreen pages under /all/; the error then names the new address, and the answer is permanent.",
|
|
240881
241024
|
"operationId": "bbb-article",
|
|
240882
241025
|
"parameters": [
|
|
240883
241026
|
{
|
|
@@ -241013,7 +241156,7 @@
|
|
|
241013
241156
|
"operationId": "bbb-business-complaints",
|
|
241014
241157
|
"parameters": [
|
|
241015
241158
|
{
|
|
241016
|
-
"description": "BBB business profile URL, from a bbb-search result's url or hq_profile_url",
|
|
241159
|
+
"description": "BBB business profile URL, from a bbb-search result's url or hq_profile_url. A location URL ending in /addressId/<number> is accepted and read from the business profile",
|
|
241017
241160
|
"in": "query",
|
|
241018
241161
|
"name": "url",
|
|
241019
241162
|
"required": true,
|
|
@@ -241085,7 +241228,7 @@
|
|
|
241085
241228
|
"operationId": "bbb-business-more-info",
|
|
241086
241229
|
"parameters": [
|
|
241087
241230
|
{
|
|
241088
|
-
"description": "BBB business profile URL, from a bbb-search result's url or hq_profile_url",
|
|
241231
|
+
"description": "BBB business profile URL, from a bbb-search result's url or hq_profile_url. A location URL ending in /addressId/<number> is accepted and read from the business profile",
|
|
241089
241232
|
"in": "query",
|
|
241090
241233
|
"name": "url",
|
|
241091
241234
|
"required": true,
|
|
@@ -241148,7 +241291,7 @@
|
|
|
241148
241291
|
"operationId": "bbb-business-reviews",
|
|
241149
241292
|
"parameters": [
|
|
241150
241293
|
{
|
|
241151
|
-
"description": "BBB business profile URL, from a bbb-search result's url or hq_profile_url",
|
|
241294
|
+
"description": "BBB business profile URL, from a bbb-search result's url or hq_profile_url. A location URL ending in /addressId/<number> is accepted and read from the business profile",
|
|
241152
241295
|
"in": "query",
|
|
241153
241296
|
"name": "url",
|
|
241154
241297
|
"required": true,
|
|
@@ -241480,11 +241623,11 @@
|
|
|
241480
241623
|
},
|
|
241481
241624
|
"/bbb/news": {
|
|
241482
241625
|
"get": {
|
|
241483
|
-
"description": "Returns one page of public BBB newsroom stories from a canonical US or Canada newsroom URL. Event dates and links are preserved when present.",
|
|
241626
|
+
"description": "Returns one page of public BBB newsroom stories from a canonical BBB newsroom URL. Three scopes are accepted, each with an optional topic: the US or Canada newsroom (/us/news), a state, province or city newsroom (/us/ca/news, /us/ca/san-francisco/news), and one local BBB chapter's own newsroom (/local-bbb/<chapter>/news, the news_url returned by bbb-local-bbbs and bbb-local-bbb). The list is whatever BBB shows on that page: a city or chapter whose local BBB publishes its own stories returns those, and other cities, other chapters and the state pages checked so far return the same list as the country newsroom, so compare total and the first items with the country newsroom before treating a list as local. A chapter URL also returns local_bbb_id and local_bbb_name. Event dates and links are preserved when present.",
|
|
241484
241627
|
"operationId": "bbb-news",
|
|
241485
241628
|
"parameters": [
|
|
241486
241629
|
{
|
|
241487
|
-
"description": "Canonical
|
|
241630
|
+
"description": "Canonical https://www.bbb.org newsroom URL: /us/news or /ca/news; /<country>/<state>/news or /<country>/<state>/<city>/news with country us or ca, the two-letter region code from bbb-regions and the city slug from a business profile URL; or a chapter's news_url from bbb-local-bbbs. Append a topic segment from bbb-news-topics to narrow it and ?page=N (1 to 1000) to page; no other query key is accepted",
|
|
241488
241631
|
"in": "query",
|
|
241489
241632
|
"name": "url",
|
|
241490
241633
|
"required": true,
|
|
@@ -241546,11 +241689,11 @@
|
|
|
241546
241689
|
},
|
|
241547
241690
|
"/bbb/news/topics": {
|
|
241548
241691
|
"get": {
|
|
241549
|
-
"description": "Returns the complete topic navigation shown by a US or Canada BBB newsroom
|
|
241692
|
+
"description": "Returns the complete topic navigation shown by a BBB newsroom page, including its active topic. The page can be the US or Canada newsroom, a state, province or city newsroom, or one local BBB chapter's newsroom; the returned topic URLs stay in that scope, and a chapter has its own topic set.",
|
|
241550
241693
|
"operationId": "bbb-news-topics",
|
|
241551
241694
|
"parameters": [
|
|
241552
241695
|
{
|
|
241553
|
-
"description": "Canonical
|
|
241696
|
+
"description": "Canonical https://www.bbb.org newsroom URL, optionally with a topic segment: /us/news or /ca/news; /<country>/<state>/news or /<country>/<state>/<city>/news with country us or ca, the two-letter region code from bbb-regions and the city slug from a business profile URL; or a chapter's news_url from bbb-local-bbbs",
|
|
241554
241697
|
"in": "query",
|
|
241555
241698
|
"name": "url",
|
|
241556
241699
|
"required": true,
|
|
@@ -270278,7 +270421,7 @@
|
|
|
270278
270421
|
"consumes": [
|
|
270279
270422
|
"application/json"
|
|
270280
270423
|
],
|
|
270281
|
-
"description": "Returns aggregate Airbnb short-term-rental market rollups from the dataset id enum value `airbnb-markets`. Aggregate-only: each row is a market cell, never an individual listing. Thin cells are suppressed. group_by enum: `country`, `market`, `admin1` (top subdivision), `locality` (settlement), `room_type` (`entire_place`/`private_room`/`hotel`/`shared_room`), `property_type` (Airbnb's canonical listing type from the detail page). `admin1`, `locality`, `room_type` and `property_type` are enrichment-derived and stay empty until their coverage is high enough to be reliable. Each cell also carries `median_price_usd`, the median nightly price converted to USD via an approximate dated FX snapshot, for cross-country comparison (combine with `group_by=room_type` for median price by room type); `guest_favorite_pct`, the share of listings carrying the Guest Favorite badge (an observed lower bound, like `superhost_pct`); and `avg_person_capacity`, the average guests a listing sleeps over the detail-page-enriched sample. Sort enum: `listings_desc`, `superhost_pct_desc`, `rating_desc`, `key_asc`.",
|
|
270424
|
+
"description": "Returns aggregate Airbnb short-term-rental market rollups from the dataset id enum value `airbnb-markets`. Aggregate-only: each row is a market cell, never an individual listing. Thin cells are suppressed. group_by enum: `country`, `market`, `admin1` (top subdivision), `locality` (settlement), `room_type` (`entire_place`/`private_room`/`hotel`/`shared_room`), `property_type` (Airbnb's canonical listing type from the detail page). `admin1`, `locality`, `room_type` and `property_type` are enrichment-derived and stay empty until their coverage is high enough to be reliable. Each cell also carries `median_price_usd`, the median nightly price converted to USD via an approximate dated FX snapshot, for cross-country comparison (combine with `group_by=room_type` for median price by room type); `guest_favorite_pct`, the share of listings carrying the Guest Favorite badge (an observed lower bound, like `superhost_pct`); and `avg_person_capacity`, the average guests a listing sleeps over the detail-page-enriched sample. Sort enum: `listings_desc`, `superhost_pct_desc`, `rating_desc`, `key_asc`. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
270282
270425
|
"operationId": "datasets-airbnb-markets-search",
|
|
270283
270426
|
"parameters": [
|
|
270284
270427
|
{
|
|
@@ -270582,7 +270725,7 @@
|
|
|
270582
270725
|
"consumes": [
|
|
270583
270726
|
"application/json"
|
|
270584
270727
|
],
|
|
270585
|
-
"description": "Searches the crawled public Apple Podcasts show catalog stored in a search index. One row per show. Discovered from a country x genre x collection chart grid and a search-term sweep — not a full catalog of every Apple Podcasts show. Sort enum: `relevance`, `popularity`, `track_count_desc`, `release_desc`, `title_asc`.",
|
|
270728
|
+
"description": "Searches the crawled public Apple Podcasts show catalog stored in a search index. One row per show. Discovered from a country x genre x collection chart grid and a search-term sweep — not a full catalog of every Apple Podcasts show. Sort enum: `relevance`, `popularity`, `track_count_desc`, `release_desc`, `title_asc`. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
270586
270729
|
"operationId": "datasets-apple-podcasts-shows-search",
|
|
270587
270730
|
"parameters": [
|
|
270588
270731
|
{
|
|
@@ -270698,7 +270841,7 @@
|
|
|
270698
270841
|
"consumes": [
|
|
270699
270842
|
"application/json"
|
|
270700
270843
|
],
|
|
270701
|
-
"description": "Searches daily top-chart snapshots scraped from the iOS App Store and Google Play, stored in a search index (one document per chart × snapshot × rank). With no `date` the latest snapshot is returned (today's chart); pair `app_id` with `sort=date_desc` for an app's rank over time. Store enum: `ios`, `android`. Chart type enum: `top_free`, `top_paid`, `top_grossing`, `new`. Platform enum (Apple device platforms, ios charts only): `phone`, `pad`, `mac`. Sort enum: `rank`, `rank_desc`, `date_desc`.",
|
|
270844
|
+
"description": "Searches daily top-chart snapshots scraped from the iOS App Store and Google Play, stored in a search index (one document per chart × snapshot × rank). With no `date` the latest snapshot is returned (today's chart); pair `app_id` with `sort=date_desc` for an app's rank over time. Store enum: `ios`, `android`. Chart type enum: `top_free`, `top_paid`, `top_grossing`, `new`. Platform enum (Apple device platforms, ios charts only): `phone`, `pad`, `mac`. Sort enum: `rank`, `rank_desc`, `date_desc`. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
270702
270845
|
"operationId": "datasets-apps-charts-search",
|
|
270703
270846
|
"parameters": [
|
|
270704
270847
|
{
|
|
@@ -270834,7 +270977,7 @@
|
|
|
270834
270977
|
"consumes": [
|
|
270835
270978
|
"application/json"
|
|
270836
270979
|
],
|
|
270837
|
-
"description": "Searches user reviews scraped from the iOS App Store and Google Play, stored in a search index (one document per review). Store enum: `ios`, `android`. Sort enum: `recent`, `score_desc`, `score_asc`, `helpful_desc`.",
|
|
270980
|
+
"description": "Searches user reviews scraped from the iOS App Store and Google Play, stored in a search index (one document per review). Store enum: `ios`, `android`. Sort enum: `recent`, `score_desc`, `score_asc`, `helpful_desc`. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
270838
270981
|
"operationId": "datasets-apps-reviews-search",
|
|
270839
270982
|
"parameters": [
|
|
270840
270983
|
{
|
|
@@ -270941,7 +271084,7 @@
|
|
|
270941
271084
|
"consumes": [
|
|
270942
271085
|
"application/json"
|
|
270943
271086
|
],
|
|
270944
|
-
"description": "Searches resolved iOS App Store and Google Play apps stored in a search index. Store enum: `ios`, `android`, `both`. Platform enum (Apple device platforms, ios records only): `phone`, `pad`, `mac`, `tv`, `watch`, `vision`. Sort enum: `relevance`, `rating_desc`, `reviews_desc`, `installs_desc`, `updated_at_desc`, `popularity_desc`.",
|
|
271087
|
+
"description": "Searches resolved iOS App Store and Google Play apps stored in a search index. Store enum: `ios`, `android`, `both`. Platform enum (Apple device platforms, ios records only): `phone`, `pad`, `mac`, `tv`, `watch`, `vision`. Sort enum: `relevance`, `rating_desc`, `reviews_desc`, `installs_desc`, `updated_at_desc`, `popularity_desc`. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
270945
271088
|
"operationId": "datasets-apps-search",
|
|
270946
271089
|
"parameters": [
|
|
270947
271090
|
{
|
|
@@ -271079,12 +271222,13 @@
|
|
|
271079
271222
|
"consumes": [
|
|
271080
271223
|
"application/json"
|
|
271081
271224
|
],
|
|
271082
|
-
"description": "Returns
|
|
271225
|
+
"description": "Returns the values of one field of the BBB businesses index (dataset id enum value `bbb-businesses`) with the number of records for each, honoring the same filters as search. Facet enum: `country`, `category`, `state`, `city`, `rating`, `accredited`, `entity_type`, `run_id`, `alert_title`, `has_alerts`. country enum: `us`, `ca`. Values come most frequent first, 50 per page by default; page through all of them with `limit` (up to 1000) and `offset` while `has_more` is true. The response also returns `total` (records matching the filters), `total_values` (distinct values) and `missing` (records with no value for the facet), so the counts can be checked against the total. Values of the `accredited` and `has_alerts` facets are `1` (true) and `0` (false). Use it to split a search that would exceed 10,000 records: `facet=state` lists every state and province, and `facet=city` with a `state` filter lists every city in it.",
|
|
271083
271226
|
"operationId": "datasets-bbb-businesses-facets",
|
|
271084
271227
|
"parameters": [
|
|
271085
271228
|
{
|
|
271086
|
-
"description": "Facet enum: category, state, city, rating, accredited, entity_type, run_id, alert_title, has_alerts",
|
|
271229
|
+
"description": "Facet enum: country, category, state, city, rating, accredited, entity_type, run_id, alert_title, has_alerts",
|
|
271087
271230
|
"enum": [
|
|
271231
|
+
"country",
|
|
271088
271232
|
"category",
|
|
271089
271233
|
"state",
|
|
271090
271234
|
"city",
|
|
@@ -271101,6 +271245,18 @@
|
|
|
271101
271245
|
"type": "string",
|
|
271102
271246
|
"x-example": "category"
|
|
271103
271247
|
},
|
|
271248
|
+
{
|
|
271249
|
+
"description": "Values per page, 1 to 1000, defaults to 50",
|
|
271250
|
+
"in": "query",
|
|
271251
|
+
"name": "limit",
|
|
271252
|
+
"type": "integer"
|
|
271253
|
+
},
|
|
271254
|
+
{
|
|
271255
|
+
"description": "Values to skip, 0 or greater, defaults to 0; offset + limit must be <= 10000. Request offset + limit next while has_more is true",
|
|
271256
|
+
"in": "query",
|
|
271257
|
+
"name": "offset",
|
|
271258
|
+
"type": "integer"
|
|
271259
|
+
},
|
|
271104
271260
|
{
|
|
271105
271261
|
"description": "Full-text match on the business name/category, max 256 characters",
|
|
271106
271262
|
"in": "query",
|
|
@@ -271108,19 +271264,29 @@
|
|
|
271108
271264
|
"type": "string"
|
|
271109
271265
|
},
|
|
271110
271266
|
{
|
|
271111
|
-
"description": "Exact category filter",
|
|
271267
|
+
"description": "Exact category filter, e.g. Plumber (case-sensitive). Use the values returned by facet=category",
|
|
271112
271268
|
"in": "query",
|
|
271113
271269
|
"name": "category",
|
|
271114
271270
|
"type": "string"
|
|
271115
271271
|
},
|
|
271116
271272
|
{
|
|
271117
|
-
"description": "
|
|
271273
|
+
"description": "Country filter, parsed from the profile URL (case-insensitive). Enum: us, ca",
|
|
271274
|
+
"enum": [
|
|
271275
|
+
"us",
|
|
271276
|
+
"ca"
|
|
271277
|
+
],
|
|
271278
|
+
"in": "query",
|
|
271279
|
+
"name": "country",
|
|
271280
|
+
"type": "string"
|
|
271281
|
+
},
|
|
271282
|
+
{
|
|
271283
|
+
"description": "Exact 2-letter state or province code as in the profile URL, e.g. tx (case-insensitive). Use the values returned by facet=state",
|
|
271118
271284
|
"in": "query",
|
|
271119
271285
|
"name": "state",
|
|
271120
271286
|
"type": "string"
|
|
271121
271287
|
},
|
|
271122
271288
|
{
|
|
271123
|
-
"description": "Exact city filter",
|
|
271289
|
+
"description": "Exact city slug as in the profile URL, e.g. san-diego (case-insensitive). Use the values returned by facet=city with a state filter",
|
|
271124
271290
|
"in": "query",
|
|
271125
271291
|
"name": "city",
|
|
271126
271292
|
"type": "string"
|
|
@@ -271147,37 +271313,43 @@
|
|
|
271147
271313
|
"type": "string"
|
|
271148
271314
|
},
|
|
271149
271315
|
{
|
|
271150
|
-
"description": "
|
|
271316
|
+
"description": "Numeric floor against the denormalized rating rank (A+=12 down to F=0), e.g. 10 for 'A- and above'",
|
|
271317
|
+
"in": "query",
|
|
271318
|
+
"name": "min_rating_rank",
|
|
271319
|
+
"type": "integer"
|
|
271320
|
+
},
|
|
271321
|
+
{
|
|
271322
|
+
"description": "Accreditation filter; true keeps only accredited businesses, false only the others",
|
|
271151
271323
|
"in": "query",
|
|
271152
271324
|
"name": "accredited",
|
|
271153
271325
|
"type": "boolean"
|
|
271154
271326
|
},
|
|
271155
271327
|
{
|
|
271156
|
-
"description": "BBB-alert filter",
|
|
271328
|
+
"description": "BBB-alert filter; true keeps businesses whose profile carries at least one BBB alert, false keeps refreshed records with none",
|
|
271157
271329
|
"in": "query",
|
|
271158
271330
|
"name": "has_alerts",
|
|
271159
271331
|
"type": "boolean"
|
|
271160
271332
|
},
|
|
271161
271333
|
{
|
|
271162
|
-
"description": "Exact BBB alert title filter",
|
|
271334
|
+
"description": "Exact BBB alert title filter, e.g. Pattern of Complaint (case-sensitive). Use the values returned by facet=alert_title",
|
|
271163
271335
|
"in": "query",
|
|
271164
271336
|
"name": "alert_title",
|
|
271165
271337
|
"type": "string"
|
|
271166
271338
|
},
|
|
271167
271339
|
{
|
|
271168
|
-
"description": "Floor against total_complaints, 0 or greater",
|
|
271340
|
+
"description": "Floor against total_complaints (BBB's three-year complaint count), 0 or greater",
|
|
271169
271341
|
"in": "query",
|
|
271170
271342
|
"name": "min_complaints",
|
|
271171
271343
|
"type": "integer"
|
|
271172
271344
|
},
|
|
271173
271345
|
{
|
|
271174
|
-
"description": "Exact entity-type filter",
|
|
271346
|
+
"description": "Exact entity-type filter, e.g. Limited Liability Company (LLC) (case-sensitive). Use the values returned by facet=entity_type",
|
|
271175
271347
|
"in": "query",
|
|
271176
271348
|
"name": "entity_type",
|
|
271177
271349
|
"type": "string"
|
|
271178
271350
|
},
|
|
271179
271351
|
{
|
|
271180
|
-
"description": "Exact crawl run id filter",
|
|
271352
|
+
"description": "Exact crawl run id filter, e.g. bbb-20260906. Use the values returned by facet=run_id",
|
|
271181
271353
|
"in": "query",
|
|
271182
271354
|
"name": "run_id",
|
|
271183
271355
|
"type": "string"
|
|
@@ -271291,7 +271463,7 @@
|
|
|
271291
271463
|
"consumes": [
|
|
271292
271464
|
"application/json"
|
|
271293
271465
|
],
|
|
271294
|
-
"description": "Searches the BBB (Better Business Bureau) businesses index (dataset id enum value `bbb-businesses`) — business profiles crawled from bbb.org's own search/category-browse pages: computed A+-F letter-grade rating, paid-accreditation status, category, contact info, business details, operating hours, and products/services. Complaints, full reviews, and the full \"reasons for rating\"/service-area detail are NOT embedded here; each record instead carries complaints_url/reviews_url/more_info_url pointing at the live bbb-business-complaints/bbb-business-reviews/bbb-business-more-info endpoints for on-demand lookup. rating enum: `A+`, `A`, `A-`, `B+`, `B`, `B-`, `C+`, `C`, `C-`, `D+`, `D`, `D-`, `F`. Each record also stores BBB's complaint and review counts (total_complaints and related fields) and the BBB alerts on the profile (has_alerts, alert_titles, alerts[] with full text), so businesses with complaints or with a given alert can be listed without calling the live endpoints; these fields are filled as records are re-crawled and are absent on a record not refreshed since they were added. sort enum: `relevance`, `rating_desc`, `rating_asc`, `accredited_first`, `name_asc`, `years_in_business_desc`, `complaints_desc`. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100); the item and facets endpoints cost 1.",
|
|
271466
|
+
"description": "Searches the BBB (Better Business Bureau) businesses index (dataset id enum value `bbb-businesses`) — business profiles crawled from bbb.org's own search/category-browse pages: computed A+-F letter-grade rating, paid-accreditation status, category, contact info, business details, operating hours, and products/services. Complaints, full reviews, and the full \"reasons for rating\"/service-area detail are NOT embedded here; each record instead carries complaints_url/reviews_url/more_info_url pointing at the live bbb-business-complaints/bbb-business-reviews/bbb-business-more-info endpoints for on-demand lookup. rating enum: `A+`, `A`, `A-`, `B+`, `B`, `B-`, `C+`, `C`, `C-`, `D+`, `D`, `D-`, `F`. Each record also stores BBB's complaint and review counts (total_complaints and related fields) and the BBB alerts on the profile (has_alerts, alert_titles, alerts[] with full text), so businesses with complaints or with a given alert can be listed without calling the live endpoints; these fields are filled as records are re-crawled and are absent on a record not refreshed since they were added. sort enum: `relevance`, `rating_desc`, `rating_asc`, `accredited_first`, `name_asc`, `years_in_business_desc`, `complaints_desc`. country enum: `us`, `ca`. A query returns at most 10,000 records; to read more, split it with the values and counts from the facets endpoint (for example one request per state, then per city) so each part stays under that limit. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100); the item and facets endpoints cost 1.",
|
|
271295
271467
|
"operationId": "datasets-bbb-businesses-search",
|
|
271296
271468
|
"parameters": [
|
|
271297
271469
|
{
|
|
@@ -271301,19 +271473,29 @@
|
|
|
271301
271473
|
"type": "string"
|
|
271302
271474
|
},
|
|
271303
271475
|
{
|
|
271304
|
-
"description": "Exact category filter, e.g. Plumber. Use the values returned by facets?facet=category",
|
|
271476
|
+
"description": "Exact category filter, e.g. Plumber (case-sensitive). Use the values returned by facets?facet=category",
|
|
271305
271477
|
"in": "query",
|
|
271306
271478
|
"name": "category",
|
|
271307
271479
|
"type": "string"
|
|
271308
271480
|
},
|
|
271309
271481
|
{
|
|
271310
|
-
"description": "
|
|
271482
|
+
"description": "Country filter, parsed from the profile URL (case-insensitive). Enum: us, ca",
|
|
271483
|
+
"enum": [
|
|
271484
|
+
"us",
|
|
271485
|
+
"ca"
|
|
271486
|
+
],
|
|
271487
|
+
"in": "query",
|
|
271488
|
+
"name": "country",
|
|
271489
|
+
"type": "string"
|
|
271490
|
+
},
|
|
271491
|
+
{
|
|
271492
|
+
"description": "Exact 2-letter state or province code as in the profile URL, e.g. tx (case-insensitive). Use the values returned by facets?facet=state",
|
|
271311
271493
|
"in": "query",
|
|
271312
271494
|
"name": "state",
|
|
271313
271495
|
"type": "string"
|
|
271314
271496
|
},
|
|
271315
271497
|
{
|
|
271316
|
-
"description": "Exact city
|
|
271498
|
+
"description": "Exact city slug as in the profile URL, e.g. san-diego (case-insensitive). Use the values returned by facets?facet=city with a state filter; the same slug exists in several states, so send state with it",
|
|
271317
271499
|
"in": "query",
|
|
271318
271500
|
"name": "city",
|
|
271319
271501
|
"type": "string"
|
|
@@ -271346,7 +271528,7 @@
|
|
|
271346
271528
|
"type": "integer"
|
|
271347
271529
|
},
|
|
271348
271530
|
{
|
|
271349
|
-
"description": "Accreditation filter; true keeps only accredited businesses",
|
|
271531
|
+
"description": "Accreditation filter; true keeps only accredited businesses, false only the others",
|
|
271350
271532
|
"in": "query",
|
|
271351
271533
|
"name": "accredited",
|
|
271352
271534
|
"type": "boolean"
|
|
@@ -271370,13 +271552,13 @@
|
|
|
271370
271552
|
"type": "integer"
|
|
271371
271553
|
},
|
|
271372
271554
|
{
|
|
271373
|
-
"description": "Exact entity-type filter, e.g. Limited Liability Company (LLC)",
|
|
271555
|
+
"description": "Exact entity-type filter, e.g. Limited Liability Company (LLC) (case-sensitive). Use the values returned by facets?facet=entity_type",
|
|
271374
271556
|
"in": "query",
|
|
271375
271557
|
"name": "entity_type",
|
|
271376
271558
|
"type": "string"
|
|
271377
271559
|
},
|
|
271378
271560
|
{
|
|
271379
|
-
"description": "Exact crawl run id filter",
|
|
271561
|
+
"description": "Exact crawl run id filter, e.g. bbb-20260906. Use the values returned by facets?facet=run_id",
|
|
271380
271562
|
"in": "query",
|
|
271381
271563
|
"name": "run_id",
|
|
271382
271564
|
"type": "string"
|
|
@@ -271985,7 +272167,7 @@
|
|
|
271985
272167
|
"consumes": [
|
|
271986
272168
|
"application/json"
|
|
271987
272169
|
],
|
|
271988
|
-
"description": "Searches theatrical box-office records from public Box Office Mojo charts and title pages, stored in a search index. Filter by title id, year, franchise/brand/genre, gross band, lifetime top-1000 membership, hydration status, and worldwide/domestic gross ranges. Sort enum: `relevance`, `worldwide_desc`, `domestic_desc`, `peak_worldwide_desc`, `lifetime_rank_asc`, `year_desc`, `year_asc`. gross_band enum: `under_50m`, `50_100m`, `100_250m`, `250_500m`, `500m_1b`, `over_1b`.",
|
|
272170
|
+
"description": "Searches theatrical box-office records from public Box Office Mojo charts and title pages, stored in a search index. Filter by title id, year, franchise/brand/genre, gross band, lifetime top-1000 membership, hydration status, and worldwide/domestic gross ranges. Sort enum: `relevance`, `worldwide_desc`, `domestic_desc`, `peak_worldwide_desc`, `lifetime_rank_asc`, `year_desc`, `year_asc`. gross_band enum: `under_50m`, `50_100m`, `100_250m`, `250_500m`, `500m_1b`, `over_1b`. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
271989
272171
|
"operationId": "datasets-boxofficemojo-search",
|
|
271990
272172
|
"parameters": [
|
|
271991
272173
|
{
|
|
@@ -272596,7 +272778,7 @@
|
|
|
272596
272778
|
},
|
|
272597
272779
|
"/datasets/chrome-extensions/search": {
|
|
272598
272780
|
"get": {
|
|
272599
|
-
"description": "Searches stored Chrome Web Store item snapshots. Item type enum: `extension`, `theme`, `app`, `unknown`. Sort enum: `relevance`, `users_desc`, `rating_desc`, `reviews_desc`, `updated_desc`, `trending_desc`. Status enum: `active`, `removed`. Manifest version enum: `2`, `3`.",
|
|
272781
|
+
"description": "Searches stored Chrome Web Store item snapshots. Item type enum: `extension`, `theme`, `app`, `unknown`. Sort enum: `relevance`, `users_desc`, `rating_desc`, `reviews_desc`, `updated_desc`, `trending_desc`. Status enum: `active`, `removed`. Manifest version enum: `2`, `3`. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
272600
272782
|
"operationId": "datasets-chrome-extensions-search",
|
|
272601
272783
|
"parameters": [
|
|
272602
272784
|
{
|
|
@@ -272760,7 +272942,7 @@
|
|
|
272760
272942
|
},
|
|
272761
272943
|
"/datasets/chrome-extensions/trending": {
|
|
272762
272944
|
"get": {
|
|
272763
|
-
"description": "Returns stored Chrome Web Store items ranked by the latest observed user and rating-count movement. Filters match the search endpoint; sort is fixed to `trending_desc`.",
|
|
272945
|
+
"description": "Returns stored Chrome Web Store items ranked by the latest observed user and rating-count movement. Filters match the search endpoint; sort is fixed to `trending_desc`. Billing: this endpoint costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
272764
272946
|
"operationId": "datasets-chrome-extensions-trending",
|
|
272765
272947
|
"parameters": [
|
|
272766
272948
|
{
|
|
@@ -272913,7 +273095,7 @@
|
|
|
272913
273095
|
"consumes": [
|
|
272914
273096
|
"application/json"
|
|
272915
273097
|
],
|
|
272916
|
-
"description": "Searches TikTok creators stored in a search index (one document per creator), with follower counts, verified status, niche, and engagement. Deleted and private accounts are excluded by default; set `include_inactive=true` to include them for historical lookups. Sort enum: `followers_desc`, `engagement_desc`, `engagement_qualified_desc`, `likes_desc`, `relevance`. Coverage note: `followers_desc`, `likes_desc`, and `relevance` are backed by profile fields present across the full dataset; the post-level engagement metrics (`engagement_rate`, `avg_views`, and the nested `post_stats` object) and the `engagement_desc`/`engagement_qualified_desc` sorts are currently populated for a growing subset of creators, prioritizing the highest-reach accounts. Creators without these metrics are still returned but sort last under `engagement_desc` and omit those fields; `engagement_qualified_desc` excludes them outright (they cannot clear its floors). `engagement_desc` ranks by raw `engagement_rate` with no eligibility floor — it surfaces a real stale-record + ratio-by-design trap: an account whose last real post was years ago can still carry an unrealistic rate computed from a handful of old posts. `engagement_qualified_desc` is the same metric restricted to creators with a recent post (`last_post_at` within 90 days), a minimum reach (`avg_views >= 10000`) and sample size (`post_stats.sampled_posts >= 10`), and a sanity ceiling (`engagement_rate <= 50%`) — use this, not the raw sort, for a \"best engagement\" leaderboard. Sound fields: `post_stats.top_sounds` holds only a creator's FIVE most-used sounds from the sampled posts, ranked by use count with ties broken by lowest `music_id`, so it is a top-5 view and not the creator's full sound list; `post_stats.distinct_sounds` gives the true number of different sounds the sample used. Use each sound's `original` boolean to tell TikTok-generated original audio from catalogue tracks - do NOT infer it from the title, because TikTok localizes the original-audio label (`sonido original`, `som original`, `оригинальный звук`, and at least fifteen more), so a title match silently reclassifies original audio as named tracks.",
|
|
273098
|
+
"description": "Searches TikTok creators stored in a search index (one document per creator), with follower counts, verified status, niche, and engagement. Deleted and private accounts are excluded by default; set `include_inactive=true` to include them for historical lookups. Sort enum: `followers_desc`, `engagement_desc`, `engagement_qualified_desc`, `likes_desc`, `relevance`. Coverage note: `followers_desc`, `likes_desc`, and `relevance` are backed by profile fields present across the full dataset; the post-level engagement metrics (`engagement_rate`, `avg_views`, and the nested `post_stats` object) and the `engagement_desc`/`engagement_qualified_desc` sorts are currently populated for a growing subset of creators, prioritizing the highest-reach accounts. Creators without these metrics are still returned but sort last under `engagement_desc` and omit those fields; `engagement_qualified_desc` excludes them outright (they cannot clear its floors). `engagement_desc` ranks by raw `engagement_rate` with no eligibility floor — it surfaces a real stale-record + ratio-by-design trap: an account whose last real post was years ago can still carry an unrealistic rate computed from a handful of old posts. `engagement_qualified_desc` is the same metric restricted to creators with a recent post (`last_post_at` within 90 days), a minimum reach (`avg_views >= 10000`) and sample size (`post_stats.sampled_posts >= 10`), and a sanity ceiling (`engagement_rate <= 50%`) — use this, not the raw sort, for a \"best engagement\" leaderboard. Sound fields: `post_stats.top_sounds` holds only a creator's FIVE most-used sounds from the sampled posts, ranked by use count with ties broken by lowest `music_id`, so it is a top-5 view and not the creator's full sound list; `post_stats.distinct_sounds` gives the true number of different sounds the sample used. Use each sound's `original` boolean to tell TikTok-generated original audio from catalogue tracks - do NOT infer it from the title, because TikTok localizes the original-audio label (`sonido original`, `som original`, `оригинальный звук`, and at least fifteen more), so a title match silently reclassifies original audio as named tracks. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
272917
273099
|
"operationId": "datasets-creators-search",
|
|
272918
273100
|
"parameters": [
|
|
272919
273101
|
{
|
|
@@ -273206,7 +273388,7 @@
|
|
|
273206
273388
|
"consumes": [
|
|
273207
273389
|
"application/json"
|
|
273208
273390
|
],
|
|
273209
|
-
"description": "Returns stored DoorDash stores within a radius of a point, nearest first, from dataset id `doordash-stores`. lat, lon, and radius_m are required. Unlike the live /doordash/search endpoint (which is a proximity search capped at roughly five stores), this queries the stored directory, so it can return every discovered store in the radius. Coverage is best-effort rather than provably exhaustive: a store DoorDash never surfaced, or one not yet hydrated with coordinates, will not appear.",
|
|
273391
|
+
"description": "Returns stored DoorDash stores within a radius of a point, nearest first, from dataset id `doordash-stores`. lat, lon, and radius_m are required. Unlike the live /doordash/search endpoint (which is a proximity search capped at roughly five stores), this queries the stored directory, so it can return every discovered store in the radius. Coverage is best-effort rather than provably exhaustive: a store DoorDash never surfaced, or one not yet hydrated with coordinates, will not appear. Billing: this endpoint costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
273210
273392
|
"operationId": "datasets-doordash-stores-nearby",
|
|
273211
273393
|
"parameters": [
|
|
273212
273394
|
{
|
|
@@ -273325,7 +273507,7 @@
|
|
|
273325
273507
|
"consumes": [
|
|
273326
273508
|
"application/json"
|
|
273327
273509
|
],
|
|
273328
|
-
"description": "Searches the DoorDash merchant-location directory (dataset id `doordash-stores`), built by grid-tiling the anonymous guest Explore feed and hydrating every discovered store. Identity and marketplace fields (name, marketplace tags, price range, ratings, DashPass eligibility) come from Explore; contact, address, and coordinates come from the hydration pass, so a store that has not been hydrated yet can appear without them. `display_status`, `display_asap_time`, `asap_available`, and `pickup_available` are a point-in-time observation of the PICKUP surface at crawl time, not a durable capability. Geographic coverage is best-effort: Explore caps at 40 stores per call with no pagination, so the census saturates a tile rather than draining it. Supports full-text `q`, `country`/`state`/`city`/`tag` filters, `dash_pass_only`, `min_price`/`max_price`/`min_rating`, `lat`/`lon`/`radius_m` radius filtering, and `sort` (relevance, rating, distance, distance_asc). `sort=relevance` ranks by text-match score when `q` is supplied; without `q` it sorts by store name. Use `pagination=cursor` and the returned `next_cursor` to enumerate beyond the 10,000-result offset window against a point-in-time snapshot.",
|
|
273510
|
+
"description": "Searches the DoorDash merchant-location directory (dataset id `doordash-stores`), built by grid-tiling the anonymous guest Explore feed and hydrating every discovered store. Identity and marketplace fields (name, marketplace tags, price range, ratings, DashPass eligibility) come from Explore; contact, address, and coordinates come from the hydration pass, so a store that has not been hydrated yet can appear without them. `display_status`, `display_asap_time`, `asap_available`, and `pickup_available` are a point-in-time observation of the PICKUP surface at crawl time, not a durable capability. Geographic coverage is best-effort: Explore caps at 40 stores per call with no pagination, so the census saturates a tile rather than draining it. Supports full-text `q`, `country`/`state`/`city`/`tag` filters, `dash_pass_only`, `min_price`/`max_price`/`min_rating`, `lat`/`lon`/`radius_m` radius filtering, and `sort` (relevance, rating, distance, distance_asc). `sort=relevance` ranks by text-match score when `q` is supplied; without `q` it sorts by store name. Use `pagination=cursor` and the returned `next_cursor` to enumerate beyond the 10,000-result offset window against a point-in-time snapshot. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
273329
273511
|
"operationId": "datasets-doordash-stores-search",
|
|
273330
273512
|
"parameters": [
|
|
273331
273513
|
{
|
|
@@ -273723,7 +273905,7 @@
|
|
|
273723
273905
|
"consumes": [
|
|
273724
273906
|
"application/json"
|
|
273725
273907
|
],
|
|
273726
|
-
"description": "Searches public Facebook Page contact records stored in a search index — website, email, phone, WhatsApp, category and like count, discovered through business-search enumeration, domain-scoped scans, and Wikidata seeding, then hydrated from each Page's public About tab. Sort enum: `relevance`, `likes_desc`, `likes_asc`, `hydrated_at_desc`, `hydrated_at_asc`.",
|
|
273908
|
+
"description": "Searches public Facebook Page contact records stored in a search index — website, email, phone, WhatsApp, category and like count, discovered through business-search enumeration, domain-scoped scans, and Wikidata seeding, then hydrated from each Page's public About tab. Sort enum: `relevance`, `likes_desc`, `likes_asc`, `hydrated_at_desc`, `hydrated_at_asc`. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
273727
273909
|
"operationId": "datasets-facebook-pages-search",
|
|
273728
273910
|
"parameters": [
|
|
273729
273911
|
{
|
|
@@ -274197,7 +274379,7 @@
|
|
|
274197
274379
|
"consumes": [
|
|
274198
274380
|
"application/json"
|
|
274199
274381
|
],
|
|
274200
|
-
"description": "Searches enriched GitHub users near a coordinate, sorted by distance, in dataset id enum value `github-users`. influence_tier enum: `nano`, `micro`, `mid`, `macro`, `mega`.",
|
|
274382
|
+
"description": "Searches enriched GitHub users near a coordinate, sorted by distance, in dataset id enum value `github-users`. influence_tier enum: `nano`, `micro`, `mid`, `macro`, `mega`. Billing: this endpoint costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
274201
274383
|
"operationId": "datasets-github-users-nearby",
|
|
274202
274384
|
"parameters": [
|
|
274203
274385
|
{
|
|
@@ -274307,7 +274489,7 @@
|
|
|
274307
274489
|
"consumes": [
|
|
274308
274490
|
"application/json"
|
|
274309
274491
|
],
|
|
274310
|
-
"description": "Searches enriched public GitHub user profiles stored in a search index. influence_tier enum: `nano`, `micro`, `mid`, `macro`, `mega`. Sort enum: `relevance`, `rank_score_desc`, `followers_desc`, `account_age_desc`, `account_age_asc`, `distance_asc`.",
|
|
274492
|
+
"description": "Searches enriched public GitHub user profiles stored in a search index. influence_tier enum: `nano`, `micro`, `mid`, `macro`, `mega`. Sort enum: `relevance`, `rank_score_desc`, `followers_desc`, `account_age_desc`, `account_age_asc`, `distance_asc`. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
274311
274493
|
"operationId": "datasets-github-users-search",
|
|
274312
274494
|
"parameters": [
|
|
274313
274495
|
{
|
|
@@ -274711,7 +274893,7 @@
|
|
|
274711
274893
|
"consumes": [
|
|
274712
274894
|
"application/json"
|
|
274713
274895
|
],
|
|
274714
|
-
"description": "Searches the crawled public Goodreads author profile index. Authors are discovered as a byproduct of the books crawl (every credited book contributor, plus the genre/search/list seed sources) — not a full catalog. Sort enum: `relevance`, `rating_desc`, `reviews_desc`, `name_asc`.",
|
|
274896
|
+
"description": "Searches the crawled public Goodreads author profile index. Authors are discovered as a byproduct of the books crawl (every credited book contributor, plus the genre/search/list seed sources) — not a full catalog. Sort enum: `relevance`, `rating_desc`, `reviews_desc`, `name_asc`. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
274715
274897
|
"operationId": "datasets-goodreads-authors-search",
|
|
274716
274898
|
"parameters": [
|
|
274717
274899
|
{
|
|
@@ -275053,7 +275235,7 @@
|
|
|
275053
275235
|
"consumes": [
|
|
275054
275236
|
"application/json"
|
|
275055
275237
|
],
|
|
275056
|
-
"description": "Searches the crawled public Goodreads book catalog stored in a search index. Discovered from curated Listopia \"best of\" lists, a search-term sweep, and author bibliography expansion — not a full catalog. Sort enum: `relevance`, `rating_desc`, `reviews_desc`, `publication_desc`, `publication_asc`, `pages_desc`, `pages_asc`, `title_asc`.",
|
|
275238
|
+
"description": "Searches the crawled public Goodreads book catalog stored in a search index. Discovered from curated Listopia \"best of\" lists, a search-term sweep, and author bibliography expansion — not a full catalog. Sort enum: `relevance`, `rating_desc`, `reviews_desc`, `publication_desc`, `publication_asc`, `pages_desc`, `pages_asc`, `title_asc`. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
275057
275239
|
"operationId": "datasets-goodreads-books-search",
|
|
275058
275240
|
"parameters": [
|
|
275059
275241
|
{
|
|
@@ -275484,7 +275666,7 @@
|
|
|
275484
275666
|
"consumes": [
|
|
275485
275667
|
"application/json"
|
|
275486
275668
|
],
|
|
275487
|
-
"description": "Searches stored Google Maps businesses near a coordinate in dataset id enum value `google-map-businesses`. `category` is the exact Google Maps category label returned for the business locale; it can be localized, non-ASCII, or contain punctuation, so use the category facet to discover exact filter values. A `rating` of `null` means no aggregate rating is available. A `review_count` of `null` means Google did not return a count; numeric `0` means Google confirmed zero reviews. `min_rating` above 0 excludes unrated businesses.",
|
|
275669
|
+
"description": "Searches stored Google Maps businesses near a coordinate in dataset id enum value `google-map-businesses`. `category` is the exact Google Maps category label returned for the business locale; it can be localized, non-ASCII, or contain punctuation, so use the category facet to discover exact filter values. A `rating` of `null` means no aggregate rating is available. A `review_count` of `null` means Google did not return a count; numeric `0` means Google confirmed zero reviews. `min_rating` above 0 excludes unrated businesses. Billing: this endpoint costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
275488
275670
|
"operationId": "datasets-google-map-businesses-nearby",
|
|
275489
275671
|
"parameters": [
|
|
275490
275672
|
{
|
|
@@ -275587,7 +275769,7 @@
|
|
|
275587
275769
|
"consumes": [
|
|
275588
275770
|
"application/json"
|
|
275589
275771
|
],
|
|
275590
|
-
"description": "Searches Google Maps business records stored in a search index. Sort enum: `relevance`, `updated_at_desc`, `rating_desc`, `review_count_desc`, `distance_asc`. `category` is the exact Google Maps category label returned for the business locale; it can be localized, non-ASCII, or contain punctuation, so use the category facet to discover exact filter values. A `rating` of `null` means no aggregate rating is available. A `review_count` of `null` means Google did not return a count; numeric `0` means Google confirmed zero reviews. `rating_desc` sorts unrated businesses last, and `min_rating` above 0 excludes them. Use `has_geo=false` to isolate locationless service-area businesses (which have a `null` `geo`). A `permanently_closed` of `true` means Google marks the business permanently closed; `false` means a crawl confirmed it does not; `null` means the business has not been status-checked since capture shipped on 2026-08-31 and is UNKNOWN, not open — so any total computed from this dataset includes an unknown number of closed businesses. Use `permanently_closed=false` to exclude the confirmed-closed ones.",
|
|
275772
|
+
"description": "Searches Google Maps business records stored in a search index. Sort enum: `relevance`, `updated_at_desc`, `rating_desc`, `review_count_desc`, `distance_asc`. `category` is the exact Google Maps category label returned for the business locale; it can be localized, non-ASCII, or contain punctuation, so use the category facet to discover exact filter values. A `rating` of `null` means no aggregate rating is available. A `review_count` of `null` means Google did not return a count; numeric `0` means Google confirmed zero reviews. `rating_desc` sorts unrated businesses last, and `min_rating` above 0 excludes them. Use `has_geo=false` to isolate locationless service-area businesses (which have a `null` `geo`). A `permanently_closed` of `true` means Google marks the business permanently closed; `false` means a crawl confirmed it does not; `null` means the business has not been status-checked since capture shipped on 2026-08-31 and is UNKNOWN, not open — so any total computed from this dataset includes an unknown number of closed businesses. Use `permanently_closed=false` to exclude the confirmed-closed ones. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
275591
275773
|
"operationId": "datasets-google-map-businesses-search",
|
|
275592
275774
|
"parameters": [
|
|
275593
275775
|
{
|
|
@@ -276065,7 +276247,7 @@
|
|
|
276065
276247
|
"consumes": [
|
|
276066
276248
|
"application/json"
|
|
276067
276249
|
],
|
|
276068
|
-
"description": "Searches monthly Redfin housing-market statistics per region and property type since 2012, joined to Census ACS income for affordability metrics. region_type enum: `national`, `metro`, `county`, `city`, `zip`. property_type enum: `All Residential`, `Single Family Residential`, `Condo/Co-op`, `Townhouse`, `Multi-Family (2-4 Unit)`, `Single Units Only`. Sort enum: `relevance`, `price_desc`, `price_asc`, `list_price_desc`, `list_price_asc`, `price_to_income_desc`, `price_to_income_asc`, `salary_to_buy_desc`, `salary_to_buy_asc`, `dom_asc`, `dom_desc`, `inventory_desc`, `homes_sold_desc`, `period_desc`. Use `latest=true` for the most recent period per region series.",
|
|
276250
|
+
"description": "Searches monthly Redfin housing-market statistics per region and property type since 2012, joined to Census ACS income for affordability metrics. region_type enum: `national`, `metro`, `county`, `city`, `zip`. property_type enum: `All Residential`, `Single Family Residential`, `Condo/Co-op`, `Townhouse`, `Multi-Family (2-4 Unit)`, `Single Units Only`. Sort enum: `relevance`, `price_desc`, `price_asc`, `list_price_desc`, `list_price_asc`, `price_to_income_desc`, `price_to_income_asc`, `salary_to_buy_desc`, `salary_to_buy_asc`, `dom_asc`, `dom_desc`, `inventory_desc`, `homes_sold_desc`, `period_desc`. Use `latest=true` for the most recent period per region series. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
276069
276251
|
"operationId": "datasets-housing-markets-search",
|
|
276070
276252
|
"parameters": [
|
|
276071
276253
|
{
|
|
@@ -276532,7 +276714,7 @@
|
|
|
276532
276714
|
"consumes": [
|
|
276533
276715
|
"application/json"
|
|
276534
276716
|
],
|
|
276535
|
-
"description": "Searches public Instagram user profiles stored in a search index. Sort enum: `relevance`, `followers_desc`, `followers_asc`, `crawled_at_desc`, `crawled_at_asc`, `created_at_desc`, `created_at_asc`.",
|
|
276717
|
+
"description": "Searches public Instagram user profiles stored in a search index. Sort enum: `relevance`, `followers_desc`, `followers_asc`, `crawled_at_desc`, `crawled_at_asc`, `created_at_desc`, `created_at_asc`. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
276536
276718
|
"operationId": "datasets-instagram-users-search",
|
|
276537
276719
|
"parameters": [
|
|
276538
276720
|
{
|
|
@@ -276704,7 +276886,7 @@
|
|
|
276704
276886
|
"consumes": [
|
|
276705
276887
|
"application/json"
|
|
276706
276888
|
],
|
|
276707
|
-
"description": "Searches the discovered company board registry — which companies are hiring, on which ATS (or, for the 5 single-company big-tech providers, which platform), with how many open roles. Set sponsors_visa=true to keep companies with certified employer filings in recent public U.S. Department of Labor LCA disclosure data. This is company-level historical evidence, not a guarantee for a specific role or candidate. provider enum: `greenhouse`, `lever`, `ashby`, `workday`, `smartrecruiters`, `workable`, `recruitee`, `rippling`, `personio`, `teamtailor`, `oracle`, `ukg`, `icims`, `eightfold`, `gem`, `pinpoint`, `amazon-jobs`, `apple-jobs`, `google-jobs`, `meta-jobs`, `tesla-jobs`. status enum: `active`, `empty`, `gone`, `blocked`, `pending`, `invalid`. sort enum: `open_desc`, `company_asc`, `crawled_desc`.",
|
|
276889
|
+
"description": "Searches the discovered company board registry — which companies are hiring, on which ATS (or, for the 5 single-company big-tech providers, which platform), with how many open roles. Set sponsors_visa=true to keep companies with certified employer filings in recent public U.S. Department of Labor LCA disclosure data. This is company-level historical evidence, not a guarantee for a specific role or candidate. provider enum: `greenhouse`, `lever`, `ashby`, `workday`, `smartrecruiters`, `workable`, `recruitee`, `rippling`, `personio`, `teamtailor`, `oracle`, `ukg`, `icims`, `eightfold`, `gem`, `pinpoint`, `amazon-jobs`, `apple-jobs`, `google-jobs`, `meta-jobs`, `tesla-jobs`. status enum: `active`, `empty`, `gone`, `blocked`, `pending`, `invalid`. sort enum: `open_desc`, `company_asc`, `crawled_desc`. Billing: this endpoint costs 1 credit per 10 records returned, rounded up, with a minimum of 1 (up to 10 records cost 1, a full page of 100 costs 10).",
|
|
276708
276890
|
"operationId": "datasets-jobs-companies",
|
|
276709
276891
|
"parameters": [
|
|
276710
276892
|
{
|
|
@@ -276994,7 +277176,7 @@
|
|
|
276994
277176
|
"consumes": [
|
|
276995
277177
|
"application/json"
|
|
276996
277178
|
],
|
|
276997
|
-
"description": "Finds crawled job postings within `radius_km` of a `lat`/`lon`, nearest first. Only geocoded postings participate (the geo-enrich worker back-fills coordinates from each posting's location). Open roles only by default. provider enum: `greenhouse`, `lever`, `ashby`, `workday`, `smartrecruiters`, `workable`, `recruitee`, `rippling`, `personio`, `teamtailor`, `oracle`, `ukg`, `icims`, `eightfold`, `gem`, `pinpoint`, `amazon-jobs`, `apple-jobs`, `google-jobs`, `meta-jobs`, `tesla-jobs`.",
|
|
277179
|
+
"description": "Finds crawled job postings within `radius_km` of a `lat`/`lon`, nearest first. Only geocoded postings participate (the geo-enrich worker back-fills coordinates from each posting's location). Open roles only by default. provider enum: `greenhouse`, `lever`, `ashby`, `workday`, `smartrecruiters`, `workable`, `recruitee`, `rippling`, `personio`, `teamtailor`, `oracle`, `ukg`, `icims`, `eightfold`, `gem`, `pinpoint`, `amazon-jobs`, `apple-jobs`, `google-jobs`, `meta-jobs`, `tesla-jobs`. Billing: this endpoint costs 1 credit per 10 records returned, rounded up, with a minimum of 1 (up to 10 records cost 1, a full page of 100 costs 10).",
|
|
276998
277180
|
"operationId": "datasets-jobs-nearby",
|
|
276999
277181
|
"parameters": [
|
|
277000
277182
|
{
|
|
@@ -277106,7 +277288,7 @@
|
|
|
277106
277288
|
"consumes": [
|
|
277107
277289
|
"application/json"
|
|
277108
277290
|
],
|
|
277109
|
-
"description": "Full-text + faceted search over every job posting crawled from every discovered company ATS board (Greenhouse, Lever, Ashby, Workday, SmartRecruiters, Workable, Recruitee, Rippling, Personio, Teamtailor, Oracle, UKG, iCIMS, Eightfold, Gem, Pinpoint) plus 5 single-company big-tech careers platforms (Amazon, Apple, Google, Meta, Tesla). Open roles only by default (set include_closed=true for historical/filled roles). Salary is parsed from a structured field when the provider has one, or from an explicit pay figure stated in the description otherwise, so coverage varies by posting rather than by provider; min_salary/max_salary filter on it and require salary_currency, since comparing raw compensation numbers across currencies is meaningless. Location is also exposed as structured city/state/country fields alongside the free-text location string, so city/state/country filter on an exact match of those parsed components rather than substring-matching the display string. job_family is an exact level-2 ISCO family label assigned from ESCO occupation evidence; ambiguous postings remain unclassified and do not match that filter. employment_type is never populated for google-jobs/meta-jobs, and posted_at (so sort=posted_desc) is never populated for meta-jobs/tesla-jobs -- their upstream APIs expose no such field. provider enum: `greenhouse`, `lever`, `ashby`, `workday`, `smartrecruiters`, `workable`, `recruitee`, `rippling`, `personio`, `teamtailor`, `oracle`, `ukg`, `icims`, `eightfold`, `gem`, `pinpoint`, `amazon-jobs`, `apple-jobs`, `google-jobs`, `meta-jobs`, `tesla-jobs`. workplace_type enum: `onsite`, `hybrid`, `remote`. sort enum: `relevance`, `posted_desc`, `company_asc`.",
|
|
277291
|
+
"description": "Full-text + faceted search over every job posting crawled from every discovered company ATS board (Greenhouse, Lever, Ashby, Workday, SmartRecruiters, Workable, Recruitee, Rippling, Personio, Teamtailor, Oracle, UKG, iCIMS, Eightfold, Gem, Pinpoint) plus 5 single-company big-tech careers platforms (Amazon, Apple, Google, Meta, Tesla). Open roles only by default (set include_closed=true for historical/filled roles). Salary is parsed from a structured field when the provider has one, or from an explicit pay figure stated in the description otherwise, so coverage varies by posting rather than by provider; min_salary/max_salary filter on it and require salary_currency, since comparing raw compensation numbers across currencies is meaningless. Location is also exposed as structured city/state/country fields alongside the free-text location string, so city/state/country filter on an exact match of those parsed components rather than substring-matching the display string. job_family is an exact level-2 ISCO family label assigned from ESCO occupation evidence; ambiguous postings remain unclassified and do not match that filter. employment_type is never populated for google-jobs/meta-jobs, and posted_at (so sort=posted_desc) is never populated for meta-jobs/tesla-jobs -- their upstream APIs expose no such field. provider enum: `greenhouse`, `lever`, `ashby`, `workday`, `smartrecruiters`, `workable`, `recruitee`, `rippling`, `personio`, `teamtailor`, `oracle`, `ukg`, `icims`, `eightfold`, `gem`, `pinpoint`, `amazon-jobs`, `apple-jobs`, `google-jobs`, `meta-jobs`, `tesla-jobs`. workplace_type enum: `onsite`, `hybrid`, `remote`. sort enum: `relevance`, `posted_desc`, `company_asc`. Billing: this search costs 1 credit per 10 records returned, rounded up, with a minimum of 1 (up to 10 records cost 1, a full page of 100 costs 10).",
|
|
277110
277292
|
"operationId": "datasets-jobs-search",
|
|
277111
277293
|
"parameters": [
|
|
277112
277294
|
{
|
|
@@ -277556,7 +277738,7 @@
|
|
|
277556
277738
|
"consumes": [
|
|
277557
277739
|
"application/json"
|
|
277558
277740
|
],
|
|
277559
|
-
"description": "Searches the journalists index (dataset id enum value `journalists`) — public journalist and reporter records crawled from news outlets' own staff/author pages, for PR outreach. Each record carries the outlet, title, best-effort beat topics, and any public contact info found on that outlet's own page, plus deterministic record_type, role_type, email_kind, and outreach-readiness quality signals. There is no cross-outlet upstream search; this dataset is built by crawling a curated roster of outlets ourselves. vertical enum: `tech`, `crypto`, `marketing`, `consumer_tech`, `consumer_policy`, `cybersecurity`, `health`, `gaming`, `climate`, `business`, `entertainment`, `sports`, `legal`, `science`, `politics`, `real_estate`, `automotive`, `travel`, `food`, `education`, `design`, `film_tv`, `fashion`, `music`, `personal_finance`, `tech_independent`, `culture_independent`, `local_news`, `construction`, `banking`, `retail`, `aerospace_defense`, `energy`, `agriculture`, `local_business`. contact_type enum: `email`, `social`, `none`. record_type enum: `person`, `desk`, `organization`, `syndicated_byline`, `unknown`. role_type enum: `staff`, `editor`, `reporter`, `contributor`, `freelancer`, `columnist`, `non_editorial`, `unknown`. email_kind enum: `individual_work`, `individual_personal_public`, `shared_desk`, `tips_or_submissions`, `outlet_generic`, `unknown`. sort enum: `relevance`, `name_asc`, `outlet_asc`, `crawled_desc`, `readiness_desc`.",
|
|
277741
|
+
"description": "Searches the journalists index (dataset id enum value `journalists`) — public journalist and reporter records crawled from news outlets' own staff/author pages, for PR outreach. Each record carries the outlet, title, best-effort beat topics, and any public contact info found on that outlet's own page, plus deterministic record_type, role_type, email_kind, and outreach-readiness quality signals. There is no cross-outlet upstream search; this dataset is built by crawling a curated roster of outlets ourselves. vertical enum: `tech`, `crypto`, `marketing`, `consumer_tech`, `consumer_policy`, `cybersecurity`, `health`, `gaming`, `climate`, `business`, `entertainment`, `sports`, `legal`, `science`, `politics`, `real_estate`, `automotive`, `travel`, `food`, `education`, `design`, `film_tv`, `fashion`, `music`, `personal_finance`, `tech_independent`, `culture_independent`, `local_news`, `construction`, `banking`, `retail`, `aerospace_defense`, `energy`, `agriculture`, `local_business`. contact_type enum: `email`, `social`, `none`. record_type enum: `person`, `desk`, `organization`, `syndicated_byline`, `unknown`. role_type enum: `staff`, `editor`, `reporter`, `contributor`, `freelancer`, `columnist`, `non_editorial`, `unknown`. email_kind enum: `individual_work`, `individual_personal_public`, `shared_desk`, `tips_or_submissions`, `outlet_generic`, `unknown`. sort enum: `relevance`, `name_asc`, `outlet_asc`, `crawled_desc`, `readiness_desc`. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
277560
277742
|
"operationId": "datasets-journalists-search",
|
|
277561
277743
|
"parameters": [
|
|
277562
277744
|
{
|
|
@@ -278157,7 +278339,7 @@
|
|
|
278157
278339
|
"consumes": [
|
|
278158
278340
|
"application/json"
|
|
278159
278341
|
],
|
|
278160
|
-
"description": "Searches the AI-readiness census of the top 1M sites (dataset id enum value `llms`) — one record per site describing whether it serves a real `/llms.txt` or `/llms-full.txt` (who produced it, what it links to and mentions) and what its `/robots.txt` says to 17 AI crawlers, next to a homepage control request. Search results omit the file bodies; read one site with the item endpoint. `blocked` and `error` states mean unknown, never absent. Sort enum: `relevance`, `rank_asc`, `links_desc`, `bytes_desc`, `domain_asc`, `crawled_desc`. state and robots_state enum: `present`, `absent`, `blocked`, `error`, `skipped`. source_kind enum: `shopify_agent_template`, `seo_plugin`, `platform_default`, `parked`, `custom`. generator enum: `yoast`, `aioseo`, `rankmath`, `wix`, `shopify`, `parked`. robots_default enum: `allowed`, `partial`, `blocked`. content_signal_train enum: `yes`, `no`. Crawler enum for blocks_all, blocks_any and not_blocked: `GPTBot`, `OAI-SearchBot`, `ChatGPT-User`, `ClaudeBot`, `Claude-SearchBot`, `Claude-User`, `anthropic-ai`, `Google-Extended`, `PerplexityBot`, `Perplexity-User`, `CCBot`, `Bytespider`, `Applebot-Extended`, `Amazonbot`, `meta-externalagent`, `cohere-ai`, `Diffbot`. Site owners can ask for removal at privacy@crawlora.net.",
|
|
278342
|
+
"description": "Searches the AI-readiness census of the top 1M sites (dataset id enum value `llms`) — one record per site describing whether it serves a real `/llms.txt` or `/llms-full.txt` (who produced it, what it links to and mentions) and what its `/robots.txt` says to 17 AI crawlers, next to a homepage control request. Search results omit the file bodies; read one site with the item endpoint. `blocked` and `error` states mean unknown, never absent. Sort enum: `relevance`, `rank_asc`, `links_desc`, `bytes_desc`, `domain_asc`, `crawled_desc`. state and robots_state enum: `present`, `absent`, `blocked`, `error`, `skipped`. source_kind enum: `shopify_agent_template`, `seo_plugin`, `platform_default`, `parked`, `custom`. generator enum: `yoast`, `aioseo`, `rankmath`, `wix`, `shopify`, `parked`. robots_default enum: `allowed`, `partial`, `blocked`. content_signal_train enum: `yes`, `no`. Crawler enum for blocks_all, blocks_any and not_blocked: `GPTBot`, `OAI-SearchBot`, `ChatGPT-User`, `ClaudeBot`, `Claude-SearchBot`, `Claude-User`, `anthropic-ai`, `Google-Extended`, `PerplexityBot`, `Perplexity-User`, `CCBot`, `Bytespider`, `Applebot-Extended`, `Amazonbot`, `meta-externalagent`, `cohere-ai`, `Diffbot`. Site owners can ask for removal at privacy@crawlora.net. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
278161
278343
|
"operationId": "datasets-llms-search",
|
|
278162
278344
|
"parameters": [
|
|
278163
278345
|
{
|
|
@@ -278690,7 +278872,7 @@
|
|
|
278690
278872
|
"consumes": [
|
|
278691
278873
|
"application/json"
|
|
278692
278874
|
],
|
|
278693
|
-
"description": "Searches the composite Numbeo cities dataset, merged from the current global rankings of all seven index families (cost of living, quality of life, crime, health care, pollution, traffic, property investment). A city appears once it is ranked by at least one family; coverage varies per city. Sort enum: `name_asc`, `cost_of_living_asc`, `cost_of_living_desc`, `quality_of_life_desc`, `safety_desc`, `crime_asc`, `health_care_desc`, `pollution_asc`, `traffic_asc`.",
|
|
278875
|
+
"description": "Searches the composite Numbeo cities dataset, merged from the current global rankings of all seven index families (cost of living, quality of life, crime, health care, pollution, traffic, property investment). A city appears once it is ranked by at least one family; coverage varies per city. Sort enum: `name_asc`, `cost_of_living_asc`, `cost_of_living_desc`, `quality_of_life_desc`, `safety_desc`, `crime_asc`, `health_care_desc`, `pollution_asc`, `traffic_asc`. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
278694
278876
|
"operationId": "datasets-numbeo-cities-search",
|
|
278695
278877
|
"parameters": [
|
|
278696
278878
|
{
|
|
@@ -278897,7 +279079,7 @@
|
|
|
278897
279079
|
"consumes": [
|
|
278898
279080
|
"application/json"
|
|
278899
279081
|
],
|
|
278900
|
-
"description": "Searches the composite Numbeo countries dataset, merged from the current global by-country rankings of all seven index families. Sort enum: `name_asc`, `cost_of_living_asc`, `cost_of_living_desc`, `quality_of_life_desc`, `safety_desc`, `crime_asc`, `health_care_desc`, `pollution_asc`, `traffic_asc`.",
|
|
279082
|
+
"description": "Searches the composite Numbeo countries dataset, merged from the current global by-country rankings of all seven index families. Sort enum: `name_asc`, `cost_of_living_asc`, `cost_of_living_desc`, `quality_of_life_desc`, `safety_desc`, `crime_asc`, `health_care_desc`, `pollution_asc`, `traffic_asc`. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
278901
279083
|
"operationId": "datasets-numbeo-countries-search",
|
|
278902
279084
|
"parameters": [
|
|
278903
279085
|
{
|
|
@@ -279203,7 +279385,7 @@
|
|
|
279203
279385
|
"consumes": [
|
|
279204
279386
|
"application/json"
|
|
279205
279387
|
],
|
|
279206
|
-
"description": "Searches the crawled public PitchBook advisor (service provider — e.g. investment bank, lender, financing advisory firm) profile catalog stored in a search index. Discovered from PitchBook's public sitemap. Sort enum: `relevance`, `name_asc`, `year_founded_desc`, `recently_crawled_desc`.",
|
|
279388
|
+
"description": "Searches the crawled public PitchBook advisor (service provider — e.g. investment bank, lender, financing advisory firm) profile catalog stored in a search index. Discovered from PitchBook's public sitemap. Sort enum: `relevance`, `name_asc`, `year_founded_desc`, `recently_crawled_desc`. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
279207
279389
|
"operationId": "datasets-pitchbook-advisors-search",
|
|
279208
279390
|
"parameters": [
|
|
279209
279391
|
{
|
|
@@ -279513,7 +279695,7 @@
|
|
|
279513
279695
|
"consumes": [
|
|
279514
279696
|
"application/json"
|
|
279515
279697
|
],
|
|
279516
|
-
"description": "Searches the crawled public PitchBook company profile catalog stored in a search index. Discovered from PitchBook's public sitemap. Sort enum: `relevance`, `name_asc`, `year_founded_desc`, `investor_count_desc`, `recently_crawled_desc`.",
|
|
279698
|
+
"description": "Searches the crawled public PitchBook company profile catalog stored in a search index. Discovered from PitchBook's public sitemap. Sort enum: `relevance`, `name_asc`, `year_founded_desc`, `investor_count_desc`, `recently_crawled_desc`. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
279517
279699
|
"operationId": "datasets-pitchbook-companies-search",
|
|
279518
279700
|
"parameters": [
|
|
279519
279701
|
{
|
|
@@ -279814,7 +279996,7 @@
|
|
|
279814
279996
|
"consumes": [
|
|
279815
279997
|
"application/json"
|
|
279816
279998
|
],
|
|
279817
|
-
"description": "Searches the crawled public PitchBook fund profile catalog stored in a search index. Discovered from PitchBook's public sitemap. Sort enum: `relevance`, `name_asc`, `vintage_desc`, `recently_crawled_desc`.",
|
|
279999
|
+
"description": "Searches the crawled public PitchBook fund profile catalog stored in a search index. Discovered from PitchBook's public sitemap. Sort enum: `relevance`, `name_asc`, `vintage_desc`, `recently_crawled_desc`. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
279818
280000
|
"operationId": "datasets-pitchbook-funds-search",
|
|
279819
280001
|
"parameters": [
|
|
279820
280002
|
{
|
|
@@ -280098,7 +280280,7 @@
|
|
|
280098
280280
|
"consumes": [
|
|
280099
280281
|
"application/json"
|
|
280100
280282
|
],
|
|
280101
|
-
"description": "Searches the crawled public PitchBook investor (fund manager/firm) profile catalog stored in a search index. Discovered from PitchBook's public sitemap. Sort enum: `relevance`, `name_asc`, `portfolio_count_desc`, `recently_crawled_desc`.",
|
|
280283
|
+
"description": "Searches the crawled public PitchBook investor (fund manager/firm) profile catalog stored in a search index. Discovered from PitchBook's public sitemap. Sort enum: `relevance`, `name_asc`, `portfolio_count_desc`, `recently_crawled_desc`. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
280102
280284
|
"operationId": "datasets-pitchbook-investors-search",
|
|
280103
280285
|
"parameters": [
|
|
280104
280286
|
{
|
|
@@ -280387,7 +280569,7 @@
|
|
|
280387
280569
|
"consumes": [
|
|
280388
280570
|
"application/json"
|
|
280389
280571
|
],
|
|
280390
|
-
"description": "Searches the crawled public PitchBook limited partner (institutional investor — e.g. pension fund, endowment, insurance company) profile catalog stored in a search index. Discovered from PitchBook's public sitemap. Some limited partner profiles have no FAQ section -- this is normal, not a sign of missing data. Sort enum: `relevance`, `name_asc`, `year_founded_desc`, `recently_crawled_desc`.",
|
|
280572
|
+
"description": "Searches the crawled public PitchBook limited partner (institutional investor — e.g. pension fund, endowment, insurance company) profile catalog stored in a search index. Discovered from PitchBook's public sitemap. Some limited partner profiles have no FAQ section -- this is normal, not a sign of missing data. Sort enum: `relevance`, `name_asc`, `year_founded_desc`, `recently_crawled_desc`. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
280391
280573
|
"operationId": "datasets-pitchbook-limited-partners-search",
|
|
280392
280574
|
"parameters": [
|
|
280393
280575
|
{
|
|
@@ -280798,7 +280980,7 @@
|
|
|
280798
280980
|
"consumes": [
|
|
280799
280981
|
"application/json"
|
|
280800
280982
|
],
|
|
280801
|
-
"description": "Searches the crawled public PlayStation Store catalog stored in a search index. One row per product SKU (game, edition or add-on); concept_id / np_title_id group a title's SKUs. price_tier enum: `free`, `under_5`, `5_to_10`, `10_to_20`, `20_to_40`, `40_to_60`, `60_plus`. Sort enum: `relevance`, `rating_desc`, `reviews_desc`, `price_asc`, `price_desc`, `discount_desc`, `release_desc`, `release_asc`.",
|
|
280983
|
+
"description": "Searches the crawled public PlayStation Store catalog stored in a search index. One row per product SKU (game, edition or add-on); concept_id / np_title_id group a title's SKUs. price_tier enum: `free`, `under_5`, `5_to_10`, `10_to_20`, `20_to_40`, `40_to_60`, `60_plus`. Sort enum: `relevance`, `rating_desc`, `reviews_desc`, `price_asc`, `price_desc`, `discount_desc`, `release_desc`, `release_asc`. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
280802
280984
|
"operationId": "datasets-playstation-games-search",
|
|
280803
280985
|
"parameters": [
|
|
280804
280986
|
{
|
|
@@ -281182,7 +281364,7 @@
|
|
|
281182
281364
|
"consumes": [
|
|
281183
281365
|
"application/json"
|
|
281184
281366
|
],
|
|
281185
|
-
"description": "Searches Product Hunt makers from the dataset id enum value `producthunt-makers` — public-profile records of the people who made products, with their footprint (products made, total upvotes, topics) for maker leaderboards. Public fields only. Sort enum: `total_votes_desc`, `product_count_desc`, `followers_desc`, `relevance`.",
|
|
281367
|
+
"description": "Searches Product Hunt makers from the dataset id enum value `producthunt-makers` — public-profile records of the people who made products, with their footprint (products made, total upvotes, topics) for maker leaderboards. Public fields only. Sort enum: `total_votes_desc`, `product_count_desc`, `followers_desc`, `relevance`. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
281186
281368
|
"operationId": "datasets-producthunt-makers-search",
|
|
281187
281369
|
"parameters": [
|
|
281188
281370
|
{
|
|
@@ -281465,7 +281647,7 @@
|
|
|
281465
281647
|
"consumes": [
|
|
281466
281648
|
"application/json"
|
|
281467
281649
|
],
|
|
281468
|
-
"description": "Searches individual Product Hunt launches from the dataset id enum value `producthunt-products` — the searchable launch archive. Each result is one product with its topics, upvotes, ranks and launch history; description/website/twitter_url/pricing/makers are filled in as hydration runs. Sort enum: `relevance`, `votes_desc`, `launched_desc`, `launched_asc`, `rating_desc`, `best_rank_asc`.",
|
|
281650
|
+
"description": "Searches individual Product Hunt launches from the dataset id enum value `producthunt-products` — the searchable launch archive. Each result is one product with its topics, upvotes, ranks and launch history; description/website/twitter_url/pricing/makers are filled in as hydration runs. Sort enum: `relevance`, `votes_desc`, `launched_desc`, `launched_asc`, `rating_desc`, `best_rank_asc`. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
281469
281651
|
"operationId": "datasets-producthunt-products-search",
|
|
281470
281652
|
"parameters": [
|
|
281471
281653
|
{
|
|
@@ -281702,7 +281884,7 @@
|
|
|
281702
281884
|
"consumes": [
|
|
281703
281885
|
"application/json"
|
|
281704
281886
|
],
|
|
281705
|
-
"description": "Returns aggregate Product Hunt launch trends from the dataset id enum value `producthunt-trends`. Aggregate-only: each row is a category-over-time cell (a topic, optionally within a calendar period), reporting launch count, total and average upvotes, average rating and the top product — never an individual product record. Thin cells are suppressed. group_by enum: `topic_month`, `topic_year`, `topic`. Sort enum: `period_desc`, `period_asc`, `launch_count_desc`, `sum_votes_desc`.",
|
|
281887
|
+
"description": "Returns aggregate Product Hunt launch trends from the dataset id enum value `producthunt-trends`. Aggregate-only: each row is a category-over-time cell (a topic, optionally within a calendar period), reporting launch count, total and average upvotes, average rating and the top product — never an individual product record. Thin cells are suppressed. group_by enum: `topic_month`, `topic_year`, `topic`. Sort enum: `period_desc`, `period_asc`, `launch_count_desc`, `sum_votes_desc`. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
281706
281888
|
"operationId": "datasets-producthunt-trends-search",
|
|
281707
281889
|
"parameters": [
|
|
281708
281890
|
{
|
|
@@ -281816,7 +281998,7 @@
|
|
|
281816
281998
|
"consumes": [
|
|
281817
281999
|
"application/json"
|
|
281818
282000
|
],
|
|
281819
|
-
"description": "Searches daily snapshots of each tracked subreddit's hot-feed post order, stored in a search index (one document per subreddit × snapshot × rank) so history accumulates. With no `date` the latest snapshot is returned (today's trending); pair `subreddit` with `sort=date_desc` for a subreddit's trending history over time. There is no score or comment-count field — the underlying credential-free scraper does not expose vote counts, so `rank` reflects Reddit's own hot-feed order rather than a locally computed score.",
|
|
282001
|
+
"description": "Searches daily snapshots of each tracked subreddit's hot-feed post order, stored in a search index (one document per subreddit × snapshot × rank) so history accumulates. With no `date` the latest snapshot is returned (today's trending); pair `subreddit` with `sort=date_desc` for a subreddit's trending history over time. There is no score or comment-count field — the underlying credential-free scraper does not expose vote counts, so `rank` reflects Reddit's own hot-feed order rather than a locally computed score. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
281820
282002
|
"operationId": "datasets-reddit-trending-search",
|
|
281821
282003
|
"parameters": [
|
|
281822
282004
|
{
|
|
@@ -282272,7 +282454,7 @@
|
|
|
282272
282454
|
"consumes": [
|
|
282273
282455
|
"application/json"
|
|
282274
282456
|
],
|
|
282275
|
-
"description": "Searches SEC-reporting companies stored in a search index — normalized filing history, financial-statement rollups (latest annual/quarterly revenue, net income, total assets) and trailing-90-day insider (Form 3/4/5) activity. Sort enum: `relevance`, `name_asc`, `revenue_desc`, `net_income_desc`, `filing_recent_desc`, `insider_activity_desc`. `entity_type`, `sic`, `sic_description`, `exchange`, and `state_of_incorporation` are open filters over the exact values EDGAR reports for each filer (not a fixed enum) — discover real values via the matching facet.",
|
|
282457
|
+
"description": "Searches SEC-reporting companies stored in a search index — normalized filing history, financial-statement rollups (latest annual/quarterly revenue, net income, total assets) and trailing-90-day insider (Form 3/4/5) activity. Sort enum: `relevance`, `name_asc`, `revenue_desc`, `net_income_desc`, `filing_recent_desc`, `insider_activity_desc`. `entity_type`, `sic`, `sic_description`, `exchange`, and `state_of_incorporation` are open filters over the exact values EDGAR reports for each filer (not a fixed enum) — discover real values via the matching facet. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
282276
282458
|
"operationId": "datasets-sec-companies-search",
|
|
282277
282459
|
"parameters": [
|
|
282278
282460
|
{
|
|
@@ -282522,7 +282704,7 @@
|
|
|
282522
282704
|
"consumes": [
|
|
282523
282705
|
"application/json"
|
|
282524
282706
|
],
|
|
282525
|
-
"description": "Searches institutional investment managers' quarterly 13F portfolio holdings stored in a search index. Filter by manager_cik for a manager's full reported portfolio (an exact, reliable filter), or by issuer_name/cusip for a best-effort view of which managers reported a position in an issuer — SEC publishes no authoritative CUSIP-to-CIK mapping, so the issuer side is never a guaranteed-resolved join. Sort enum: `value_desc`, `value_asc`, `shares_desc`.",
|
|
282707
|
+
"description": "Searches institutional investment managers' quarterly 13F portfolio holdings stored in a search index. Filter by manager_cik for a manager's full reported portfolio (an exact, reliable filter), or by issuer_name/cusip for a best-effort view of which managers reported a position in an issuer — SEC publishes no authoritative CUSIP-to-CIK mapping, so the issuer side is never a guaranteed-resolved join. Sort enum: `value_desc`, `value_asc`, `shares_desc`. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
282526
282708
|
"operationId": "datasets-sec-institutional-positions-search",
|
|
282527
282709
|
"parameters": [
|
|
282528
282710
|
{
|
|
@@ -282779,7 +282961,7 @@
|
|
|
282779
282961
|
"consumes": [
|
|
282780
282962
|
"application/json"
|
|
282781
282963
|
],
|
|
282782
|
-
"description": "Returns stored Starbucks stores within a radius of a point, nearest first, from dataset id `starbucks-stores`. lat, lon, and radius_m are required. Unlike the live /starbucks/stores endpoint (which caps at 50 near a point), this queries the full grid-tiled directory, so it can return every store in the radius.",
|
|
282964
|
+
"description": "Returns stored Starbucks stores within a radius of a point, nearest first, from dataset id `starbucks-stores`. lat, lon, and radius_m are required. Unlike the live /starbucks/stores endpoint (which caps at 50 near a point), this queries the full grid-tiled directory, so it can return every store in the radius. Billing: this endpoint costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
282783
282965
|
"operationId": "datasets-starbucks-stores-nearby",
|
|
282784
282966
|
"parameters": [
|
|
282785
282967
|
{
|
|
@@ -282876,7 +283058,7 @@
|
|
|
282876
283058
|
"consumes": [
|
|
282877
283059
|
"application/json"
|
|
282878
283060
|
],
|
|
282879
|
-
"description": "Searches the worldwide Starbucks store directory (dataset id `starbucks-stores`), built by grid-tiling the store locator around its 50-result cap. Each store has its store number, name, phone, full address, coordinates, weekly hours, amenity codes, and pick-up options. Store discovery is global, but hours, amenities, and phone numbers are populated per market and are largely absent outside the US, Canada, Europe, and the Gulf; an empty schedule means \"not published for this market\", not \"closed\". `country` is the store's true country while `market` is crawl provenance (the US host geocodes worldwide). Supports full-text `q`, `country`/`state`/`city`/`market`/`amenity` filters, `lat`/`lon`/`radius_m` radius filtering, and `sort` (relevance, distance_asc).",
|
|
283061
|
+
"description": "Searches the worldwide Starbucks store directory (dataset id `starbucks-stores`), built by grid-tiling the store locator around its 50-result cap. Each store has its store number, name, phone, full address, coordinates, weekly hours, amenity codes, and pick-up options. Store discovery is global, but hours, amenities, and phone numbers are populated per market and are largely absent outside the US, Canada, Europe, and the Gulf; an empty schedule means \"not published for this market\", not \"closed\". `country` is the store's true country while `market` is crawl provenance (the US host geocodes worldwide). Supports full-text `q`, `country`/`state`/`city`/`market`/`amenity` filters, `lat`/`lon`/`radius_m` radius filtering, and `sort` (relevance, distance_asc). Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
282880
283062
|
"operationId": "datasets-starbucks-stores-search",
|
|
282881
283063
|
"parameters": [
|
|
282882
283064
|
{
|
|
@@ -283005,7 +283187,7 @@
|
|
|
283005
283187
|
"consumes": [
|
|
283006
283188
|
"application/json"
|
|
283007
283189
|
],
|
|
283008
|
-
"description": "Searches per-game global achievement unlock percentages (one document per appid × achievement). Pass `app_id` to list a game's achievements. Sort enum: `percent_desc` (most-unlocked first, default), `percent_asc` (rarest first), `rank_asc`.",
|
|
283190
|
+
"description": "Searches per-game global achievement unlock percentages (one document per appid × achievement). Pass `app_id` to list a game's achievements. Sort enum: `percent_desc` (most-unlocked first, default), `percent_asc` (rarest first), `rank_asc`. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
283009
283191
|
"operationId": "datasets-steam-achievements-search",
|
|
283010
283192
|
"parameters": [
|
|
283011
283193
|
{
|
|
@@ -283083,7 +283265,7 @@
|
|
|
283083
283265
|
"consumes": [
|
|
283084
283266
|
"application/json"
|
|
283085
283267
|
],
|
|
283086
|
-
"description": "Searches daily snapshots of Steam's player-count and sales charts, stored in a search index (one document per chart × country × snapshot × rank) so history accumulates. Charts: `most_played` (weekly peak concurrent), `concurrent` (live concurrent players), `top_sellers` (weekly sales; country-specific). With no `date` the latest snapshot is returned (today's chart); pair `app_id` with `sort=date_desc` for an app's rank/players over time. Country is `global` for the player-count charts or an ISO code (e.g. `us`) for `top_sellers`. Sort enum: `rank`, `rank_desc`, `date_desc`.",
|
|
283268
|
+
"description": "Searches daily snapshots of Steam's player-count and sales charts, stored in a search index (one document per chart × country × snapshot × rank) so history accumulates. Charts: `most_played` (weekly peak concurrent), `concurrent` (live concurrent players), `top_sellers` (weekly sales; country-specific). With no `date` the latest snapshot is returned (today's chart); pair `app_id` with `sort=date_desc` for an app's rank/players over time. Country is `global` for the player-count charts or an ISO code (e.g. `us`) for `top_sellers`. Sort enum: `rank`, `rank_desc`, `date_desc`. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
283087
283269
|
"operationId": "datasets-steam-charts-search",
|
|
283088
283270
|
"parameters": [
|
|
283089
283271
|
{
|
|
@@ -283505,7 +283687,7 @@
|
|
|
283505
283687
|
"consumes": [
|
|
283506
283688
|
"application/json"
|
|
283507
283689
|
],
|
|
283508
|
-
"description": "Searches enriched public Steam catalog records stored in a search index. price_tier enum: `free`, `under5`, `5to15`, `15to30`, `30to60`, `over60`. review_tier enum: `overwhelmingly_positive`, `very_positive`, `positive`, `mostly_positive`, `mixed`, `mostly_negative`, `negative`, `very_negative`, `overwhelmingly_negative`, `insufficient`. Sort enum: `relevance`, `owners_desc`, `reviews_desc`, `review_score_desc`, `ccu_desc`, `metacritic_desc`, `price_asc`, `price_desc`, `release_desc`, `release_asc`.",
|
|
283690
|
+
"description": "Searches enriched public Steam catalog records stored in a search index. price_tier enum: `free`, `under5`, `5to15`, `15to30`, `30to60`, `over60`. review_tier enum: `overwhelmingly_positive`, `very_positive`, `positive`, `mostly_positive`, `mixed`, `mostly_negative`, `negative`, `very_negative`, `overwhelmingly_negative`, `insufficient`. Sort enum: `relevance`, `owners_desc`, `reviews_desc`, `review_score_desc`, `ccu_desc`, `metacritic_desc`, `price_asc`, `price_desc`, `release_desc`, `release_asc`. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
283509
283691
|
"operationId": "datasets-steam-games-search",
|
|
283510
283692
|
"parameters": [
|
|
283511
283693
|
{
|
|
@@ -283760,7 +283942,7 @@
|
|
|
283760
283942
|
"consumes": [
|
|
283761
283943
|
"application/json"
|
|
283762
283944
|
],
|
|
283763
|
-
"description": "Searches Steam news + announcements for tracked apps (one document per appid × gid; the latest items per app are kept). Filter by `app_id` for a single game's news, or full-text `q` over the title + contents. Sort enum: `date_desc` (newest first, default), `date_asc`.",
|
|
283945
|
+
"description": "Searches Steam news + announcements for tracked apps (one document per appid × gid; the latest items per app are kept). Filter by `app_id` for a single game's news, or full-text `q` over the title + contents. Sort enum: `date_desc` (newest first, default), `date_asc`. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
283764
283946
|
"operationId": "datasets-steam-news-search",
|
|
283765
283947
|
"parameters": [
|
|
283766
283948
|
{
|
|
@@ -283843,7 +284025,7 @@
|
|
|
283843
284025
|
"consumes": [
|
|
283844
284026
|
"application/json"
|
|
283845
284027
|
],
|
|
283846
|
-
"description": "Searches the daily concurrent-player time series for tracked games (one document per appid × day). Pair `app_id` with `sort=date_desc` for a game's player-count history, or pass `date` for one day's snapshot. Sort enum: `date_desc` (default), `date_asc`, `players_desc`.",
|
|
284028
|
+
"description": "Searches the daily concurrent-player time series for tracked games (one document per appid × day). Pair `app_id` with `sort=date_desc` for a game's player-count history, or pass `date` for one day's snapshot. Sort enum: `date_desc` (default), `date_asc`, `players_desc`. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
283847
284029
|
"operationId": "datasets-steam-playercounts-search",
|
|
283848
284030
|
"parameters": [
|
|
283849
284031
|
{
|
|
@@ -283927,7 +284109,7 @@
|
|
|
283927
284109
|
"consumes": [
|
|
283928
284110
|
"application/json"
|
|
283929
284111
|
],
|
|
283930
|
-
"description": "Searches the daily price time series for priced games (one document per appid × day; integer cents). Pair `app_id` with `sort=date_desc` for a game's price history, or pass `date` for one day's snapshot. Sort enum: `date_desc` (default), `date_asc`, `price_asc`, `price_desc`, `discount_desc`.",
|
|
284112
|
+
"description": "Searches the daily price time series for priced games (one document per appid × day; integer cents). Pair `app_id` with `sort=date_desc` for a game's price history, or pass `date` for one day's snapshot. Sort enum: `date_desc` (default), `date_asc`, `price_asc`, `price_desc`, `discount_desc`. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
283931
284113
|
"operationId": "datasets-steam-prices-search",
|
|
283932
284114
|
"parameters": [
|
|
283933
284115
|
{
|
|
@@ -284013,7 +284195,7 @@
|
|
|
284013
284195
|
"consumes": [
|
|
284014
284196
|
"application/json"
|
|
284015
284197
|
],
|
|
284016
|
-
"description": "Searches the stored Steam review corpus (the most-helpful reviews per game; one document per appid × recommendation). Full-text `q` over the review body, filter by `app_id`, `language`, or `voted_up` (positive/negative). Sort enum: `votes_desc` (most-helpful first, default), `weighted_desc`, `date_desc`.",
|
|
284198
|
+
"description": "Searches the stored Steam review corpus (the most-helpful reviews per game; one document per appid × recommendation). Full-text `q` over the review body, filter by `app_id`, `language`, or `voted_up` (positive/negative). Sort enum: `votes_desc` (most-helpful first, default), `weighted_desc`, `date_desc`. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
284017
284199
|
"operationId": "datasets-steam-reviews-search",
|
|
284018
284200
|
"parameters": [
|
|
284019
284201
|
{
|
|
@@ -284366,7 +284548,7 @@
|
|
|
284366
284548
|
"consumes": [
|
|
284367
284549
|
"application/json"
|
|
284368
284550
|
],
|
|
284369
|
-
"description": "Searches the website tech-stack index (dataset id enum value `techstack`) — one record per site listing the web technologies it is built with (frameworks, CMS, e-commerce, analytics, CDNs, servers, and more), BuiltWith / Wappalyzer-style. The reverse-index filters are the point: repeat `technology` to require several at once (AND), `any_of` to match at least one (OR), and `not` to exclude — e.g. sites on `Shopify` and `Klaviyo` but not `Recharge`. Sort enum: `relevance`, `rank_asc`, `tech_count_desc`, `domain_asc`, `crawled_desc`. render_tier enum: `http`, `browser`.",
|
|
284551
|
+
"description": "Searches the website tech-stack index (dataset id enum value `techstack`) — one record per site listing the web technologies it is built with (frameworks, CMS, e-commerce, analytics, CDNs, servers, and more), BuiltWith / Wappalyzer-style. The reverse-index filters are the point: repeat `technology` to require several at once (AND), `any_of` to match at least one (OR), and `not` to exclude — e.g. sites on `Shopify` and `Klaviyo` but not `Recharge`. Sort enum: `relevance`, `rank_asc`, `tech_count_desc`, `domain_asc`, `crawled_desc`. render_tier enum: `http`, `browser`. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
284370
284552
|
"operationId": "datasets-techstack-search",
|
|
284371
284553
|
"parameters": [
|
|
284372
284554
|
{
|
|
@@ -284809,7 +284991,7 @@
|
|
|
284809
284991
|
"consumes": [
|
|
284810
284992
|
"application/json"
|
|
284811
284993
|
],
|
|
284812
|
-
"description": "Searches public startups with payment-provider-verified revenue and MRR, stored in a search index. Filter by category, country, payment provider, target audience, tech, marketing channel, listing tier and for-sale status, and by revenue/MRR/traffic/growth/multiple/asking-price ranges. Sort enum: `relevance`, `mrr_desc`, `revenue_desc`, `revenue_30d_desc`, `traffic_desc`, `growth_desc`, `deal_score_desc`, `price_asc`, `price_desc`, `multiple_asc`, `founded_desc`. status enum: `active`, `removed`.",
|
|
284994
|
+
"description": "Searches public startups with payment-provider-verified revenue and MRR, stored in a search index. Filter by category, country, payment provider, target audience, tech, marketing channel, listing tier and for-sale status, and by revenue/MRR/traffic/growth/multiple/asking-price ranges. Sort enum: `relevance`, `mrr_desc`, `revenue_desc`, `revenue_30d_desc`, `traffic_desc`, `growth_desc`, `deal_score_desc`, `price_asc`, `price_desc`, `multiple_asc`, `founded_desc`. status enum: `active`, `removed`. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
284813
284995
|
"operationId": "datasets-trustmrr-search",
|
|
284814
284996
|
"parameters": [
|
|
284815
284997
|
{
|
|
@@ -285345,7 +285527,7 @@
|
|
|
285345
285527
|
"consumes": [
|
|
285346
285528
|
"application/json"
|
|
285347
285529
|
],
|
|
285348
|
-
"description": "Searches the crawled used-vehicle listings index. source enum: `carmax`, `autotrader`, `carsdotcom`. CarMax's own national inventory is fully enumerable (re-crawled on a standing schedule); Autotrader/Cars.com coverage is a best-effort zip-code sweep, not exhaustive, and their rows approximate city/state from the searched area rather than the seller's exact location. seller_type enum: `retailer`, `dealer`, `private` (not populated for every row -- see the dataset markdown). Sort enum: `relevance`, `recently_updated`, `newly_listed`, `price_asc`, `price_desc`, `mileage_asc`, `mileage_desc`, `year_desc`, `year_asc`.",
|
|
285530
|
+
"description": "Searches the crawled used-vehicle listings index. source enum: `carmax`, `autotrader`, `carsdotcom`. CarMax's own national inventory is fully enumerable (re-crawled on a standing schedule); Autotrader/Cars.com coverage is a best-effort zip-code sweep, not exhaustive, and their rows approximate city/state from the searched area rather than the seller's exact location. seller_type enum: `retailer`, `dealer`, `private` (not populated for every row -- see the dataset markdown). Sort enum: `relevance`, `recently_updated`, `newly_listed`, `price_asc`, `price_desc`, `mileage_asc`, `mileage_desc`, `year_desc`, `year_asc`. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
285349
285531
|
"operationId": "datasets-vehicle-listings-search",
|
|
285350
285532
|
"parameters": [
|
|
285351
285533
|
{
|
|
@@ -285772,7 +285954,7 @@
|
|
|
285772
285954
|
"consumes": [
|
|
285773
285955
|
"application/json"
|
|
285774
285956
|
],
|
|
285775
|
-
"description": "Searches public X (Twitter) user profiles stored in a search index. Sort enum: `relevance`, `followers_desc`, `followers_asc`, `crawled_at_desc`, `crawled_at_asc`, `created_at_desc`, `created_at_asc`.",
|
|
285957
|
+
"description": "Searches public X (Twitter) user profiles stored in a search index. Sort enum: `relevance`, `followers_desc`, `followers_asc`, `crawled_at_desc`, `crawled_at_asc`, `created_at_desc`, `created_at_asc`. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
285776
285958
|
"operationId": "datasets-x-users-search",
|
|
285777
285959
|
"parameters": [
|
|
285778
285960
|
{
|
|
@@ -286185,7 +286367,7 @@
|
|
|
286185
286367
|
"consumes": [
|
|
286186
286368
|
"application/json"
|
|
286187
286369
|
],
|
|
286188
|
-
"description": "Searches public YouTube channel profiles stored in a search index — subscriber, video and view counts, region, bio and links, discovered via Common Crawl and Wikidata and hydrated from each channel's public About page. Sort enum: `relevance`, `followers_desc`, `followers_asc`, `views_desc`, `videos_desc`, `hydrated_at_desc`, `hydrated_at_asc`. Some channels hide their subscriber, video, or view count; the `_available` flags on each item distinguish a hidden count (stored as `0`, `*_available: false`) from a genuine `0`.",
|
|
286370
|
+
"description": "Searches public YouTube channel profiles stored in a search index — subscriber, video and view counts, region, bio and links, discovered via Common Crawl and Wikidata and hydrated from each channel's public About page. Sort enum: `relevance`, `followers_desc`, `followers_asc`, `views_desc`, `videos_desc`, `hydrated_at_desc`, `hydrated_at_asc`. Some channels hide their subscriber, video, or view count; the `_available` flags on each item distinguish a hidden count (stored as `0`, `*_available: false`) from a genuine `0`. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).",
|
|
286189
286371
|
"operationId": "datasets-youtube-creators-search",
|
|
286190
286372
|
"parameters": [
|
|
286191
286373
|
{
|