# SocialCrawl API: g2 endpoints
# Base URL: https://www.socialcrawl.dev
# Auth: x-api-key header
# Full docs: https://www.socialcrawl.dev/docs/g2

## GET /v1/g2/product
Get a G2 product by slug or URL
Credit cost: 5 (advanced)
Parameters:
- id (optional, string): G2 product slug or full G2 product URL. Slug example: postman. URL example: https://www.g2.com/products/postman/reviews.
- url (optional, string): G2 product slug or full G2 product URL. Slug example: postman. URL example: https://www.g2.com/products/postman/reviews.
- website_contacts_crawl_mode (optional, enum: off | homepage | deep): How far to crawl the product website for emails, phones, and social profiles. Default off. homepage scans the homepage only. deep also crawls contact, about, careers, and blog pages.
- Constraint: one of id, url (at least one required)
curl -G "https://www.socialcrawl.dev/v1/g2/product" \
  --data-urlencode "id=postman" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/g2/reviews
Get G2 reviews for a product
Credit cost: 5-9 (metered): 5 credits per page. The default labels (sentiment, issue) are free. label=reports, incentivized or injection holds 4 extra credits and refunds down to 1 credit per started 25 reviews that were newly judged (the first 100 reviews of a page are judged): reviews already labelled are free, a page where nothing could be judged refunds the whole extra, and a cached page is free. With `max_pages`, `max_items` or `max_credits`, each page walked is billed at this price (a cached page is free), and `max_credits` caps the total.
Parameters:
- id (optional, string): G2 product slug or full G2 product URL. Slug example: postman. URL example: https://www.g2.com/products/postman/reviews.
- url (optional, string): G2 product slug or full G2 product URL. Slug example: postman. URL example: https://www.g2.com/products/postman/reviews.
- page (optional, integer): Page number, starting at 1. Prefer the universal cursor parameter.
- industry (optional, string): Comma-separated G2 industry ids. Discover valid ids from a first unfiltered call.
- keywords (optional, string): Free-text search inside review bodies.
- region (optional, string): Comma-separated reviewer regions: North America, Europe, Asia, Latin America, Middle East, Africa, ANZ.
- role (optional, string): Comma-separated reviewer roles, for example Administrator, User, Consultant.
- segment (optional, enum: small-business | mid-market | enterprise): Reviewer company size: small-business (50 or fewer), mid-market (51-1000), enterprise (more than 1000).
- sort (optional, enum: default | most-recent | most-helpful | highest-rated | lowest-rated): Review order. Default is G2 relevance.
- stars (optional, string): Comma-separated star ratings, for example 4,5.
- label (optional, string): Optional CSV of SocialCrawl labels to add to every review. Without this param every page already carries sentiment and issue, free; label= adds the labels you name to them (the defaults keep running). sentiment and issue are free when asked for too; reports, incentivized and injection add 1 credit per started 25 newly judged reviews. judgments=off (or label=none) turns the default labels off. They read the review's title and text, never its stars. sentiment: how the reviewer feels, on five levels (level 0 to 4, score_0_1, confidence), plus rating_mismatch, true when the words clearly contradict the star rating (a glowing text under 1 star, a furious one under 5), null when the review has no rating. issue: the main problem the review reports (label: product_defect, sizing_or_fit, shipping_or_delivery, customer_service, price_or_value, missing_feature, other, or none, with confidence; label is null when unsure). reports (needs reports=): does this review say that the thing you describe happened (p, 0 to 1). incentivized: does the reviewer say they got the product free, discounted or rewarded for the review (p), and did the text carry a disclosure such as 'in exchange for my honest review', Vine or 체험단 (disclosed). injection flags text that addresses an AI system and tries to direct it (flagged, p); it never drops or rewrites a row. These are signals to read, never a verdict on a review or a reviewer. A review that could not be judged carries labels: null. Reviews already labelled for anyone are free, and so is a cached page. data.labels reports what was judged and billed.
- reports (optional, string): Required by label=reports, ignored otherwise. What to look for, in plain words, up to 300 characters, for example reports=the battery drains quickly or reports=배송이 늦음. Every review gains labels.reports.p, the probability that it says so, in any wording or language. Without it label=reports is skipped with the warning label_reports_needs_reports and is not billed.
- judgments (optional, enum: on | off): Optional, on (the default) or off. By default every row gains free SocialCrawl judgments (computed.labels, and computed.relevance on search endpoints), reported in data.labels (mode default) and data.relevance (origin default), each with a status (complete, partial or skipped) and pending: the rows still being judged when the page was sent, which carry null now and are filled on your next call or cached read. Default judgments never add credits, never change an existing field, and never drop or reorder a row. off returns the page exactly as before, with none of those keys. label=none does the same.
- dry_run (optional, enum: 1): Optional. When 1, return a cost preview for this labelled or relevance-filtered request without fetching the page or judging any row. data.estimate reports rows_expected, rows_cached, label_credits_min, label_credits_max and base_credits. 0 credits charged.
- label_evidence (optional, enum: 1): Optional, only with label=. When 1, every labelled row also carries computed.labels_evidence.<preset> = { quote, sentence_index }: the sentence in the row that most clearly shows the label, copied verbatim. Absent or null when no single sentence shows it.
- fit (optional, enum: goal): Optional. When goal, keep the rows and fields needed for the goal you pass in goal= (plus any that are uncertain, and the first and last), and replace the rest with a stub. data.held_back lists the held ids and a recall id that re-reads the full page from cache at no extra charge. Without this param the page is unchanged.
- goal (optional, string): Required by fit=goal. What you are trying to do, in your own words, up to 300 characters.
- fit_tokens (optional, integer): Optional, only with fit=goal. Soft cap on how much of the page to keep, in tokens. Uncertain blocks and the first and last block are kept even if they exceed it.
- since (optional, string): Only rows published on or after this date: YYYY-MM-DD (midnight UTC) or an ISO 8601 timestamp. Rows older than it are left off each page. This list is not in date order, so the walk does not stop at the date: keep following `next_cursor`, and each page costs what a page costs even when every row on it is filtered out. A row with no date is kept. `published_after`, `start_date`, `from_date`, `publish_time` (`yesterday`, `this-week`, `this-month`, `last-3-months`, `last-6-months`) and `max_age_days` are accepted and applied as `since`.
- until (optional, string): Only rows published on or before this date: YYYY-MM-DD (that whole UTC day is included) or an ISO 8601 timestamp. Newer rows are left off each page and the walk does not stop, so older pages follow. A row with no date is kept. `published_before`, `end_date` and `to_date` are accepted and applied as `until`.
- max_pages (optional, integer): 1 to 50 (default 1, or 50 when `max_items` or `max_credits` is sent). Walk up to this many pages in one call and return the rows from all of them. Each page walked is billed exactly as one call to this endpoint (a cached page is free) and counts against your rate limit; its charge and any refund are recorded under the page's own request id, listed in `data.walk.request_ids`. The walk stops early at the last page, or when the request's time budget runs low; `data.walk.stopped` says why (`end`, `max_pages`, `max_items`, `max_credits`, `time_budget`, `page_error`) and `pagination.next_cursor` continues from where it stopped.
- max_items (optional, integer): 1 to 5000. Get more in one call: keep walking pages until the response holds at least this many rows, then stop with `data.walk.stopped: "max_items"`. The last page is returned whole (it was billed), so `data.items` can hold up to one page more than this, and `pagination.next_cursor` resumes right after it without skipping a row. Walks up to 50 pages unless `max_pages` says fewer; each page is billed as one call (a cached page is free). Add `max_credits` to cap the spend. A long walk can stop on the time budget first (`"time_budget"`): send the returned cursor with the same params to continue.
- max_credits (optional, integer): 1 to 100000. The most this call may spend, across every page it walks. A page starts only while the credits already spent plus that page's price (or, when higher, the most any page of this walk has cost) still fit, so the call never goes past it; the walk then stops with `data.walk.stopped: "max_credits"` and the cursor to resume. Sent alone, it walks as far as the budget goes (up to 50 pages). A value below the price of one page is a free 400 whose `error.details.page_credits` names that price. Credits a row join (`include=`) adds are known only once a page has run, so page 1 is checked against its own price.
- Constraint: one of id, url (at least one required)
Worth sending:
- label=issue: Names the product issue each review raises, at no extra credits; sentiment is free too.
curl -G "https://www.socialcrawl.dev/v1/g2/reviews" \
  --data-urlencode "id=postman" \
  --data-urlencode "label=issue" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/g2/category
