構造化データセット検索 API

レスポンスに関する注記

- Returns dataset metadata and the capabilities each dataset supports. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "items": [ { "id": "google-map-businesses", "name": "Google Maps Businesses", "capabilities": ["search", "detail", "facets", "nearby"] }, { "id": "github-users", "name": "GitHub Users", "capabilities": ["search", "detail", "facets", "nearby"] }, { "id": "apps", "name": "Mobile Apps", "capabilities": ["search"] }, { "id": "chrome-extensions", "name": "Chrome Extensions", "capabilities": ["search", "detail", "facets", "history", "trending", "changes"] }, { "id": "apps-charts", "name": "App Store Charts", "capabilities": ["search"] }, { "id": "apps-reviews", "name": "App Reviews", "capabilities": ["search"] }, { "id": "creators", "name": "TikTok Creators", "capabilities": ["search"] }, { "id": "airbnb-markets", "name": "Airbnb Markets", "capabilities": ["search", "detail", "facets", "nearby"] } ] } } ```

レスポンスに関する注記

- Defaults to `relevance` sort when `q` is supplied. - Defaults to `updated_at_desc` sort when no `q` is supplied. - `lat` and `lon` must be supplied together. `distance_asc` requires `lat` and `lon`, but does not require `radius_m`. - The maximum result window is `10000`; `page * page_size` must not exceed `10000`. - A `null` `rating` in a result means no aggregate rating is available for that business (too few reviews, or a place type Google does not rate) — it is never a literal zero-star score. A present `rating` is always between `1.0` and `5.0`. - A `null` `review_count` means Google did not return a count for that business. Numeric `0` means Google confirmed zero reviews; positive values are confirmed counts. `review_count_desc` sorts missing counts last. - `state` and `county` keep each country's own administrative vocabulary (`Provincia de Madrid`, `Département du Nord`, `Regierungsbezirk Köln`, plain `___ County` in the US). `state_code` and `county_code` are the matching ISO 3166-2 codes (`ES-MD`, `FR-59`) and are the stable key for grouping or ranking across countries. They are filled by reverse geocoding and are omitted from a row that has not been resolved yet. - Invalid enum values return the standard invalid params envelope. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "google-map-businesses", "items": [ { "place_id": "ChIJ99URUeOAhYAR0J5ZUxTesDQ", "name": "Hotel Zephyr San Francisco", "category": ["hotel"], "rating": 4.1, "review_count": 3213 } ], "page": 1, "page_size": 20, "total": 1, "sort": "relevance" } } ```

レスポンスに関する注記

- Sorts by `distance_asc`. - Includes `distance_m` on items when the search index returns geo-distance sort values. - A `null` `rating` in a result means no aggregate rating is available for that business (never a literal zero-star score); a present `rating` is always between `1.0` and `5.0`. - A `null` `review_count` means Google did not return a count for that business. Numeric `0` means Google confirmed zero reviews; positive values are confirmed counts. - `state` and `county` keep each country's own administrative vocabulary (`Provincia de Madrid`, `Département du Nord`, `Regierungsbezirk Köln`, plain `___ County` in the US). `state_code` and `county_code` are the matching ISO 3166-2 codes (`ES-MD`, `FR-59`) and are the stable key for grouping or ranking across countries. They are filled by reverse geocoding and are omitted from a row that has not been resolved yet. - The maximum result window is `10000`; `page * page_size` must not exceed `10000`. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "google-map-businesses", "items": [ { "place_id": "ChIJ99URUeOAhYAR0J5ZUxTesDQ", "name": "Hotel Zephyr San Francisco", "distance_m": 120.4 } ], "page": 1, "page_size": 20, "total": 1, "sort": "distance_asc" } } ```

レスポンスに関する注記

- For `facet=category`, returned `value`s are exact locale-specific Google Maps labels. Pass a selected value unchanged to the `category` filter. - `facet=state` and `facet=county` return each country's own administrative labels (`Provincia de Madrid`, `Département du Nord`, `Regierungsbezirk Köln`); `facet=state_code` and `facet=county_code` return the matching ISO 3166-2 codes (`ES-MD`, `FR-59`), which are the stable key for cross-country grouping. Rows not yet resolved carry no code and are absent from the code facets. - Invalid facet enum values return the standard invalid params envelope. - `lat` and `lon` must be supplied together. `distance_asc` requires `lat` and `lon`, but does not require `radius_m`. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "google-map-businesses", "facet": "city", "items": [ { "value": "San Francisco", "count": 42 } ] } } ```

レスポンスに関する注記

- The `category` field contains the locale-specific label returned by Google Maps and can be localized, non-ASCII, or contain punctuation. - A `null` `rating` means no aggregate rating is available for that business (never a literal zero-star score); a present `rating` is always between `1.0` and `5.0`. - A `null` `review_count` means Google did not return a count for that business. Numeric `0` means Google confirmed zero reviews; positive values are confirmed counts. - `state` and `county` keep each country's own administrative vocabulary (`Provincia de Madrid`, `Département du Nord`, `Regierungsbezirk Köln`, plain `___ County` in the US). `state_code` and `county_code` are the matching ISO 3166-2 codes (`ES-MD`, `FR-59`) and are the stable key for grouping or ranking across countries. They are filled by reverse geocoding and are omitted from a row that has not been resolved yet. - Returns `404` when the Place ID is not present in the stored dataset. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "place_id": "ChIJ99URUeOAhYAR0J5ZUxTesDQ", "name": "Hotel Zephyr San Francisco", "address": "250 Beach St, San Francisco, CA 94133", "website": "https://www.hotelzephyrsf.com/" } } ```

レスポンスに関する注記

- `facet` is required; unsupported values return the standard invalid params envelope. - `superhost` returns `superhost` and `not_superhost` bucket values. - `guest_favorite` returns `guest_favorite` and `not_guest_favorite` bucket values. The badge is an observed lower bound, so the `guest_favorite` count under-counts and `not_guest_favorite` correspondingly over-counts. - `rating_band` returns bucket values `<3`, `3-4`, `4-4.5`, `4.5-4.8`, `4.8+`. - `review_band` returns bucket values `<1`, `1-10`, `10-50`, `50-200`, `200+`. - The `admin1` (top subdivision), `locality` (settlement), `room_type`, `property_type` and `amenities` facets are enrichment-derived. `admin1`/`locality` come from a reverse-geocode pass; `room_type` returns bucket values `entire_place`, `private_room`, `hotel`, `shared_room`, classified from each listing's search-card descriptor; `property_type` returns Airbnb's finer canonical listing type read from the detail page; `amenities` returns each amenity (e.g. `Wifi`, `Pool`, `Free parking on premises`, `Pets allowed`) with the count of listings in the filtered market that offer it (a listing contributes to every amenity it has). Because each covers a growing share of the census, these facets return an **empty `items` array until that coverage is high enough** to be reliable, then fill in on their own as coverage grows. - Returns up to `50` buckets ordered by descending count. - Returns an empty `items` array (not an error) when no bucket clears the suppression floor. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "airbnb-markets", "facet": "currency", "items": [ { "value": "USD", "count": 512000 }, { "value": "EUR", "count": 388000 }, { "value": "BRL", "count": 96000 } ] } } ```

レスポンスに関する注記

- `avg_rating` is included only when the country has enough rated listings. - `superhost_pct` is an **observed lower bound** — it counts listings seen carrying the search-card Superhost badge, which renders inconsistently and under-counts. - `guest_favorite_pct` (with `guest_favorite_listings`) is the share of the country's listings carrying the Guest Favorite badge. Like `superhost_pct` it is an **observed lower bound** — the badge renders inconsistently on the search card, so it under-counts. - `superhost_pct_enriched` is the **reliable** Superhost share over a **random sample** of the country's listings enriched from the listing detail page (the sample is representative, so the rate is unbiased at partial coverage); `enriched_listings` (the sample size), `distinct_hosts` (distinct operators among the enriched listings) and `listings_per_host` (`enriched_listings / distinct_hosts`, an operator-concentration signal) accompany it. All four appear **only once the enriched sample is large enough to be reliable**, and are omitted otherwise; they populate for more countries over time as enrichment coverage grows. `distinct_hosts` is an aggregate count only — no host identity is returned. - `guest_favorite_pct_enriched` is the **reliable** Guest Favorite share over that same detail-page-enriched sample (the detail page carries an authoritative Guest Favorite flag, unlike the inconsistent search-card badge behind `guest_favorite_pct`), reported under the same gate as `superhost_pct_enriched` and omitted until the sample is large enough. - `avg_person_capacity` is the average number of guests a listing sleeps, over that same detail-page-enriched sample; reported under the same gate and omitted otherwise. Combine with `price_usd`/`currencies` medians for a rough price-per-guest read. - `currencies` prices are per-currency medians; most listings are priced in USD, so those are broadly comparable across countries. - `currencies` reports the 25th/50th/75th nightly-price percentiles for each currency with enough priced listings. - `price_usd` reports the country-wide 25th/50th/75th nightly-price percentiles normalized to USD via an **approximate, dated FX snapshot** — the cross-country-comparable complement to the per-currency `currencies` block. It is a market-level approximation (rates drift), not an exact conversion, and is present only when enough listings carry a USD-normalized price. - `metros` lists the country's largest metro markets that clear the suppression floor; each metro also carries `median_price_usd`, its median nightly price in USD (same approximate FX snapshot). - Returns `404` with the standard error envelope when the country has no listings above the suppression floor. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "country": "US", "listings": 1212294, "superhost_listings": 303073, "superhost_pct": 25, "guest_favorite_listings": 121229, "guest_favorite_pct": 10, "rated_listings": 776000, "avg_rating": 4.72, "avg_review_count": 31.5, "enriched_listings": 280000, "superhost_pct_enriched": 29.4, "guest_favorite_pct_enriched": 18.7, "avg_person_capacity": 4.2, "distinct_hosts": 214500, "listings_per_host": 1.31, "last_seen": "2026-07-03T00:00:00Z", "bounds": { "top_left": { "lat": 71.4, "lon": -177.1 }, "bottom_right": { "lat": 18.9, "lon": -66.9 } }, "metros": [ { "key": "Austin", "listings": 12040, "superhost_listings": 6020, "superhost_pct": 50, "guest_favorite_listings": 3010, "guest_favorite_pct": 25, "rated_listings": 9800, "avg_rating": 4.9, "median_price_usd": 205 } ], "currencies": [ { "currency": "USD", "listings": 512000, "p25": 95, "p50": 150, "p75": 260 } ], "price_usd": { "listings": 534000, "p25": 96, "p50": 152, "p75": 265 } } } ```

