> **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/bing/rank/get>
- **Markdown (.mdx) URL:** <https://www.socialfetch.dev/docs/api/v1/bing/rank/get.mdx>

## API base URL and authentication

- **API origin (from OpenAPI `servers`):** `https://api.socialfetch.dev`
- **Authentication:** send `x-api-key: sfk_...` on `/v1/**` and `/v2/**` 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>

## 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()`.
- [Capability matrix](https://www.socialfetch.dev/docs/capability-matrix.mdx) — every operation with identifiers, pagination, outcomes, media download, credits, and its SDK method. Generated from OpenAPI, so use it for route selection instead of scanning individual pages.
- [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, Make custom app, 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, 1112 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.
- [Make integration](https://www.socialfetch.dev/docs/integrations/make.mdx) — custom app modules for Make scenarios, API key credentials, and module catalog.
- [`/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`).
- Published blog posts use the same convention: `/blog/{slug}` → `/blog/{slug}.mdx`, or `Accept: text/markdown` on the HTML URL (`Vary: Accept`).

---
# Check a site's Bing rank (https://www.socialfetch.dev/docs/api/v1/bing/rank/get)

## Summary

Check where a site ranks in Bing's web results for a keyword, up to 100 results deep.

**Tags:** `Bing`

## HTTP

- **Method:** GET
- **Path:** `/v1/bing/rank`
- **Base URL:** `https://api.socialfetch.dev`

## Capability summary

- **SDK mapping:** `client.bing.checkRank({ query: "marathon training plan", domain: "halhigdon.com" })`
- **Accepted identifiers:** `query` (query), `domain` (query)
- **Pagination:** none
- **Business outcome field:** `data.lookupStatus` with values `found`, `not_found`

## Credits

- **Base:** 1 credit per successful lookup.
- **Maximum on success (200):** 1 credit.
- **Failed requests (`lookup_failed`, `503`):** not charged.
- **Authoritative field:** `meta.creditsCharged`.

## Authentication

- **`x-api-key`**: API key (`sfk_...`)

## Parameters

### `query` (query)

- **Required:** yes
- **Constraints:** type `string`; minLength: 1; maxLength: 500
- **Description:** The search to rank in, e.g. `marathon training plan`.

### `domain` (query)

- **Required:** yes
- **Constraints:** type `string`; maxLength: 253; pattern: `^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z]{2,63}$`
- **Description:** The site to find, e.g. `halhigdon.com`. A URL is accepted and reduced to its host; `www.` and subdomains match too.

### `depth` (query)

- **Required:** no
- **Constraints:** type `integer`; minimum: 10; maximum: 100
- **Description:** How many results to check, 10 to 100. Default: 50.

### `time` (query)

- **Required:** no
- **Constraints:** type `string`; enum: day, week, month
- **Description:** Only results from the past `day`, `week` or `month`. Default: any time.

### `country` (query)

- **Required:** no
- **Constraints:** type `string`; pattern: `^[A-Z]{2}$`
- **Description:** Two-letter country code of the results' market, e.g. `GB` or `DE`. Default: `US`.

### `language` (query)

- **Required:** no
- **Constraints:** type `string`; pattern: `^[a-z]{2}$`
- **Description:** Two-letter language code for a country with several, e.g. `fr` with `CH`. Default: the market's first language.

## Responses (status codes)

- **200**: Where a site ranks for a query on Bing.
- **400**: Invalid request
- **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)

Where a site ranks for a query on Bing.

### Field outline

- **data** (required) — type `object`. Endpoint-specific response payload.
  - **lookupStatus** (required) — type `string`; enum: found, not_found. `found` when the site ranks within the depth checked; `not_found` when it does not.
  - **query** (required) — type `string`. The query that was searched.
  - **domain** (required) — type `string`. The site that was looked for.
  - **market** (required) — type `string`. Bing's market the results are for, e.g. `en-US`.
  - **position** (required) — type `integer`; nullable. The site's best position, from 1; null when it was not found.
  - **result** (required) — type `object`; nullable. The site's best-ranked result; null when it was not found.
    - **position** (required) — type `integer`. Rank in the web results, from 1.
    - **title** (required) — type `string`. Result title.
    - **url** (required) — type `string`. The page the result links to.
    - **displayUrl** (required) — type `string`; nullable. The address as Bing shows it, e.g. `https://www.rei.com › learn`.
    - **snippet** (required) — type `string`; nullable. Text under the title.
    - **date** (required) — type `string`; nullable. The date Bing shows before the snippet, e.g. `Oct 31, 2026`.
  - **positions** (required) — type `array`. Every position of the site on the pages checked.
    - _items:_
      - type `integer`
  - **checkedResults** (required) — type `integer`. Results checked before the answer was settled.
  - **pagesChecked** (required) — type `integer`. Result pages read.
  - **exhausted** (required) — type `boolean`. Whether Bing ran out of results before the depth.
  - **featured** (required) — type `boolean`. Whether the site is linked from Bing's other blocks on the pages checked (an entity card, an answer, the summary's sources, the side panel). Those links are not ranked results, so they never set `position`.
  - **partial** (required) — type `boolean`. True when a results page could not be read in time, so fewer results than the depth were checked; `checkedResults` says how many were.
- **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.
  - **stale** (optional) — type `boolean`; enum: true. Present, and `true`, only when the source couldn't be reached and this is the last good answer for the same request instead, up to 24 hours old. Absent on every live answer.
  - **fetchedAt** (optional) — type `string`. When a stale answer (`stale: true`) was originally fetched (ISO 8601, UTC). Absent on every live answer.

### Example JSON (found)

```json
{
  "data": {
    "lookupStatus": "found",
    "query": "marathon training plan",
    "domain": "halhigdon.com",
    "market": "en-US",
    "position": 2,
    "result": {
      "position": 2,
      "title": "Marathon Training for All Skill Levels | Hal Higdon",
      "url": "https://www.halhigdon.com/training/marathon-training/",
      "displayUrl": "https://www.halhigdon.com › training › marathon-training",
      "snippet": "Find the best marathon training program for you, from beginner to advanced, based on your goals, pace and time. Learn from Hal …",
      "date": null
    },
    "positions": [
      2
    ],
    "checkedResults": 8,
    "pagesChecked": 1,
    "exhausted": false,
    "featured": false,
    "partial": false
  },
  "meta": {
    "requestId": "req_01example_bing_rank",
    "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 request **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.bing.checkRank({
  query: "marathon training plan",
  domain: "halhigdon.com",
});

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/bing/rank?query=marathon%20training%20plan&domain=halhigdon.com",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

const data = await response.json();
console.log(data);
```

### cURL

```bash
curl "https://api.socialfetch.dev/v1/bing/rank?query=marathon%20training%20plan&domain=halhigdon.com" \
  -H "x-api-key: YOUR_API_KEY"
```

### Python

```python
import requests

response = requests.get(
    "https://api.socialfetch.dev/v1/bing/rank?query=marathon%20training%20plan&domain=halhigdon.com",
    headers={"x-api-key": "YOUR_API_KEY"},
)
data = response.json()
print(data)
```