List products in a G2 category
Credit cost: 5 (advanced)
Parameters:
- category (required): G2 category slug or full category URL, for example marketing-automation or https://www.g2.com/categories/marketing-automation.
- page (optional, integer): Page number, starting at 1. Prefer the universal cursor parameter.
- sort (optional, enum: g2-score | popularity | satisfaction): Product order in the category. Default g2-score.
- max_pages (optional, integer): 1 to 50 (default 1, or 50 when `max_items` or `max_credits` is sent). Walk up to this many pages in one call and return the rows from all of them. Each page walked is billed exactly as one call to this endpoint (a cached page is free) and counts against your rate limit; its charge and any refund are recorded under the page's own request id, listed in `data.walk.request_ids`. The walk stops early at the last page, or when the request's time budget runs low; `data.walk.stopped` says why (`end`, `max_pages`, `max_items`, `max_credits`, `time_budget`, `page_error`) and `pagination.next_cursor` continues from where it stopped.
- max_items (optional, integer): 1 to 5000. Get more in one call: keep walking pages until the response holds at least this many rows, then stop with `data.walk.stopped: "max_items"`. The last page is returned whole (it was billed), so `data.items` can hold up to one page more than this, and `pagination.next_cursor` resumes right after it without skipping a row. Walks up to 50 pages unless `max_pages` says fewer; each page is billed as one call (a cached page is free). Add `max_credits` to cap the spend. A long walk can stop on the time budget first (`"time_budget"`): send the returned cursor with the same params to continue.
- max_credits (optional, integer): 1 to 100000. The most this call may spend, across every page it walks. A page starts only while the credits already spent plus that page's price (or, when higher, the most any page of this walk has cost) still fit, so the call never goes past it; the walk then stops with `data.walk.stopped: "max_credits"` and the cursor to resume. Sent alone, it walks as far as the budget goes (up to 50 pages). A value below the price of one page is a free 400 whose `error.details.page_credits` names that price. Credits a row join (`include=`) adds are known only once a page has run, so page 1 is checked against its own price.
curl -G "https://www.socialcrawl.dev/v1/g2/category" \
  --data-urlencode "category=marketing-automation" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/g2/categories