レスポンスに関する注記

- Each `cells` entry carries the geohash, its centroid `lat`/`lon`, `listings` count and `superhost_pct`. - `precision` in the response is the geohash precision actually used. - Superhost figures count listings observed carrying the Superhost badge and are a lower bound, since the badge is recorded when a listing is scanned. - Returns an empty `cells` array (not an error) when no cell clears the suppression floor. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "airbnb-markets", "lat": 30.27, "lon": -97.74, "radius_m": 5000, "precision": 6, "cells": [ { "geohash": "9v6m", "lat": 30.27, "lon": -97.74, "listings": 320, "superhost_listings": 96, "superhost_pct": 30 } ], "total": 1 } } ```

レスポンスに関する注記

- Grouping by `admin1`, `locality`, `room_type` or `property_type` returns enrichment-derived market cells (sub-country geography, or accommodation type). `admin1`/`locality` come from a reverse-geocode pass, `room_type` (`entire_place`, `private_room`, `hotel`, `shared_room`) is classified from each listing's search-card descriptor going forward, and `property_type` (Airbnb's finer canonical type) is read from the listing detail page. Because each covers a growing share of the census, these dimensions return an **empty `items` array until that coverage is high enough** for the cell counts to be reliable, then fill in on their own as coverage grows. `country` and `market` are always available. - `avg_person_capacity` is the average number of guests a listing sleeps, computed over the cell's detail-page-enriched sample; like the `*_enriched` fields it is reported only once that sample is large enough to be reliable. Combine it with `median_price_usd` for a rough price-per-guest read. - Pairing `group_by=room_type` with `median_price_usd` gives the median nightly USD price per accommodation type (e.g. entire homes vs private rooms), optionally filtered to one `country` or `market`. - `median_price_usd` is the cell's median nightly price converted to USD via an **approximate, dated FX snapshot**, so markets are price-comparable across countries despite Airbnb localizing the display currency. It is reported only for cells with enough USD-normalized priced listings and is a market-level approximation, not an exact conversion. - `avg_rating` is reported only for cells with enough rated listings, so a handful of reviews never swings a published market average; it is omitted otherwise. - `superhost_pct` is the Superhost share of the cell, from `0` through `100`. It is an **observed lower bound**: it counts listings seen carrying the Superhost badge on the search card, which renders inconsistently, so it under-counts. - `guest_favorite_pct` is the share of the cell's listings carrying the Guest Favorite badge, from `0` through `100`, with `guest_favorite_listings` the underlying count. Like `superhost_pct` it is an **observed lower bound** — the badge renders inconsistently on the search card, so it under-counts. - `superhost_pct_enriched` is the **reliable** Superhost share, computed over a **random sample** of the cell's listings enriched from the listing detail page (enrichment draws a representative sample, so the rate is unbiased even at partial coverage). It, along with `enriched_listings` (the size of that enriched sample), `distinct_hosts` (the number of distinct operators among the enriched listings) and `listings_per_host` (`enriched_listings / distinct_hosts`, an operator-concentration signal), is reported **only once the enriched sample is large enough to be reliable**; all four are omitted until then. Detail-page enrichment covers a growing subset of the census, so these fields appear for more markets over time. `distinct_hosts` is an aggregate count only — no host identity is ever returned. - `guest_favorite_pct_enriched` is the **reliable** Guest Favorite share over that same detail-page-enriched sample (the listing detail page carries an authoritative Guest Favorite flag, unlike the inconsistent search-card badge behind `guest_favorite_pct`). It is reported under the same gate as `superhost_pct_enriched` and omitted until the enriched sample is large enough. - The `min_listings` field in the response echoes the effective suppression floor that was applied. - The maximum result window is `10000`; `page * page_size` must not exceed `10000`. - Invalid enum values return the standard invalid params envelope. - Returns an empty `items` array (not an error) when no cell clears the suppression floor. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "airbnb-markets", "group_by": "country", "items": [ { "key": "US", "listings": 1212294, "superhost_listings": 303073, "superhost_pct": 25, "guest_favorite_listings": 121229, "guest_favorite_pct": 10, "rated_listings": 776000, "avg_rating": 4.72, "avg_review_count": 31.5, "median_price_usd": 148, "enriched_listings": 280000, "superhost_pct_enriched": 29.4, "guest_favorite_pct_enriched": 18.7, "avg_person_capacity": 4.2, "distinct_hosts": 214500, "listings_per_host": 1.31, "last_seen": "2026-07-03T00:00:00Z" } ], "page": 1, "page_size": 20, "total": 1, "sort": "listings_desc", "min_listings": 50 } } ```

レスポンスに関する注記

- With no `date` (and no single-app history request) the latest snapshot is resolved automatically, so the default response is today's chart in rank order. - The response echoes the resolved `snapshot_date` so callers know which day was returned. - The maximum result window is `10000`; `page * page_size` must not exceed `10000`. - Invalid enum values return the standard invalid params envelope. - A not-yet-populated index returns an empty `items` list rather than an error. - iOS chart entries carry a `platform` field (see platform enum above); Android entries leave it empty. - Android chart snapshots include the overall Google Play app charts and selected category charts, including the `GAME` and `FAMILY` app categories. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "apps-charts", "items": [ { "chart_uid": "android:GROSSING::jp:2026-06-19:1", "store": "android", "collection": "GROSSING", "chart_type": "top_grossing", "country": "jp", "snapshot_date": "2026-06-19", "rank": 1, "app_id": "com.google.android.apps.subscriptions.red", "title": "Google One", "developer": "Google LLC", "free": true, "url": "https://play.google.com/store/apps/details?id=com.google.android.apps.subscriptions.red" } ], "snapshot_date": "2026-06-19", "page": 1, "page_size": 20, "total": 100, "sort": "rank" } } ```

レスポンスに関する注記

- The maximum result window is `10000`; `page * page_size` must not exceed `10000`. - Invalid enum values return the standard invalid params envelope. - A not-yet-populated index returns an empty `items` list rather than an error. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "apps-reviews", "items": [ { "review_uid": "ios:284882215:us:7299100412", "store": "ios", "app_id": "284882215", "country": "us", "review_id": "7299100412", "user_name": "jane_doe", "score": 5, "title": "Love it", "text": "Works flawlessly after the latest update.", "version": "451.0", "thumbs_up": 12, "reviewed_at": "2026-06-18T09:21:00Z", "last_crawled": "2026-06-19T02:40:00Z" } ], "page": 1, "page_size": 20, "total": 1, "sort": "recent" } } ```

レスポンスに関する注記

- Defaults to `relevance` sort when `q` is supplied. - Defaults to `reviews_desc` sort when no `q` is supplied. - The maximum result window is `10000`; `page * page_size` must not exceed `10000`. - Invalid enum values return the standard invalid params envelope. - A not-yet-populated index returns an empty `items` list rather than an error. - iOS records do not include install counts; `android_max_installs` is populated for Google Play records only. - `platforms` is populated as data is crawled: iOS records use Apple's `phone`/`pad`/`mac`/`tv`/`watch`/`vision` compatibility values; Android records use Google Play source values such as `phone`, `tablet`, `tv`, `chromebook`, `watch`, `xr`, `car`, and `windows` where public source lists identify them. Absent/empty `platforms` means "not yet classified", not platform-incompatible. - Does not trigger live scraping. - Google Play records are Android app records. Google Play Books and Movies are separate store verticals and are not part of this apps dataset. - Recurring ingestion uses public source pages: App Store RSS ranking/new lists and Google Play app category ranking/new lists, plus sitemap and focused refresh lanes. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "apps", "items": [ { "app_uid": "ios:6448311069", "store": "ios", "ios_app_id": "6448311069", "title": "ChatGPT", "developer": "OpenAI", "category": "Productivity", "country": "us", "free": true, "score": 4.9, "ratings_count": 7976038, "url": "https://apps.apple.com/us/app/id6448311069" } ], "page": 1, "page_size": 20, "total": 1, "sort": "reviews_desc" } } ```

レスポンスに関する注記

