> **For coding agents and LLMs:** This is one page from the Social Fetch docs (markdown export). For curated orientation and workflow guidance, start with [`/llms.txt`](https://www.socialfetch.dev/llms.txt); for agent onboarding and crawl rules, use [`/agents.txt`](https://www.socialfetch.dev/agents.txt); for the full endpoint list with links to pages like this one, use [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt); for one platform's parameters and curls, use [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt); use [`/llms.json`](https://www.socialfetch.dev/llms.json) when you need structured JSON for tool registration. ## This page - **On-site (HTML):** [https://www.socialfetch.dev/docs/api/v1/hackernews/search/get](https://www.socialfetch.dev/docs/api/v1/hackernews/search/get) - **Markdown (.mdx) URL:** [https://www.socialfetch.dev/docs/api/v1/hackernews/search/get.mdx](https://www.socialfetch.dev/docs/api/v1/hackernews/search/get.mdx) ## API base URL and authentication - **API origin (from OpenAPI `servers`):** `https://api.socialfetch.dev` - **Authentication:** send `x-api-key: sfk_...` on `/v1/**` routes unless the operation is explicitly anonymous (check OpenAPI `security`, the [API reference hub](https://www.socialfetch.dev/docs/api.mdx), [`/llms.txt`](https://www.socialfetch.dev/llms.txt), or [`/llms.json`](https://www.socialfetch.dev/llms.json) for each route). - **OpenAPI JSON:** [https://www.socialfetch.dev/openapi.json](https://www.socialfetch.dev/openapi.json) ## Recommended docs entrypoints (this site) - [Documentation overview](https://www.socialfetch.dev/docs.mdx) — top-level orientation (markdown). - [Quickstart](https://www.socialfetch.dev/docs/quickstart.mdx) — authenticate with `x-api-key`, validate auth with `whoami`, and understand the JSON envelope. - [SDK](https://www.socialfetch.dev/docs/sdk.mdx) — official TypeScript SDK guide, including `SocialFetchClient`, `Result`, and `unwrap()`. - [SDK reference](https://www.socialfetch.dev/docs/sdk-reference.mdx) — exhaustive SDK method inventory and route mapping for agents, tooling, and power users. - [Choose the right endpoint](https://www.socialfetch.dev/docs/choose-endpoint.mdx) — task-oriented route selection for smoke tests, profiles, list endpoints, and single-item lookups. - [Capability matrix](https://www.socialfetch.dev/docs/capability-matrix.mdx) — fast comparison of identifiers, pagination, outcomes, media download, and SDK coverage. - [Recipes](https://www.socialfetch.dev/docs/recipes.mdx) — copyable workflows (brand monitoring, transcripts, Ad Library, creator scoring, Reddit research) with credit callouts and SDK examples. - [Integrations](https://www.socialfetch.dev/docs/integrations.mdx) — MCP for AI clients, n8n verified node, Apify Store Actors, SDK, and REST API connection paths. - [MCP product page](https://www.socialfetch.dev/mcp) — hosted MCP overview, OAuth, Skills install. - [MCP integration](https://www.socialfetch.dev/docs/integrations/mcp.mdx) — hosted `/mcp` server, OAuth, Cursor/VS Code/Claude install snippets, 154 endpoint tools, plus docs_search/docs_read for implementation help. - [n8n integration](https://www.socialfetch.dev/docs/integrations/n8n.mdx) — install `n8n-nodes-socialfetch`, credentials, and workflow examples. - [Apify integration](https://www.socialfetch.dev/docs/integrations/apify.mdx) — Store Actors under @social-fetch, PPE billing, dataset export, and quick start. - [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt) — every documented operation with a direct link to that route's agent-readable markdown page (prefer this over parsing OpenAPI). - [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt) — per-platform endpoint files generated from OpenAPI (parameters, credits, curls). - [`/agents.txt`](https://www.socialfetch.dev/agents.txt) — agent crawl/onboarding file with capabilities, auth rules, and allowlist. - [`/llms.json`](https://www.socialfetch.dev/llms.json) — structured machine-readable operation inventory with parameter names, pagination, outcomes, credits, and SDK mapping. - [API reference hub](https://www.socialfetch.dev/docs/api.mdx) — human-friendly index of operations with links into generated pages. - [Errors](https://www.socialfetch.dev/docs/errors.mdx) — shared error envelope and HTTP status guidance. - [Credits](https://www.socialfetch.dev/docs/credits.mdx) — metering, `402`, and planning batch jobs. - Outcome semantics such as `found`, `not_found`, and `private` are documented in [Errors](https://www.socialfetch.dev/docs/errors.mdx) and on operation pages when present in the OpenAPI contract. ## Markdown docs convention - Every docs page has a markdown twin: append **`.mdx`** to the docs pathname (for example `/docs/quickstart` → `/docs/quickstart.mdx`). - Agents that send `Accept: text/markdown` on `/docs/**` HTML URLs may receive markdown directly (same URL, `Vary: Accept`). --- # Search Hacker News (https://www.socialfetch.dev/docs/api/v1/hackernews/search/get) ## Summary Search Hacker News by keyword. **Tags:** `Hacker News` ## HTTP - **Method:** GET - **Path:** `/v1/hackernews/search` - **Base URL:** `https://api.socialfetch.dev` ## Capability summary - **SDK mapping:** `client.hackernews.search({ query: "Dropbox" })` - **Accepted identifiers:** `query` (query), `author` (query), `domain` (query), `url` (query) - **Pagination:** page via `page`, next page: `data.page.nextPage`, has more: `data.page.hasMore` ## Credits - **Base:** 1 credit per successful lookup. - **Maximum on success (200):** 1 credit. - **Normalization failure (502):** 0 credits charged. - **Authoritative field:** `meta.creditsCharged`. ## Authentication - **`x-api-key`**: API key (`sfk_...`) ## Parameters ### `query` (query) - **Required:** no - **Constraints:** type `string`; maxLength: 512 - **Description:** Full-text search query. Required unless `frontPageOnly`, `author`, `domain`, or `url` is set. ### `type` (query) - **Required:** no - **Constraints:** type `string`; enum: all, story, comment, ask_hn, show_hn, launch_hn, job, poll - **Description:** Content type filter. Default: `all`. ### `sort` (query) - **Required:** no - **Constraints:** type `string`; enum: popularity, date - **Description:** Ranking mode. Default: `popularity`. ### `dateRange` (query) - **Required:** no - **Constraints:** type `string`; enum: 24h, week, month, year, all - **Description:** Creation-time window. Default: `all`. ### `page` (query) - **Required:** no - **Constraints:** type `integer`; minimum: 0; maximum: 49; nullable - **Description:** Zero-based page index (maximum 50 pages, up to 1,000 hits). ### `pageSize` (query) - **Required:** no - **Constraints:** type `integer` - **Description:** Hits per page. Default: 20. ### `frontPageOnly` (query) - **Required:** no - **Constraints:** type `boolean` - **Description:** When true, restrict results to current front-page items. Allows omitting `query`. ### `searchStoryText` (query) - **Required:** no - **Constraints:** type `boolean` - **Description:** Include story/comment text in searchable fields. Default: true. Set false to search title/URL only. ### `searchAuthor` (query) - **Required:** no - **Constraints:** type `boolean` - **Description:** When true, include author username in the searchable fields. ### `prefix` (query) - **Required:** no - **Constraints:** type `boolean` - **Description:** When true, enable prefix matching for query tokens. ### `typoTolerance` (query) - **Required:** no - **Constraints:** type `boolean` - **Description:** Enable typo tolerance. Default: true. ### `author` (query) - **Required:** no - **Constraints:** type `string`; minLength: 1; maxLength: 255; pattern: `^[A-Za-z0-9_-]+$` - **Description:** Restrict results to items by this Hacker News username. ### `domain` (query) - **Required:** no - **Constraints:** type `string`; minLength: 1; maxLength: 255 - **Description:** Restrict search to story URLs matching this domain (e.g. example.com). Can omit `query`. ### `url` (query) - **Required:** no - **Constraints:** type `string`; minLength: 1; maxLength: 2048 - **Description:** Restrict search to story URLs matching this URL substring. Can omit `query`. ### `minPoints` (query) - **Required:** no - **Constraints:** type `integer`; minimum: 0; maximum: 1000000; nullable - **Description:** Minimum points/score filter. ## Responses (status codes) - **200**: Hacker News search results. - **400**: Invalid search query - **401**: Missing or invalid API key - **402**: Insufficient credits - **500**: Unexpected or billing error - **502**: Lookup could not be completed. - **503**: Service temporarily unavailable; safe to retry with backoff. ## Response body (200) Hacker News search results. ### Field outline - **data** (required) — type `object`. Endpoint-specific response payload. - **query** (required) — type `string`; nullable. Search query evaluated for this response, or null for front-page-only. - **hits** (required) — type `array`. Search hits for this page. - _items:_ - **id** (required) — type `integer`; minimum: 0. Hacker News item id. - **type** (required) — type `string`; enum: story, comment, poll, job, pollopt, unknown. Normalized content type. - **author** (required) — type `string`; nullable. Author username when present. - **createdAt** (required) — type `string`; nullable. Creation time as an ISO-8601 timestamp. - **title** (required) — type `string`; nullable. Plain-text title when present. - **text** (required) — type `string`; nullable. Plain-text body when present (HTML stripped). - **url** (required) — type `string`; nullable. External story URL when present and publicly safe. - **score** (required) — type `integer`; nullable. Points / score when present. - **commentCount** (required) — type `integer`; nullable. Comment count for stories when present. - **storyId** (required) — type `integer`; minimum: 0; nullable. Parent story id for comment hits when present. - **parentId** (required) — type `integer`; minimum: 0; nullable. Immediate parent item id when present. - **tags** (required) — type `array`. Normalized content tags for this hit (e.g. story, ask_hn). - _items:_ - type `string`; minLength: 1 - **itemUrl** (required) — type `string`. Canonical news.ycombinator.com item URL. - **page** (required) — type `object`. Pagination information for the current response. - **page** (required) — type `integer`; minimum: 0. Zero-based page index for this response. - **pageSize** (required) — type `integer`; minimum: 0. Requested page size for this response. - **returned** (required) — type `integer`; minimum: 0. Number of hits returned in this response. - **hasMore** (required) — type `boolean`. Whether another page of results is available. - **nextPage** (required) — type `integer`; minimum: 0; nullable. Next page index when hasMore is true; otherwise null. - **totalHits** (required) — type `integer`; minimum: 0. Reported total hit count from the search index. - **totalHitsExact** (required) — type `boolean`. Whether totalHits is exhaustive. When false, treat totalHits as an estimate. - **maxAccessibleHits** (required) — type `integer`; minimum: 0. Hard upper bound on pageable hits from the search index (typically 1000). - **meta** (required) — type `object`. Metadata describing the request and billing outcome. - **requestId** (required) — type `string`; minLength: 1. Unique request identifier for tracing this API call. - **creditsCharged** (required) — type `integer`; minimum: 0. Credits charged for this request. - **version** (required) — type `string`; enum: v1. Public API version that served the response. - **cached** (optional) — type `boolean`. True when served from shared response cache. Credits still apply (full endpoint price); Age header may be present. ### Example JSON (found) ```json { "data": { "query": "Dropbox", "hits": [ { "id": 8863, "type": "story", "author": "dhouston", "createdAt": "2007-04-04T19:16:40.000Z", "title": "My YC app: Dropbox - Throw away your USB drive", "text": null, "url": "http://www.getdropbox.com/u/2/screencast.html", "score": 104, "commentCount": 71, "storyId": 8863, "parentId": null, "tags": [ "story" ], "itemUrl": "https://news.ycombinator.com/item?id=8863" } ], "page": { "page": 0, "pageSize": 20, "returned": 1, "hasMore": false, "nextPage": null, "totalHits": 1, "totalHitsExact": true, "maxAccessibleHits": 1000 } }, "meta": { "requestId": "req_01example_hackernews_search", "creditsCharged": 1, "version": "v1" } } ``` ### Machine-readable error codes When an error JSON body is returned, it may include one of these `error.code` values (derived from the OpenAPI schemas for this operation; additional codes may exist at runtime): - `bad_request` ## Error handling & retries Interpret HTTP status codes using the descriptions below. Do not assume a JSON body unless the OpenAPI schema defines one for that status. - **400**: Invalid search query **Retry:** Fix the request; retrying the same invalid payload will not help. - **401**: Missing or invalid API key **Retry:** Fix the API key first; retrying without changes will not help. - **402**: Insufficient credits **Retry:** Do not retry without resolving billing/credits (retrying the same request will not help). - **500**: Unexpected or billing error - **502**: Lookup could not be completed. **Retry:** May be transient; a few retries with backoff are reasonable. - **503**: Service temporarily unavailable; safe to retry with backoff. **Retry:** Usually safe to retry with exponential backoff and jitter. ### Suggested client defaults - Send the API key using the `x-api-key` header on every request. - On `503` (and sometimes `502`), retry with backoff; cap retries and surface a clear error to the user. - On `402`, surface an actionable billing message rather than blind retries. ## Examples ### TypeScript SDK ```typescript import { SocialFetchClient } from "@socialfetch/sdk"; const client = new SocialFetchClient({ apiKey: process.env.SOCIALFETCH_API_KEY!, }); const result = await client.hackernews.search({ query: "Dropbox", }); if (!result.ok) { console.error(result.error); } else { console.log(result.value.data); } ``` ### Node.js ```javascript const response = await fetch( "https://api.socialfetch.dev/v1/hackernews/search?query=Dropbox", { headers: { "x-api-key": "YOUR_API_KEY" } } ); const data = await response.json(); console.log(data); ``` ### cURL ```bash curl "https://api.socialfetch.dev/v1/hackernews/search?query=Dropbox" \ -H "x-api-key: YOUR_API_KEY" ``` ### Python ```python import requests response = requests.get( "https://api.socialfetch.dev/v1/hackernews/search?query=Dropbox", headers={"x-api-key": "YOUR_API_KEY"}, ) data = response.json() print(data) ```