List every G2 category URL
Credit cost: 1 (standard)
curl "https://www.socialcrawl.dev/v1/g2/categories" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/g2/seller
Get a G2 seller (vendor) profile
Credit cost: 5 (advanced)
Parameters:
- id (optional, string): G2 seller slug or full G2 seller URL. Slug example: hubspot. URL example: https://www.g2.com/sellers/hubspot.
- url (optional, string): G2 seller slug or full G2 seller URL. Slug example: hubspot. URL example: https://www.g2.com/sellers/hubspot.
- handle (optional, string): G2 seller slug or full G2 seller URL. Slug example: hubspot. URL example: https://www.g2.com/sellers/hubspot.
- products_page (optional, integer): Page of the seller product portfolio, 9 products per page.
- reviews_page (optional, integer): Page of cross-product review teasers, 3 per page, capped at 10.
- Constraint: one of id, url, handle (at least one required)
curl -G "https://www.socialcrawl.dev/v1/g2/seller" \
  --data-urlencode "id=hubspot" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/g2/seller/products
List products for a G2 seller
Credit cost: 5 (advanced)
Parameters:
- id (optional, string): G2 seller slug or full G2 seller URL. Slug example: hubspot. URL example: https://www.g2.com/sellers/hubspot.
- url (optional, string): G2 seller slug or full G2 seller URL. Slug example: hubspot. URL example: https://www.g2.com/sellers/hubspot.
- page (optional, integer): Page number, starting at 1. Prefer the universal cursor parameter.
- max_pages (optional, integer): 1 to 50 (default 1, or 50 when `max_items` or `max_credits` is sent). Walk up to this many pages in one call and return the rows from all of them. Each page walked is billed exactly as one call to this endpoint (a cached page is free) and counts against your rate limit; its charge and any refund are recorded under the page's own request id, listed in `data.walk.request_ids`. The walk stops early at the last page, or when the request's time budget runs low; `data.walk.stopped` says why (`end`, `max_pages`, `max_items`, `max_credits`, `time_budget`, `page_error`) and `pagination.next_cursor` continues from where it stopped.
- max_items (optional, integer): 1 to 5000. Get more in one call: keep walking pages until the response holds at least this many rows, then stop with `data.walk.stopped: "max_items"`. The last page is returned whole (it was billed), so `data.items` can hold up to one page more than this, and `pagination.next_cursor` resumes right after it without skipping a row. Walks up to 50 pages unless `max_pages` says fewer; each page is billed as one call (a cached page is free). Add `max_credits` to cap the spend. A long walk can stop on the time budget first (`"time_budget"`): send the returned cursor with the same params to continue.
- max_credits (optional, integer): 1 to 100000. The most this call may spend, across every page it walks. A page starts only while the credits already spent plus that page's price (or, when higher, the most any page of this walk has cost) still fit, so the call never goes past it; the walk then stops with `data.walk.stopped: "max_credits"` and the cursor to resume. Sent alone, it walks as far as the budget goes (up to 50 pages). A value below the price of one page is a free 400 whose `error.details.page_credits` names that price. Credits a row join (`include=`) adds are known only once a page has run, so page 1 is checked against its own price.
- Constraint: one of id, url (at least one required)
curl -G "https://www.socialcrawl.dev/v1/g2/seller/products" \
  --data-urlencode "id=google" \
  -H "x-api-key: YOUR_API_KEY"

## GET /v1/g2/product-index
List G2 product URLs
Credit cost: 5 (advanced)
Parameters:
- page (optional, integer): Page number, starting at 1. Prefer the universal cursor parameter.
curl "https://www.socialcrawl.dev/v1/g2/product-index" \
  -H "x-api-key: YOUR_API_KEY"