- `facet=category` returns the category values to use as the `category` search/facet filter, with counts. - `facet=rating` is useful to see the letter-grade distribution across the currently-filtered slice of the dataset. - Returns an empty `items` array (not an error) when the dataset has no data yet. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "bbb-businesses", "facet": "rating", "items": [ { "value": "A+", "count": 512 }, { "value": "A", "count": 210 }, { "value": "A-", "count": 88 }, { "value": "B+", "count": 34 } ] } } ```

レスポンスに関する注記

- Returns `404` when the business is not in the index. - Field shape matches one item from the search response. Example response: ```json { "code": 200, "msg": "OK", "data": { "business_id": "0825-1000223803", "bbb_local_id": "0825", "name": "Calixto Plumbing", "url": "https://www.bbb.org/us/tx/austin/profile/plumber/calixto-plumbing-0825-1000223803", "country": "us", "state": "tx", "city": "austin", "address": "PO Box 40698, Austin, TX 78704-0012", "phone": "(512) 945-3143", "rating": "A+", "rating_rank": 12, "rating_reasons": ["Customer Reviews are not used in the calculation of the BBB Letter Grade Rating."], "accredited": true, "category": "Plumber", "categories": ["Plumber", "Plumbing Renovation", "Commercial Plumber"], "complaints_url": "https://www.bbb.org/us/tx/austin/profile/plumber/calixto-plumbing-0825-1000223803/complaints", "reviews_url": "https://www.bbb.org/us/tx/austin/profile/plumber/calixto-plumbing-0825-1000223803/customer-reviews" } } ```

レスポンスに関する注記

- Each item carries `business_id`, `bbb_local_id`, `name`, `url`, `country`, `state`, `city`, `address`, `phone`, `website`, `rating`, `rating_rank`, `rating_reasons`, `accredited`, `accredited_since`, `years_in_business`, `category`, `categories`, business-detail fields (`bbb_file_opened`, `business_started`, `business_incorporated`, `entity_type`, `alternate_names`, `business_management`, `additional_phone_numbers`, `additional_websites`, `social_media`, `licensing_note`, `hours`, `products_and_services`), and the on-demand pointer fields `complaints_url`, `reviews_url`, `more_info_url`. - `rating_reasons` on this record is the shallow rating-card list bbb-business itself returns — often a single generic boilerplate bullet. Fetch `more_info_url` for the fuller per-factor reasons on a lower-rated business. - The maximum result window is `10000`; `page * page_size` must not exceed `10000`. - Invalid enum values return the standard invalid params envelope. - Returns an empty `items` array (not an error) when nothing matches or the dataset has no data yet. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "bbb-businesses", "items": [ { "business_id": "0825-1000223803", "bbb_local_id": "0825", "name": "Calixto Plumbing", "url": "https://www.bbb.org/us/tx/austin/profile/plumber/calixto-plumbing-0825-1000223803", "country": "us", "state": "tx", "city": "austin", "phone": "(512) 945-3143", "rating": "A+", "rating_rank": 12, "accredited": true, "category": "Plumber", "categories": ["Plumber", "Plumbing Renovation", "Commercial Plumber"], "complaints_url": "https://www.bbb.org/us/tx/austin/profile/plumber/calixto-plumbing-0825-1000223803/complaints", "reviews_url": "https://www.bbb.org/us/tx/austin/profile/plumber/calixto-plumbing-0825-1000223803/customer-reviews" } ], "page": 1, "page_size": 20, "total": 1, "sort": "accredited_first" } } ```

レスポンスに関する注記

invalid-params error. Gross amounts are whole USD dollars (no cents). Example response: ```json { "code": 200, "msg": "OK", "data": { "title_id": "tt0499549", "title": "Avatar", "lifetime_gross_worldwide": 2923710708, "lifetime_rank_worldwide": 1, "gross_band": "over_1b", "is_billion_dollar": true, "hydrated": true, "release_group_count": 6, "year_grosses": [{ "year": 2009, "worldwide": 2743577587 }] } } ```

レスポンスに関する注記

- `summary` reports current totals, developer-name and developer-email coverage, and the most recent crawl timestamp. - `item_types`, `manifest_versions`, `user_bands`, `rating_bands`, `review_bands`, and `risk_signals` are complete chart series. - `top_categories` and `top_developers` include item counts and summed displayed users; `top_permissions` counts declared permissions across items. - `changes.daily` fills empty calendar days within the selected window, while `changes.types` counts the change categories observed. - A not-yet-populated index returns zero totals and empty bucket arrays rather than an error. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "chrome-extensions", "generated_at": "2026-07-14T08:00:00Z", "days": 30, "summary": { "total": 966, "total_users": 10232794, "total_ratings": 36524, "average_rating": 4.4341, "privacy_policies": 440, "named_developers": 774, "developer_emails": 104 }, "item_types": [ { "value": "extension", "count": 693 }, { "value": "theme", "count": 238 } ], "risk_signals": [ { "value": "Broad host access", "count": 146 }, { "value": "Collects data", "count": 198 } ], "top_categories": [ { "value": "productivity/tools", "count": 256, "users": 1200000 } ], "top_developers": [ { "value": "Example Publisher", "count": 12, "users": 250000 } ], "changes": { "total": 1, "types": [{ "value": "status", "count": 1 }], "daily": [{ "date": "2026-07-14", "count": 1, "users_delta": 0, "rating_count_delta": 0 }] } } } ```

レスポンスに関する注記

- The maximum result window is `10000`; `page * page_size` must not exceed `10000`. - Invalid enum values return the standard invalid params envelope. - A not-yet-populated index returns an empty `items` list rather than an error. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "creators", "items": [ { "creator_uid": "tiktok:@bubble", "platform": "tiktok", "sec_uid": "MS4wLjABAAAAxxxxxxxx", "unique_id": "bubble", "nickname": "Bubble Skincare", "bio": "Built with dermatologists since day 1.", "bio_link": "https://hellobubble.com", "niche": "skincare", "country": "us", "verified": true, "follower_count": 4100000, "following_count": 312, "total_likes": 25246297, "video_count": 1840, "first_seen": "2026-06-20T05:00:00Z", "last_crawled": "2026-06-20T05:00:00Z" } ], "page": 1, "page_size": 20, "total": 1, "sort": "followers_desc" } } ```

レスポンスに関する注記

- `facet` parameter must be one of the documented enum values; invalid values return `400`. - Default ordering returns the most common values, preserving the existing top-50 behavior. - `order=value_asc` returns values alphabetically and exposes `next_after`. Continue until it is absent; the final request may be empty. Counts can change as Pages are refreshed. - Only verified, non-quarantined records contribute to facets. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "facebook-pages", "facet": "category", "items": [ { "value": "Shoe Store", "count": 42 }, { "value": "Restaurant", "count": 37 }, { "value": "Clothing (Brand)", "count": 29 } ] } } ``` To enumerate categories, start with `/api/v1/datasets/facebook-pages/facets?facet=category&order=value_asc&limit=200`, then URL-encode `next_after` into the next request’s `after` parameter.

レスポンスに関する注記

- Returns `404` when the Page is not present in the dataset. Example response: ```json { "code": 200, "msg": "OK", "data": { "page_id": "104958closes123", "identifier": "bata.official", "title": "Bata", "source_url": "https://www.facebook.com/bata.official", "website": "https://www.bata.com", "email": "customercare@bata.com", "phones": ["+91-1800-121-9800"], "address": "Mumbai, India", "category": "Shoe Store", "whatsapp": "", "likes": 5200000, "discovery_source": "wikidata", "status": "ok", "discovered_at": "2026-07-30T00:00:00Z", "hydrated_at": "2026-08-15T00:00:00Z" } } ``` Record quality and freshness: - Only verified Page records are returned; quarantined legacy interstitials are excluded. - `hydrated_at` is the last successful Page fetch, not a guarantee that every contact field was present in that response. - `contact_observed_at`, when present, records the latest complete-section observation for `email`, `phones`, `address`, `category`, `website`, and `whatsapp`. Fields absent from a complete section are cleared; a partial response preserves prior contact values and their observation times.

レスポンスに関する注記

- Defaults to `relevance` sort when `q` is supplied, otherwise `likes_desc`. - `min_likes` must not exceed `max_likes`. - Date filters accept an RFC3339 timestamp or a bare `YYYY-MM-DD` calendar date. - The maximum result window is `10000`; `page * page_size` must not exceed `10000`. - Only successfully hydrated Pages are ever returned. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "facebook-pages", "items": [ { "page_id": "104958closes123", "identifier": "bata.official", "title": "Bata", "source_url": "https://www.facebook.com/bata.official", "website": "https://www.bata.com", "email": "customercare@bata.com", "phones": ["+91-1800-121-9800"], "address": "Mumbai, India", "category": "Shoe Store", "whatsapp": "", "likes": 5200000, "discovery_source": "wikidata", "status": "ok", "discovered_at": "2026-07-30T00:00:00Z", "hydrated_at": "2026-08-15T00:00:00Z" } ], "page": 1, "page_size": 20, "total": 1231862, "sort": "likes_desc" } } ``` Record quality and freshness: - Only verified Page records are returned; quarantined legacy interstitials are excluded. - `hydrated_at` is the last successful Page fetch, not a guarantee that every contact field was present in that response. - `contact_observed_at`, when present, records the latest complete-section observation for `email`, `phones`, `address`, `category`, `website`, and `whatsapp`. Fields absent from a complete section are cleared; a partial response preserves prior contact values and their observation times. - Equal sort values are ordered by Page ID. Concurrent updates can still move records across numbered pages.

レスポンスに関する注記

- Returns up to `50` buckets ordered by descending count. - `facet` is required; unsupported values return the standard invalid params envelope. - Boolean facets (`reachable`, `has_email`, `has_twitter`, `has_blog`, `active_90d`, `hireable`, `is_org`, `is_bot`, `is_suspected_automation`) return `true`/`false` bucket values. - Suspected-automation records are excluded from all facet counts unless `is_suspected_automation` is set. - Returns an empty `items` array (not an error) when the dataset has no data yet. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "github-users", "facet": "country", "items": [ { "value": "United States", "count": 4210 }, { "value": "Germany", "count": 1875 }, { "value": "India", "count": 1610 } ] } } ```

レスポンスに関する注記

- Returns `404` when the login is not present in the stored dataset. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "login": "octodev", "name": "Octo Dev", "company_normalized": "google", "blog": "https://octo.dev", "twitter_username": "octodev", "influence_tier": "mid", "geo": { "country": "Germany", "country_code": "DE", "city": "Berlin" }, "followers": 1200, "public_repos": 60, "account_age_years": 10.0, "reachable": true, "domains": ["ml-ai"], "rank_score": 88 } } ```

レスポンスに関する注記

- Results are sorted by ascending distance; each item carries `distance_m` (meters from the query point). - `lat`, `lon` and `radius_m` are all required. - The maximum result window is `10000`; `page * page_size` must not exceed `10000`. - Only users with a geocoded location are returned. - Returns an empty `items` array (not an error) when no users fall within the radius. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "github-users", "items": [ { "login": "octodev", "name": "Octo Dev", "influence_tier": "mid", "geo": { "country": "United States", "city": "San Francisco" }, "followers": 1200, "reachable": true, "distance_m": 1840.5 } ], "page": 1, "page_size": 20, "total": 1, "sort": "distance_asc" } } ```

レスポンスに関する注記

- Suspected-automation records (commit-farm / mass-repo bots) are excluded unless `is_suspected_automation` is set, so `rank_score` ranking is clean by default. - `rank_score` weights follower-based influence primarily and log-dampens recent activity (pushes/PRs/reviews), so raw push volume cannot dominate the ranking. - Defaults to `relevance` sort when `q` is supplied, otherwise `rank_score_desc`. - `lat` and `lon` must be supplied together. `distance_asc` requires `lat` and `lon`, but does not require `radius_m`. - `min_followers` must not exceed `max_followers`. - The maximum result window is `10000`; `page * page_size` must not exceed `10000`. - Invalid enum values return the standard invalid params envelope. - Returns an empty `items` array (not an error) when the dataset has no matches yet. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "github-users", "items": [ { "login": "octodev", "name": "Octo Dev", "company_normalized": "google", "influence_tier": "mid", "geo": { "country": "Germany", "country_code": "DE", "city": "Berlin" }, "followers": 1200, "reachable": true, "has_email": true, "domains": ["ml-ai"], "rank_score": 88 } ], "page": 1, "page_size": 20, "total": 1, "sort": "rank_score_desc" } } ```

レスポンスに関する注記

- Returns up to `50` buckets ordered by descending count. - `facet` is required; unsupported values return the standard invalid params envelope. - The `is_latest` boolean facet returns `true`/`false` bucket values; `period_begin` buckets are dates. - Combine `latest=true` with the `period_begin` facet to confirm the dataset's current month, or facet `state_code` filtered to `region_type=city` to see per-state city coverage. - Returns an empty `items` array (not an error) when the dataset has no data yet. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "housing-markets", "facet": "property_type", "items": [ { "value": "All Residential", "count": 3712450 }, { "value": "Single Family Residential", "count": 3689121 }, { "value": "Condo/Co-op", "count": 2418804 } ] } } ```

レスポンスに関する注記

- Without `history`, returns the single record for the requested (or latest) period. - With `history=true`, returns a `{dataset, region_type, table_id, property_type, items}` envelope with every stored month. - Returns `404` when the region/period/property-type combination is not present in the stored dataset. - Returns the standard invalid params envelope for an unknown `region_type`, a non-numeric `table_id`, an invalid `property_type`, or a malformed `period`. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "region_type": "zip", "region_type_id": 2, "table_id": 26097, "region": "Zip Code: 60616", "state": "Illinois", "state_code": "IL", "zip_code": "60616", "parent_metro": "Chicago, IL", "parent_metro_code": "16984", "property_type": "All Residential", "property_type_id": -1, "period_begin": "2026-03-01", "period_end": "2026-05-31", "is_latest": true, "median_sale_price": 340000, "median_sale_price_yoy": 0.062, "median_list_price": 349900, "homes_sold": 94, "inventory": 151, "median_dom": 38, "median_household_income": 91245, "income_geo_id": "860Z200US60616", "income_vintage": "acs2024_5yr", "price_to_income": 3.73, "salary_to_buy": 96581, "affordability_gap": 5336, "mortgage_rate_pct": 6.49, "source": "redfin_data_center", "run_id": "housing-20260711", "schema_version": 1 } } ```

レスポンスに関する注記

- One record per region x month x property type; `is_latest` marks each series' most recent month — combine `latest=true` with `region_type` for current-market rankings. - MoM/YoY change fields (`median_sale_price_yoy` etc.) are fractions as published by Redfin (`0.05` = +5%). - Affordability fields (`median_household_income`, `price_to_income`, `salary_to_buy`, `affordability_gap`) exist only where the Census income geography matched and a median sale price is present; `salary_to_buy` assumes 20% down, a 30-year fixed mortgage at `mortgage_rate_pct`, 1.5%/yr taxes+insurance, and a 28% payment-to-income ratio. - `income_vintage` is `acs2024_5yr`; ACS incomes lag current prices by ~2 years. - Defaults to `relevance` sort with `q`, `price_to_income_desc` with `latest=true`, otherwise `period_desc`. - Missing metrics are `null`, never `0` — Redfin leaves thin-market cells empty. - The maximum result window is `10000`; `page * page_size` must not exceed `10000`. - Invalid enum values return the standard invalid params envelope. - Returns an empty `items` array (not an error) when the dataset has no matches yet. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "housing-markets", "items": [ { "region_type": "metro", "region_type_id": -2, "table_id": 41940, "region": "San Jose, CA metro area", "state_code": "CA", "property_type": "All Residential", "property_type_id": -1, "period_begin": "2026-05-01", "period_end": "2026-05-31", "is_latest": true, "median_sale_price": 1650000, "median_sale_price_yoy": 0.041, "median_list_price": 1498000, "homes_sold": 812, "inventory": 1421, "median_dom": 12, "median_household_income": 153202, "income_geo_id": "0400000US06", "income_vintage": "acs2024_5yr", "price_to_income": 10.77, "salary_to_buy": 322403, "affordability_gap": 169201, "mortgage_rate_pct": 6.49, "source": "redfin_data_center", "run_id": "housing-20260711", "schema_version": 1 } ], "page": 1, "page_size": 20, "total": 934, "sort": "price_to_income_desc" } } ```

レスポンスに関する注記

- `facet` parameter must be one of the documented enum values; invalid values return `400`. - Aggregates document counts up to top `50` buckets. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "instagram-users", "facet": "category_name", "items": [ { "value": "Digital Creator", "count": 450000 }, { "value": "Artist", "count": 280000 }, { "value": "Entrepreneur", "count": 195000 } ] } } ```

レスポンスに関する注記

- Leading `@` is automatically trimmed. - Usernames match case-insensitively. - Returns `404` when the user record is not present in the dataset. Example response: ```json { "code": 200, "msg": "OK", "data": { "username": "instagram", "id": "25025320", "full_name": "Instagram", "biography": "Discovering creators and stories around the world.", "external_url": "https://about.instagram.com", "avatar_url": "https://scontent.cdninstagram.com/avatar.jpg", "is_verified": true, "is_business_account": true, "category_name": "Product/Service", "has_bio": true, "has_external_url": true, "followers": 670000000, "following": 80, "posts": 7500, "follower_following_ratio": 8375000.0, "source_tier": "head-directory", "crawled_at": "2026-07-23T10:00:00Z", "schema_version": 1 } } ```

レスポンスに関する注記

- Defaults to `relevance` sort when `q` is supplied, otherwise `followers_desc`. - `min_followers` must not exceed `max_followers`, and `min_ratio` must not exceed `max_ratio`. - Date filters accept an RFC3339 timestamp or a bare `YYYY-MM-DD` calendar date. - The maximum result window is `10000`; `page * page_size` must not exceed `10000`. - Invalid enum values return the standard invalid params envelope. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "instagram-users", "items": [ { "username": "instagram", "id": "25025320", "full_name": "Instagram", "biography": "Discovering creators and stories around the world.", "external_url": "https://about.instagram.com", "avatar_url": "https://scontent.cdninstagram.com/avatar.jpg", "is_verified": true, "is_business_account": true, "category_name": "Product/Service", "has_bio": true, "has_external_url": true, "followers": 670000000, "following": 80, "posts": 7500, "follower_following_ratio": 8375000.0, "source_tier": "head-directory", "crawled_at": "2026-07-23T10:00:00Z", "schema_version": 1 } ], "page": 1, "page_size": 20, "total": 1, "sort": "followers_desc" } } ```

レスポンスに関する注記

- `facet=outlet` returns the outlet ids to use as the `outlet` search/item filter, with counts. - `facet=contact_type` is useful to gauge how much of the roster has a real email vs. only a social handle vs. nothing. - Returns an empty `items` array (not an error) when the dataset has no data yet. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "journalists", "facet": "contact_type", "items": [ { "value": "email", "count": 42 }, { "value": "social", "count": 61 }, { "value": "none", "count": 8 } ] } } ```

レスポンスに関する注記

- Returns `404` when the outlet is not a supported outlet, or the journalist is not in the index. - Field shape matches one item from the search response. Example response: ```json { "code": 200, "msg": "OK", "data": { "outlet_id": "techcrunch", "outlet": "TechCrunch", "outlet_domain": "techcrunch.com", "vertical": "tech", "slug": "zack-whittaker", "name": "Zack Whittaker", "title": "Security Editor", "bio": "Zack Whittaker is the security editor at TechCrunch...", "topics": ["security"], "profile_url": "https://techcrunch.com/author/zack-whittaker/", "contact_email": "zack.whittaker@techcrunch.com", "social_links": { "signal": "zackwhittaker.1337", "bluesky": "https://bsky.app/profile/zackwhittaker.com" }, "contact_type": "email" } } ```

レスポンスに関する注記

- Each item carries `outlet_id`, `outlet`, `outlet_domain`, `vertical`, `slug`, `name`, `title`, `bio`, `topics`, `profile_url`, `contact_email`, `social_links`, and `contact_type`. - `contact_type` is the most useful outreach filter: `email` means a real work email was found on the outlet's own page, `social` means only a social handle (X, LinkedIn, Bluesky, Signal, etc.) was found, `none` means neither. - The maximum result window is `10000`; `page * page_size` must not exceed `10000`. - Invalid enum values return the standard invalid params envelope. - Returns an empty `items` array (not an error) when nothing matches or the dataset has no data yet. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "journalists", "items": [ { "outlet_id": "techcrunch", "outlet": "TechCrunch", "outlet_domain": "techcrunch.com", "vertical": "tech", "slug": "zack-whittaker", "name": "Zack Whittaker", "title": "Security Editor", "bio": "Zack Whittaker is the security editor at TechCrunch...", "topics": ["security"], "profile_url": "https://techcrunch.com/author/zack-whittaker/", "contact_email": "zack.whittaker@techcrunch.com", "social_links": { "signal": "zackwhittaker.1337", "bluesky": "https://bsky.app/profile/zackwhittaker.com" }, "contact_type": "email" } ], "page": 1, "page_size": 20, "total": 1, "sort": "outlet_asc" } } ```

レスポンスに関する注記

- Some limited partner profiles have no FAQ section (`faqs` is an empty list) — PitchBook only generates one for profiles with enough content. This is normal, not a sign of a blocked or broken crawl; the example below is one such profile. Example response: ```json {"code":200,"msg":"OK","data":{"id":"186091-66","kind":"limited-partner","name":"Sippdeal Trustees","description":"Sippdeal Trustees is a private investment firm based in Manchester, United Kingdom. The firm was established in 2000. The assets are managed by the board of directors.","overview":{"Type":"Private Investment Fund","Year Founded":"2000","Professionals":"1","Commitments":"1"},"contact":{"Year Founded":"2000","Institution Type":"Private Investment Fund","Title":"Board Member","Corporate Office":"4 Exchange Quay, Salford Quays, Manchester M5 3EE, England, United Kingdom"},"tables":[{"name":"Commitments","total":1,"columns":["Fund Name","Fund Manager","Fund Location","Vintage","Fund Size","Commitment Date","Commitment"],"rows":[["","Cornerstone Private Equity","London, United Kingdom","2010","","",""]]}],"faqs":[],"institution_type":"Private Investment Fund","year_founded":2000,"contact_title":"Board Member","commitments_count":1,"hq_country":"United Kingdom","hq_state":"England","hq_city":"Manchester M5 3EE","source_url":"https://pitchbook.com/profiles/limited-partner/186091-66","crawled_at":"2026-07-20T20:00:00Z"}} ```

レスポンスに関する注記

- Each item is a `{ value, count }` bucket. For `facet=topic`, `value` is a topic slug; for `facet=product_count_band`, one of `1`, `2-4`, `5-9`, `10+`. - Invalid enum values return the standard invalid params envelope. - Returns an empty `items` array (not an error) when nothing matches or the dataset has no data yet. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "producthunt-makers", "facet": "product_count_band", "items": [ { "value": "1", "count": 180234 }, { "value": "2-4", "count": 42150 }, { "value": "5-9", "count": 8300 }, { "value": "10+", "count": 2100 } ] } } ```

レスポンスに関する注記

- Returns the full maker record (`maker_id`, `username`, `name`, `headline`, `avatar_url`, `followers_count`, `made_products`, `product_count`, `total_votes`, `best_product`, `topics`). - Returns `404` when the username is not in the dataset. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "maker_id": "12345", "username": "rrhoover", "name": "Ryan Hoover", "headline": "Founder of Product Hunt", "followers_count": 42000, "product_count": 8, "total_votes": 5210, "best_product": { "slug": "product-hunt", "name": "Product Hunt", "latest_score": 1200 }, "made_products": [ { "product_id": "1", "slug": "product-hunt", "name": "Product Hunt", "latest_score": 1200 } ], "topics": ["tech", "productivity"] } } ```

レスポンスに関する注記

- Each item carries `maker_id`, `username`, `name`, `headline`, `avatar_url`, `followers_count`, `made_products`, `product_count`, `total_votes`, `best_product` and `topics`. - The maximum result window is `10000`; `page * page_size` must not exceed `10000`. - Invalid enum values return the standard invalid params envelope. - Returns an empty `items` array (not an error) when nothing matches or the dataset has no data yet. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "producthunt-makers", "items": [ { "maker_id": "12345", "username": "rrhoover", "name": "Ryan Hoover", "headline": "Founder of Product Hunt", "product_count": 8, "total_votes": 5210, "best_product": { "slug": "product-hunt", "latest_score": 1200 }, "topics": ["tech", "productivity"] } ], "page": 1, "page_size": 20, "total": 1, "sort": "total_votes_desc" } } ```

レスポンスに関する注記

- Each item is a `{ value, count }` bucket. For `facet=topic`, `value` is a topic slug; for `facet=launch_year`, a four-digit year; for `facet=pricing_type`/`product_state`, the token value. - Invalid enum values return the standard invalid params envelope. - Returns an empty `items` array (not an error) when nothing matches or the dataset has no data yet. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "producthunt-products", "facet": "launch_year", "items": [ { "value": "2024", "count": 12043 }, { "value": "2023", "count": 11890 } ] } } ```

レスポンスに関する注記

- Returns the full product record (`product_id`, `slug`, `name`, `tagline`, `topics`, `latest_score`, best ranks, `launches`, and hydrated `description`/`website`/`twitter_url`/`pricing_type`/`reviews_rating`/`makers`). - Returns `404` when the slug is not in the archive. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "product_id": "94418", "slug": "streaks", "name": "Streaks", "tagline": "The to-do list that helps you form good habits.", "topics": [{ "slug": "ios", "name": "iOS" }], "topic_slugs": ["ios", "task-management", "tech"], "latest_score": 414, "best_daily_rank": 1, "won_daily": true, "first_launch_date": "2015-06-01", "launch_count": 1, "launches": [ { "date": "2015-06-01", "daily_rank": 1, "score": 414, "post_id": "22928" } ] } } ```

レスポンスに関する注記

- Each item carries `product_id`, `slug`, `name`, `tagline`, `topics`/`topic_slugs`, `latest_score` (upvotes), `best_daily_rank`/`best_weekly_rank`/`best_monthly_rank`, `first_launch_date`, `launches` (launch history), and — once hydrated — `description`, `website`, `twitter_url`, `pricing_type`, `reviews_rating` and `makers`. - The maximum result window is `10000`; `page * page_size` must not exceed `10000`. - Invalid enum values return the standard invalid params envelope. - Returns an empty `items` array (not an error) when nothing matches or the dataset has no data yet. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "producthunt-products", "items": [ { "product_id": "94418", "slug": "streaks", "name": "Streaks", "tagline": "The to-do list that helps you form good habits.", "topic_slugs": ["ios", "task-management", "tech"], "latest_score": 414, "best_daily_rank": 1, "won_daily": true, "first_launch_date": "2015-06-01", "launch_count": 1 } ], "page": 1, "page_size": 20, "total": 1, "sort": "votes_desc" } } ```

レスポンスに関する注記

- Each item is a `{ value, count }` bucket. For `facet=topic`, `value` is a topic slug; for `facet=launch_year`, `value` is a four-digit year. - Buckets below the effective suppression floor are omitted. - Invalid enum values return the standard invalid params envelope. - Returns an empty `items` array (not an error) when nothing clears the suppression floor or the dataset has no data yet. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "producthunt-trends", "facet": "topic", "items": [ { "value": "artificial-intelligence", "count": 8421 }, { "value": "developer-tools", "count": 6033 }, { "value": "productivity", "count": 5210 } ] } } ```

レスポンスに関する注記

- Each cell carries `topic`, `period` (`YYYY-MM` for `topic_month`, `YYYY` for `topic_year`, omitted for `topic`), `launches`, `total_votes`, `avg_votes`, `avg_rating` and `top_product`. - `avg_rating` is reported only for cells with enough rated launches, so a handful of reviews never swings the figure; it is omitted otherwise. - `top_product` is the single highest-upvoted product in the cell (`slug`, `name`, `votes`). - The `min_launches` field in the response echoes the effective suppression floor that was applied. - Results are paginated over the aggregate cells; the maximum result window is `10000`, so `page * page_size` must not exceed `10000`. - Invalid enum values return the standard invalid params envelope. - Returns an empty `items` array (not an error) when no cell clears the suppression floor or the dataset has no data yet. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "producthunt-trends", "group_by": "topic_month", "items": [ { "topic": "artificial-intelligence", "period": "2024-01", "launches": 312, "total_votes": 84210, "avg_votes": 269.9, "avg_rating": 4.61, "top_product": { "slug": "chatgpt", "name": "ChatGPT", "votes": 4120 } } ], "page": 1, "page_size": 20, "total": 1, "sort": "period_desc", "min_launches": 3 } } ```

レスポンスに関する注記

- With no `date` the latest snapshot is resolved automatically, so the default response is today's trending posts in rank order. - The response echoes the resolved `snapshot_date` so callers know which day was returned. - The maximum result window is `10000`; `page * page_size` must not exceed `10000`. - Invalid enum values return the standard invalid params envelope. - A not-yet-populated index (or a subreddit not yet tracked) returns an empty `items` list rather than an error. - Does not trigger live scraping — for live subreddit posts use `/reddit/subreddit/{subreddit}/posts`. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "reddit-trending", "items": [ { "post_uid": "webscraping:2026-07-27:1", "subreddit": "webscraping", "snapshot_date": "2026-07-27", "rank": 1, "post_id": "1v7p3i7", "title": "I own a wood factory and want to use webscrapers to get info", "author": "Thin-Application-575", "permalink": "https://www.reddit.com/r/webscraping/comments/1v7p3i7/i_own_a_wood_factory_and_want_to_use_webscrapers/", "url": "https://www.reddit.com/r/webscraping/comments/1v7p3i7/i_own_a_wood_factory_and_want_to_use_webscrapers/", "domain": "self.webscraping", "created_utc": 1785123567 } ], "snapshot_date": "2026-07-27", "page": 1, "page_size": 20, "total": 10, "sort": "rank" } } ```

レスポンスに関する注記

- Returns an empty `items` array (not an error) when the dataset has no data yet. - Invalid `facet` values return the standard invalid params envelope. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "sec-companies", "facet": "sic_description", "items": [ { "value": "Electronic Computers", "count": 18 }, { "value": "Pharmaceutical Preparations", "count": 152 }, { "value": "State Commercial Banks", "count": 640 } ] } } ```

レスポンスに関する注記

- An unknown CIK or a company with no XBRL data returns an empty series (HTTP `200` with `count: 0`) rather than a `404` — most filers without a current ticker have no financial-statement history at all. - `lines` keys are the same normalized concept names the live `GET /sec/financials` endpoint uses (e.g. `revenue`, `net_income`, `total_assets`, `operating_cash_flow`). - `ratios` keys include `gross_margin`, `operating_margin`, `net_margin`, `revenue_growth_yoy`, `current_ratio`, `debt_to_equity`, `free_cash_flow` where derivable from the reported lines. - A period's `_id` is keyed by `(cik, statement, period, fiscal_year[, fiscal_period])`, so a later crawl that picks up an SEC restatement overwrites that period's figures rather than duplicating it — there is only ever one point per fiscal period. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "sec-companies", "cik": 320193, "count": 2, "points": [ { "cik": 320193, "statement": "income", "period": "annual", "fiscal_year": 2024, "fiscal_period": "FY", "end_date": "2024-09-28", "form": "10-K", "currency": "USD", "lines": { "revenue": 391035000000, "net_income": 93736000000, "gross_profit": 180683000000 }, "ratios": { "gross_margin": 0.4621, "net_margin": 0.2397, "revenue_growth_yoy": 0.0206 } }, { "cik": 320193, "statement": "income", "period": "annual", "fiscal_year": 2023, "fiscal_period": "FY", "end_date": "2023-09-30", "form": "10-K", "currency": "USD", "lines": { "revenue": 383285000000, "net_income": 96995000000 } } ] } } ```

レスポンスに関する注記

- An unknown CIK or a company with no reported transactions returns an empty series (HTTP `200` with `count: 0`) rather than a `404`. - Each item carries `owner_name`, `owner_title`, `is_director`/`is_officer`/`is_ten_percent_owner`, `security_title`, `transaction_date`, `code`, `acquired_or_disposed`, `shares`, `price_per_share`, `shares_owned_after`, and `filing_url`. - Rows are naturally idempotent (keyed by accession number + row sequence within the filing), so re-crawls never duplicate a transaction. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "sec-companies", "cik": 320193, "count": 1, "items": [ { "cik": 320193, "accession_number": "0000320193-25-000082", "form": "4", "filing_date": "2025-11-17", "owner_name": "COOK TIMOTHY D", "owner_title": "Chief Executive Officer", "is_officer": true, "security_title": "Common Stock", "transaction_date": "2025-11-15", "code": "S", "acquired_or_disposed": "D", "shares": 75000, "price_per_share": 268.42, "shares_owned_after": 3234400, "filing_url": "https://www.sec.gov/Archives/edgar/data/320193/000032019325000082/" } ] } } ```

レスポンスに関する注記

- Returns `404` when the CIK is not in the dataset (not yet backfilled, or never a reporting company in scope — see the dataset's seed-population notes). - Same record shape as the `search` endpoint's `items[]` entries. - Does not trigger live scraping — for a single company's current data right now, use `GET /sec/company/submissions` instead. Example response: ```json { "code": 200, "msg": "OK", "data": { "cik": 320193, "cik_padded": "0000320193", "name": "Apple Inc.", "former_names": ["Apple Computer Inc."], "tickers": ["AAPL"], "primary_ticker": "AAPL", "exchange": ["Nasdaq"], "sic": "3571", "sic_description": "Electronic Computers", "state_of_incorporation": "CA", "fiscal_year_end": "0928", "entity_type": "operating", "filing_count": 342, "latest_filing_date": "2025-10-31", "forms_filed": ["10-K", "10-Q", "8-K", "4"], "recent_filings": [ { "accession_number": "0000320193-25-000081", "form": "10-K", "filing_date": "2025-10-31", "primary_doc_url": "https://www.sec.gov/Archives/edgar/data/320193/000032019325000081/aapl-20250927.htm" } ], "latest_annual_fiscal_year": 2024, "latest_annual_revenue": 391035000000, "latest_annual_net_income": 93736000000, "latest_annual_total_assets": 364980000000, "revenue_band": "over_10b", "insider_txn_count_90d": 6, "insider_net_shares_90d": -18000, "insider_last_transaction_at": "2025-11-15", "crawled_at": "2026-07-15T03:12:00Z" } } ```

レスポンスに関する注記

- Each item carries `cik`, `cik_padded`, `name`, `former_names`, `tickers`, `primary_ticker`, `exchange`, `sic`, `sic_description`, `state_of_incorporation`, `fiscal_year_end`, `entity_type`, `filing_count`, `latest_filing_date`, `forms_filed`, `recent_filings` (capped detail list), `reporting_currency`, the `latest_annual_*`/`latest_quarterly_*` financial rollups (each with a native `_revenue`/`_net_income`/`_total_assets` and a `_usd` normalized counterpart), `revenue_band`, and the `insider_txn_count_90d`/`insider_net_shares_90d`/`insider_last_transaction_at` trailing-90-day rollup. - Currency: financial figures are stored in each filer's native `reporting_currency` exactly as filed; the `*_usd` fields (and `revenue_band`, and the `revenue_desc`/`net_income_desc` sorts and `min_*`/`max_revenue` filters) are that value converted at fixed reference rates so they compare across currencies. Read the native figure for exactness; screen and sort on the USD fields. - Reference rates: the `*_usd` conversion uses a single fixed rate per currency, **as of 2026-07-17**, refreshed about annually — not the exchange rate on each filing's own reporting date. So a `*_usd` figure is accurate enough to sort, band and range-filter across currencies, but it is not a restatement: for a non-USD filer's exact dollar value, take the native figure and apply your own as-of rate. Conversion is applied only to currencies we hold a rate for; a filer reporting in any other currency keeps its native figures and simply has no `*_usd` value (so it sorts last rather than being given a guessed one). - The maximum result window is `10000`; `page * page_size` must not exceed `10000`. - Invalid enum values return the standard invalid params envelope. - Returns an empty `items` array (not an error) when nothing matches or the dataset has no data yet. - Does not trigger live scraping — for a single company's current data right now, use `GET /sec/company/submissions` instead. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "sec-companies", "items": [ { "cik": 320193, "cik_padded": "0000320193", "name": "Apple Inc.", "tickers": ["AAPL"], "primary_ticker": "AAPL", "exchange": ["Nasdaq"], "sic": "3571", "sic_description": "Electronic Computers", "entity_type": "operating", "filing_count": 342, "latest_filing_date": "2025-10-31", "forms_filed": ["10-K", "10-Q", "8-K", "4"], "latest_annual_fiscal_year": 2024, "latest_annual_revenue": 391035000000, "latest_annual_net_income": 93736000000, "revenue_band": "over_10b", "insider_txn_count_90d": 6 } ], "page": 1, "page_size": 20, "total": 1, "sort": "relevance" } } ```

レスポンスに関する注記

- Returns an empty `items` array (not an error) when the dataset has no data yet. - Invalid `facet` values return the standard invalid params envelope. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "sec-institutional-positions", "facet": "manager", "items": [ { "value": "BERKSHIRE HATHAWAY INC", "count": 42 }, { "value": "VANGUARD GROUP INC", "count": 5218 } ] } } ```

レスポンスに関する注記

- Each item carries `manager_cik`, `manager_name`, `accession_number`, `filing_date`, `report_date`, `issuer_name`, `title_of_class`, `cusip`, `value` (USD, thousands as reported by the filer), `shares`, `share_type`, `put_call`, `investment_discretion`. - The maximum result window is `10000`; `page * page_size` must not exceed `10000`. - Invalid enum values return the standard invalid params envelope. - Returns an empty `items` array (not an error) when nothing matches or the dataset has no data yet. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "sec-institutional-positions", "items": [ { "manager_cik": 1067983, "manager_name": "BERKSHIRE HATHAWAY INC", "accession_number": "0000950123-26-000456", "filing_date": "2026-05-15", "report_date": "2026-03-31", "issuer_name": "APPLE INC", "title_of_class": "COM", "cusip": "037833100", "value": 150000000, "shares": 900000, "share_type": "SH", "investment_discretion": "SOLE" } ], "page": 1, "page_size": 20, "total": 1, "sort": "value_desc" } } ```

レスポンスに関する注記

- `country` is the store's true country; `market` is crawl provenance. - `schedule` and `amenities` may be empty for stores outside the US, Canada, Europe, and the Gulf; an empty `schedule` means "not published for this market", not "closed". - An unknown store number returns `404`. Example response: ```json { "code": 200, "msg": "OK", "data": { "store_number": "101-54", "name": "Columbia Center - 4th & Cherry", "phone": "+1 206-447-9934", "address": "701 Fifth Ave", "city": "Seattle", "state": "WA", "postal_code": "98104", "country": "US", "latitude": 47.60422, "longitude": -122.33078, "amenities": ["16", "XO", "DT"], "market": "us" } } ```

レスポンスに関する注記

- Results are sorted nearest-first; each item carries `distance_meters` from the query point. - Same per-market field-coverage caveat as search: an empty `schedule` means "not published for this market", not "closed". Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "starbucks-stores", "items": [ { "store_number": "101-54", "name": "Columbia Center - 4th & Cherry", "country": "US", "latitude": 47.60422, "longitude": -122.33078, "distance_meters": 220.5 } ], "page": 1, "page_size": 20, "total": 1, "sort": "distance_asc" } } ```

レスポンスに関する注記

- `country` is the store's true country; `market` is crawl provenance (the US host geocodes worldwide, so a Tokyo store has `country: JP`, `market: us`). - Store discovery is global, but `schedule` (hours), `amenities`, and `phone` 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". - A not-yet-populated dataset returns an empty result (`total: 0`), not an error. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "starbucks-stores", "items": [ { "store_number": "101-54", "name": "Columbia Center - 4th & Cherry", "city": "Seattle", "state": "WA", "country": "US", "latitude": 47.60422, "longitude": -122.33078, "amenities": ["16", "XO", "DT"], "market": "us" } ], "page": 1, "page_size": 20, "total": 1, "sort": "" } } ```

レスポンスに関する注記

- Defaults to the most-unlocked achievements first (`sort=percent_desc`). - The maximum result window is `10000`; `page * page_size` must not exceed `10000`. - Invalid `sort` values return the standard invalid params envelope. - A not-yet-populated index returns an empty `items` list rather than an error. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "steam-achievements", "items": [ { "appid": 620, "name": "Career Achievement", "percent": 78.4000015258789, "rank": 0, "crawled_at": "2026-07-11T04:15:02Z" } ], "page": 1, "page_size": 20, "total": 51, "sort": "percent_desc" } } ```

レスポンスに関する注記

- With no `date` (and no single-app history request) the latest snapshot is resolved automatically, so the default response is today's chart in rank order. - The response echoes the resolved `snapshot_date` so callers know which day was returned. - The maximum result window is `10000`; `page * page_size` must not exceed `10000`. - Invalid enum values return the standard invalid params envelope. - A not-yet-populated index returns an empty `items` list rather than an error. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "steam-charts", "items": [ { "chart_uid": "concurrent:global:2026-07-11:1", "chart": "concurrent", "country": "global", "snapshot_date": "2026-07-11", "rank": 1, "app_id": "730", "name": "Counter-Strike 2", "concurrent_in_game": 899091, "peak_in_game": 1308574 } ], "snapshot_date": "2026-07-11", "page": 1, "page_size": 20, "total": 100, "sort": "rank" } } ```

レスポンスに関する注記

- Returns up to `50` buckets ordered by descending count. - `facet` is required; unsupported values return the standard invalid params envelope. - Boolean facets (`is_free`, `coming_soon`, `platform_windows`, `platform_mac`, `platform_linux`) return `true`/`false` bucket values. - Returns an empty `items` array (not an error) when the dataset has no data yet. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "steam-games", "facet": "genres", "items": [ { "value": "Indie", "count": 4210 }, { "value": "Action", "count": 3175 }, { "value": "Adventure", "count": 2610 } ] } } ```

レスポンスに関する注記

- Returns `404` when the appid is not present in the stored dataset. - Returns the standard invalid params envelope when `appid` is empty or non-numeric. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "appid": 620, "name": "Portal 2", "developer": "Valve", "publisher": "Valve", "type": "game", "is_free": false, "price_cents": 999, "initial_price_cents": 1999, "discount_pct": 50, "price_tier": "5to15", "owners_min": 10000000, "owners_max": 20000000, "owners_midpoint": 15000000, "owners_bucket": "10,000,000 .. 20,000,000", "ccu": 12000, "positive": 100, "negative": 10, "total_reviews": 110, "review_score": 0.9091, "review_tier": "very_positive", "genres": ["Action", "Adventure"], "categories": ["Single-player", "Co-op"], "metacritic": 95, "release_date": "2011-04-19", "release_year": 2011, "platform_windows": true, "platform_mac": true, "platform_linux": true, "language_count": 22, "schema_version": 1 } } ```

レスポンスに関する注記

- Owner counts are SteamSpy public estimates, kept as `owners_min` / `owners_max` / `owners_midpoint`; `min_owners` filters on the midpoint. - `review_score` is the positive-review ratio (0 through 1); `review_tier` applies Steam's bands with a minimum-volume floor. - Prices are integer cents. `is_free` is set when the storefront marks the title free or the price is 0. - Defaults to `relevance` sort when `q` is supplied, otherwise `owners_desc`. - `min_price_cents` must not exceed `max_price_cents`; `min_release_year` must not exceed `max_release_year`. - The maximum result window is `10000`; `page * page_size` must not exceed `10000`. - Invalid enum values return the standard invalid params envelope. - Returns an empty `items` array (not an error) when the dataset has no matches yet. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "steam-games", "items": [ { "appid": 570, "name": "Dota 2", "developer": "Valve", "publisher": "Valve", "type": "game", "is_free": true, "price_cents": 0, "price_tier": "free", "owners_midpoint": 150000000, "owners_bucket": "100,000,000 .. 200,000,000", "ccu": 600000, "total_reviews": 1750000, "review_score": 0.9714, "review_tier": "overwhelmingly_positive", "genres": ["Action", "Free to Play"], "metacritic": 90, "release_year": 2013, "platform_windows": true, "platform_mac": true, "platform_linux": true } ], "page": 1, "page_size": 20, "total": 1, "sort": "owners_desc" } } ```

レスポンスに関する注記

- Defaults to the newest items first (`sort=date_desc`). - The maximum result window is `10000`; `page * page_size` must not exceed `10000`. - Invalid `sort` values return the standard invalid params envelope. - A not-yet-populated index returns an empty `items` list rather than an error. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "steam-news", "items": [ { "appid": 730, "gid": "5943051610484891716", "title": "Counter-Strike 2 Update", "url": "https://store.steampowered.com/news/app/730/view/5943051610484891716", "author": "Valve", "feed_label": "Community Announcements", "feed_name": "steam_community_announcements", "contents": "Released a new update with gameplay and stability fixes.", "tags": ["patchnotes"], "is_external_url": true, "date": 1752192000, "published_at": "2026-07-11T00:00:00Z", "crawled_at": "2026-07-11T04:12:33Z" } ], "page": 1, "page_size": 20, "total": 42, "sort": "date_desc" } } ```

レスポンスに関する注記

- Defaults to newest snapshots first (`sort=date_desc`). - The maximum result window is `10000`; `page * page_size` must not exceed `10000`. - Invalid `sort` values return the standard invalid params envelope. - A not-yet-populated index returns an empty `items` list rather than an error. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "steam-playercounts", "items": [ { "appid": 730, "name": "Counter-Strike 2", "snapshot_date": "2026-07-11", "player_count": 899091, "crawled_at": "2026-07-11T04:20:11Z" } ], "page": 1, "page_size": 20, "total": 365, "sort": "date_desc" } } ```

レスポンスに関する注記

- Defaults to newest snapshots first (`sort=date_desc`). - The maximum result window is `10000`; `page * page_size` must not exceed `10000`. - Invalid `sort` values return the standard invalid params envelope. - A not-yet-populated index returns an empty `items` list rather than an error. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "steam-prices", "items": [ { "appid": 292030, "name": "The Witcher 3: Wild Hunt", "snapshot_date": "2026-07-11", "currency": "USD", "price_cents": 999, "initial_price_cents": 3999, "discount_pct": 75, "is_free": false, "crawled_at": "2026-07-11T04:25:47Z" } ], "page": 1, "page_size": 20, "total": 365, "sort": "date_desc" } } ```

レスポンスに関する注記

- Defaults to the most-helpful reviews first (`sort=votes_desc`). - The maximum result window is `10000`; `page * page_size` must not exceed `10000`. - Invalid `sort` values, or a `voted_up` that is not a boolean, return the standard invalid params envelope. - A not-yet-populated index returns an empty `items` list rather than an error. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "steam-reviews", "items": [ { "appid": 292030, "recommendation_id": "154765432", "language": "english", "review": "One of the best RPGs ever made.", "voted_up": true, "votes_up": 1284, "votes_funny": 37, "weighted_vote_score": 0.9812, "comment_count": 12, "steam_purchase": true, "received_for_free": false, "written_during_early_access": false, "playtime_at_review_min": 5820, "author_playtime_forever_min": 18240, "timestamp_created": 1751587200, "created_at": "2026-07-04T00:00:00Z", "crawled_at": "2026-07-11T04:31:09Z" } ], "page": 1, "page_size": 20, "total": 500, "sort": "votes_desc" } } ```

レスポンスに関する注記

- Returns up to `50` buckets, each with the facet `value` and its `count`, ordered by count. - Invalid `facet` values return the standard invalid params envelope. - Returns an empty `items` array (not an error) when nothing matches or the dataset has no data yet. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "techstack", "facet": "ecommerce", "items": [ { "value": "Shopify", "count": 84120 }, { "value": "WooCommerce", "count": 61903 }, { "value": "Magento", "count": 12244 } ] } } ```

レスポンスに関する注記

- The item carries `domain`, `tld`, `rank`, `is_infrastructure` (`true` when the domain looks like backend CDN/DNS/cloud-vendor infrastructure — e.g. `cloudfront.net`, `gtld-servers.net` — rather than a real, human-navigable site; a best-effort heuristic classification, so `false`/absent is not a guarantee the domain is a real site), `reachable`, `status` (HTTP status of the last probe attempt, when one was made), `technologies` (each with `name`, `categories`, `confidence`, `version`, `evidence`), `technology_names`, `categories`, `tech_count`, the `cms`/`ecommerce`/`cdn`/`web_server`/`server_language` rollups, `render_tier`, `detector_version`, and the crawl provenance (`run_id`, `crawled_at`). - When the last probe attempt didn't fully pass, the item also carries `failure_reason` (a short classification, e.g. `"blocked/challenge markers found"`, `"bad status 503"`, `"request failed"`), `probe_error` (the first line of the underlying transport error, when there was one), and `block_matched` (which block/challenge marker(s) were found, when `failure_reason` is a block/challenge classification). This can appear even when `reachable` is `true` — a blocked page returning a non-5xx status still counts as reachable while carrying a failure reason. Absent for a site that fully passed. - When the crawl looked for extra non-homepage pages (opt-in per run), the item also carries `secondary_pages_discovered` (count of candidate pages found on the homepage nav, regardless of fetch outcome), `secondary_pages_fetched` (count that were actually fetched successfully and contributed content — always <= discovered), `secondary_page_categories` (which categories were successfully fetched and contributed, e.g. `login`, `docs`, `cart`), `secondary_pages` (the full per-page audit trail — every discovered candidate, each entry `{category, url, fetched}`; `fetched: false` means the candidate was found on the homepage nav but the fetch itself failed, e.g. blocked or timed out), and `secondary_only_technology_names` (technology names detected only via a fetched secondary page, not the homepage itself — a subset of `technology_names`). Absent when no secondary pages were discovered for that run. - Returns the standard not-found envelope when the domain is not in the index. - Does not trigger live scraping; for a live, on-demand fingerprint of any URL use `/web/techstack`. Example response: ```json { "code": 200, "msg": "OK", "data": { "domain": "example-store.com", "tld": "com", "rank": 5231, "reachable": true, "technologies": [ { "name": "Shopify", "categories": ["Ecommerce"], "confidence": "high", "evidence": "markup: cdn.shopify.com" }, { "name": "Google Analytics", "categories": ["Analytics"], "confidence": "high", "evidence": "script: googletagmanager.com/gtag/js" }, { "name": "Cloudflare", "categories": ["CDN"], "confidence": "high", "evidence": "header: cf-ray" } ], "technology_names": ["Shopify", "Google Analytics", "Cloudflare", "Afterpay"], "categories": ["Analytics", "CDN", "Ecommerce", "Payment"], "tech_count": 4, "ecommerce": "Shopify", "cdn": "Cloudflare", "secondary_pages_discovered": 2, "secondary_pages_fetched": 1, "secondary_page_categories": ["cart"], "secondary_pages": [ { "category": "cart", "url": "https://example-store.com/cart", "fetched": true }, { "category": "docs", "url": "https://example-store.com/docs", "fetched": false } ], "secondary_only_technology_names": ["Afterpay"], "render_tier": "http", "detector_version": "2026.07.4", "run_id": "top1m-2026-07-08" } } ```

レスポンスに関する注記

- Each item carries `domain`, `tld`, `rank`, `is_infrastructure` (`true` when the domain looks like backend CDN/DNS/cloud-vendor infrastructure rather than a real, human-navigable site; a best-effort heuristic), `reachable`, `technologies` (each with `name`, `categories`, `confidence`, `version`, `evidence`), `technology_names`, `categories`, `tech_count`, the `cms`/`ecommerce`/`cdn`/`web_server`/`server_language` rollups, `render_tier`, and `detector_version`. - When the crawl looked for extra non-homepage pages (opt-in per run), items also carry `secondary_pages_discovered` (count of candidates found on the homepage nav, regardless of fetch outcome), `secondary_pages_fetched` (count actually fetched successfully), `secondary_page_categories` (which categories were successfully fetched, e.g. `login`, `docs`, `cart`), `secondary_pages` (the full per-page audit trail, each entry `{category, url, fetched}`), and `secondary_only_technology_names` (technologies detected only via a fetched secondary page, not the homepage itself — a subset of `technology_names`). Absent when no secondary pages were discovered for that run. - The maximum result window is `10000`; `page * page_size` must not exceed `10000`. - Invalid enum values return the standard invalid params envelope. - Returns an empty `items` array (not an error) when nothing matches or the dataset has no data yet. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "techstack", "items": [ { "domain": "example-store.com", "tld": "com", "rank": 5231, "reachable": true, "technologies": [ { "name": "Shopify", "categories": ["Ecommerce"], "confidence": "high", "evidence": "markup: cdn.shopify.com" }, { "name": "Cloudflare", "categories": ["CDN"], "confidence": "high", "evidence": "header: cf-ray" } ], "technology_names": ["Shopify", "Cloudflare"], "categories": ["CDN", "Ecommerce"], "tech_count": 2, "ecommerce": "Shopify", "cdn": "Cloudflare", "render_tier": "http", "detector_version": "2026.07.4" } ], "page": 1, "page_size": 20, "total": 1, "sort": "rank_asc" } } ```

レスポンスに関する注記

- Returns up to `50` buckets ordered by descending count. - `facet` is required; unsupported values return the standard invalid params envelope. - Boolean facets (`is_blue_verified`, `has_bio`, `has_external_url`) return `true`/`false` bucket values. - `source_tier` bucket values are the seed tier names, e.g. `github-users`, `wikidata`, `tiktok-creators`, `journalists`. `unknown` labels records whose discovery tier was not recorded. - Returns an empty `items` array (not an error) when the dataset has no data yet. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "x-users", "facet": "source_tier", "items": [ { "value": "wikidata", "count": 427709 }, { "value": "github-users", "count": 54790 }, { "value": "tiktok-creators", "count": 4466 }, { "value": "journalists", "count": 840 } ] } } ```

レスポンスに関する注記

- Returns `404` when the username is not present in the stored dataset. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "username": "octodev", "id": "1634026666518519808", "name": "Octo Dev", "bio": "Building things in public", "location_raw": "Berlin, Germany", "external_url": "https://octo.dev", "avatar_url": "https://pbs.twimg.com/profile_images/example_normal.jpg", "banner_url": "https://pbs.twimg.com/profile_banners/example/banner", "is_blue_verified": true, "has_bio": true, "has_external_url": true, "followers": 12000, "following": 800, "posts": 3400, "follower_following_ratio": 15.0, "created_at": "2020-01-02T03:04:05Z", "source_tier": "github-users", "crawled_at": "2026-07-14T09:53:36Z", "schema_version": 1 } } ```

レスポンスに関する注記

- Defaults to `relevance` sort when `q` is supplied, otherwise `followers_desc`. - `crawled_at_asc` returns the stalest records first; `created_at_asc` the oldest accounts first. - `min_followers` must not exceed `max_followers`, and `min_ratio` must not exceed `max_ratio`. - Date filters accept an RFC3339 timestamp or a bare `YYYY-MM-DD` calendar date; other formats return the invalid params envelope. - The maximum result window is `10000`; `page * page_size` must not exceed `10000`. - Invalid enum values return the standard invalid params envelope. - Returns an empty `items` array (not an error) when the dataset has no matches yet. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "x-users", "items": [ { "username": "octodev", "name": "Octo Dev", "bio": "Building things in public", "location_raw": "Berlin, Germany", "external_url": "https://octo.dev", "avatar_url": "https://pbs.twimg.com/profile_images/example_normal.jpg", "is_blue_verified": true, "has_bio": true, "has_external_url": true, "followers": 12000, "following": 800, "posts": 3400, "follower_following_ratio": 15.0, "source_tier": "github-users", "crawled_at": "2026-07-14T09:53:36Z", "schema_version": 1 } ], "page": 1, "page_size": 20, "total": 1, "sort": "followers_desc" } } ```

レスポンスに関する注記

- `facet` parameter must be one of the documented enum values; invalid values return `400`. - Aggregates document counts up to top `50` buckets. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "youtube-creators", "facet": "region", "items": [ { "value": "US", "count": 612000 }, { "value": "IN", "count": 388000 }, { "value": "BR", "count": 201000 } ] } } ```

レスポンスに関する注記

- Returns `404` when the channel is not present in the dataset. Example response: ```json { "code": 200, "msg": "OK", "data": { "channel_id": "UCX6OQ3DkcsbYNE6H8uQQuVA", "channel_name": "MrBeast", "channel_url": "https://www.youtube.com/channel/UCX6OQ3DkcsbYNE6H8uQQuVA", "profile_pic": "https://yt3.googleusercontent.com/avatar.jpg", "links": ["https://www.beastphilanthropy.org"], "followers_count": 300000000, "followers_count_available": true, "videos_count": 830, "videos_count_available": true, "views_count": 55000000000, "views_count_available": true, "region": "US", "bio": "SUBSCRIBE FOR A COOKIE!", "joined_date": "2012-02-20T00:00:00Z", "discovery_source": "commoncrawl", "status": "ok", "discovered_at": "2026-07-03T00:00:00Z", "hydrated_at": "2026-08-19T00:00:00Z" } } ```

レスポンスに関する注記

- Defaults to `relevance` sort when `q` is supplied, otherwise `followers_desc`. - Some channels hide their subscriber, video, or view count on their public page. In that case the count is stored as `0` and its matching `*_available` flag is `false` — use the `_available` flags to tell a hidden count apart from a genuine `0`, and be aware that a `min_followers` filter above `0` will exclude channels with a hidden subscriber count. - `min_*` must not exceed the matching `max_*`. - Date filters accept an RFC3339 timestamp or a bare `YYYY-MM-DD` calendar date. - The maximum result window is `10000`; `page * page_size` must not exceed `10000`. - Only successfully hydrated channels are ever returned. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "youtube-creators", "items": [ { "channel_id": "UCX6OQ3DkcsbYNE6H8uQQuVA", "channel_name": "MrBeast", "channel_url": "https://www.youtube.com/channel/UCX6OQ3DkcsbYNE6H8uQQuVA", "profile_pic": "https://yt3.googleusercontent.com/avatar.jpg", "links": ["https://www.beastphilanthropy.org"], "followers_count": 300000000, "followers_count_available": true, "videos_count": 830, "videos_count_available": true, "views_count": 55000000000, "views_count_available": true, "region": "US", "bio": "SUBSCRIBE FOR A COOKIE!", "joined_date": "2012-02-20T00:00:00Z", "discovery_source": "commoncrawl", "status": "ok", "discovered_at": "2026-07-03T00:00:00Z", "hydrated_at": "2026-08-19T00:00:00Z" } ], "page": 1, "page_size": 20, "total": 2490319, "sort": "followers_desc" } } ```