Docs menu

Fig tools

Research first. Each lookup is something your agent can call. Balance and Checkout sit under Credits — they keep prepaid usage going, they are not the product.

Give this to your agent

Set up Fig - https://figaeo.com/llms.txt

Examples are illustrative sample outputs for a fictional product, not live rankings or mentions of a real brand.

Research tools

Get current SERP

Observed current Google organic results and SERP features for one keyword. Not historical rank tracking. Fig does not persist snapshots.

Parameters

country?

string

ISO 3166-1 alpha-2 country. Omit only when the market is the United States default.

language?

stringDefault en

ISO 639 language, such as en or es.

device?

desktop | mobileDefault desktop

Device used for the lookup.

city?

string

City name. Ambiguous cities must be disambiguated.

region?

string

State, province, or region name.

format?

compact | detailedDefault compact

compact returns decision fields only. detailed returns full provider detail.

max_usd?

number

Refuse without calling the provider when the estimate exceeds this USD cap.

idempotency_key?

string

Optional idempotency key for retries.

keyword

string

The keyword to inspect on the live SERP.

search_engine?

googleDefault google

Search engine. Google Organic is the supported engine.

depth?

integerDefault 10

How many organic ranks to fetch. One page is 10. Max 100. Deeper requests cost more.

limit?

integerDefault 10

How many results to return after the fetch. Default 10. Max 50.

Response body

ok

false

error

object

category

message

string

required_usd?

number

checkout_url?

string

estimated_usd?

number

max_usd?

number

remaining_usd?

number

remaining_similar_calls?

number

candidates?

array<object>

label

string

country

string

region?

string

city?

string

retry_after_seconds?

number

Example

{
  "ok": false,
  "error": {
    "category": "insufficient_credits",
    "message": "This request needs $0.01. Remaining prepaid subtotal is $0. Call create_checkout, wait for the User to finish Checkout, then retry.",
    "required_usd": 0.01,
    "remaining_usd": 0
  }
}

Example

Input

{
  "keyword": "hosted MCP server",
  "country": "US"
}

Output

{
  "ok": true,
  "tool": "get_serp",
  "request": {
    "scope": {
      "country": "US",
      "language": "en",
      "device": "desktop",
      "format": "compact"
    }
  },
  "freshness": {
    "observed_at": "2026-09-02T21:00:00.000Z",
    "provider_timestamp": "2026-09-01T00:00:00.000Z"
  },
  "usage": {
    "charged_usd": 0.01,
    "remaining_usd": 19.73,
    "remaining_similar_calls": 1973,
    "pricing_version": "2026-09-02"
  },
  "data": {
    "keyword": "hosted MCP server",
    "search_engine": "google",
    "observation": "current_serp",
    "historical_tracking": false,
    "items": [
      {
        "position": 3,
        "type": "organic",
        "url": "https://acmeauth.dev/docs",
        "title": "Hosted MCP server guide",
        "domain": "acmeauth.dev",
        "description": "How to ship a hosted MCP server with OAuth."
      },
      {
        "position": 4,
        "type": "organic",
        "url": "https://handbook.dev/mcp",
        "title": "MCP handbook",
        "domain": "handbook.dev"
      }
    ],
    "serp_features": [
      "people_also_ask",
      "discussions"
    ]
  }
}

Suggest keywords

Related ideas, questions, and expansions from seed keywords. Score a short list with get_keyword_metrics after this.

Parameters

country?

string

ISO 3166-1 alpha-2 country. Omit only when the market is the United States default.

language?

stringDefault en

ISO 639 language, such as en or es.

device?

desktop | mobileDefault desktop

Device used for the lookup.

city?

string

City name. Ambiguous cities must be disambiguated.

region?

string

State, province, or region name.

format?

compact | detailedDefault compact

compact returns decision fields only. detailed returns full provider detail.

max_usd?

number

Refuse without calling the provider when the estimate exceeds this USD cap.

idempotency_key?

string

Optional idempotency key for retries.

limit?

integerDefault 20

How many results to return. Default 20. Max 50.

cursor?

string

Opaque pagination cursor from a previous response.

keywords

array<string>

Seed keywords used to discover related ideas. At most 5 seeds.

Response body

ok

false

error

object

category

message

string

required_usd?

number

checkout_url?

string

estimated_usd?

number

max_usd?

number

remaining_usd?

number

remaining_similar_calls?

number

candidates?

array<object>

label

string

country

string

region?

string

city?

string

retry_after_seconds?

number

Example

{
  "ok": false,
  "error": {
    "category": "insufficient_credits",
    "message": "This request needs $0.04. Remaining prepaid subtotal is $0. Call create_checkout, wait for the User to finish Checkout, then retry.",
    "required_usd": 0.04,
    "remaining_usd": 0
  }
}

Example

Input

{
  "keywords": [
    "hosted MCP server"
  ],
  "country": "US"
}

Output

{
  "ok": true,
  "tool": "suggest_keywords",
  "request": {
    "scope": {
      "country": "US",
      "language": "en",
      "device": "desktop",
      "format": "compact"
    }
  },
  "freshness": {
    "observed_at": "2026-09-02T21:00:00.000Z",
    "provider_timestamp": "2026-09-01T00:00:00.000Z"
  },
  "usage": {
    "charged_usd": 0.04,
    "remaining_usd": 19.92,
    "remaining_similar_calls": 498,
    "pricing_version": "2026-09-02"
  },
  "data": [
    {
      "keyword": "next.js authentication",
      "search_volume": 5400,
      "cpc_usd": 6.2,
      "competition": 0.54,
      "intent": "commercial"
    },
    {
      "keyword": "best authentication for Next.js",
      "search_volume": 2100,
      "cpc_usd": 7.1,
      "competition": 0.61,
      "intent": "commercial"
    }
  ]
}

Get keyword metrics

Search volume, CPC, competition, and intent for keywords you already have. Null metrics mean Google Ads had no coverage for that keyword, not a failed tool. Use suggest_keywords when you only have a seed.

Parameters

country?

string

ISO 3166-1 alpha-2 country. Omit only when the market is the United States default.

language?

stringDefault en

ISO 639 language, such as en or es.

device?

desktop | mobileDefault desktop

Device used for the lookup.

city?

string

City name. Ambiguous cities must be disambiguated.

region?

string

State, province, or region name.

format?

compact | detailedDefault compact

compact returns decision fields only. detailed returns full provider detail.

max_usd?

number

Refuse without calling the provider when the estimate exceeds this USD cap.

idempotency_key?

string

Optional idempotency key for retries.

limit?

integerDefault 20

How many results to return. Default 20. Max 50.

cursor?

string

Opaque pagination cursor from a previous response.

keywords

array<string>

Known keywords to score. At most 20 per call, 80 characters each.

Response body

ok

false

error

object

category

message

string

required_usd?

number

checkout_url?

string

estimated_usd?

number

max_usd?

number

remaining_usd?

number

remaining_similar_calls?

number

candidates?

array<object>

label

string

country

string

region?

string

city?

string

retry_after_seconds?

number

Example

{
  "ok": false,
  "error": {
    "category": "insufficient_credits",
    "message": "This request needs $0.18. Remaining prepaid subtotal is $0. Call create_checkout, wait for the User to finish Checkout, then retry.",
    "required_usd": 0.18,
    "remaining_usd": 0
  }
}

Example

Input

{
  "keywords": [
    "hosted MCP server",
    "best authentication for Next.js"
  ],
  "country": "US"
}

Output

{
  "ok": true,
  "tool": "get_keyword_metrics",
  "request": {
    "scope": {
      "country": "US",
      "language": "en",
      "device": "desktop",
      "format": "compact"
    }
  },
  "freshness": {
    "observed_at": "2026-09-02T21:00:00.000Z",
    "provider_timestamp": "2026-09-01T00:00:00.000Z"
  },
  "usage": {
    "charged_usd": 0.18,
    "remaining_usd": 19.74,
    "remaining_similar_calls": 109,
    "pricing_version": "2026-09-02"
  },
  "data": [
    {
      "keyword": "hosted MCP server",
      "search_volume": 720,
      "cpc_usd": 4.8,
      "competition": 0.41,
      "intent": "informational"
    },
    {
      "keyword": "best authentication for Next.js",
      "search_volume": 2100,
      "cpc_usd": 7.1,
      "competition": 0.61,
      "intent": "commercial"
    }
  ]
}

Research domain keywords

Keywords and URLs a domain ranks for in a market. Use this first on a product site such as acmeauth.dev, then follow with suggest_keywords on the strongest terms.

Parameters

country?

string

ISO 3166-1 alpha-2 country. Omit only when the market is the United States default.

language?

stringDefault en

ISO 639 language, such as en or es.

device?

desktop | mobileDefault desktop

Device used for the lookup.

city?

string

City name. Ambiguous cities must be disambiguated.

region?

string

State, province, or region name.

format?

compact | detailedDefault compact

compact returns decision fields only. detailed returns full provider detail.

max_usd?

number

Refuse without calling the provider when the estimate exceeds this USD cap.

idempotency_key?

string

Optional idempotency key for retries.

limit?

integerDefault 20

How many results to return. Default 20. Max 50.

cursor?

string

Opaque pagination cursor from a previous response.

domain

string

Domain or URL such as example.com or https://example.com/blog.

Response body

ok

false

error

object

category

message

string

required_usd?

number

checkout_url?

string

estimated_usd?

number

max_usd?

number

remaining_usd?

number

remaining_similar_calls?

number

candidates?

array<object>

label

string

country

string

region?

string

city?

string

retry_after_seconds?

number

Example

{
  "ok": false,
  "error": {
    "category": "insufficient_credits",
    "message": "This request needs $0.04. Remaining prepaid subtotal is $0. Call create_checkout, wait for the User to finish Checkout, then retry.",
    "required_usd": 0.04,
    "remaining_usd": 0
  }
}

Example

Input

{
  "domain": "acmeauth.dev",
  "country": "US"
}

Output

{
  "ok": true,
  "tool": "research_domain",
  "request": {
    "scope": {
      "country": "US",
      "language": "en",
      "device": "desktop",
      "format": "compact"
    }
  },
  "freshness": {
    "observed_at": "2026-09-02T21:00:00.000Z",
    "provider_timestamp": "2026-09-01T00:00:00.000Z"
  },
  "usage": {
    "charged_usd": 0.04,
    "remaining_usd": 19.96,
    "remaining_similar_calls": 499,
    "pricing_version": "2026-09-02"
  },
  "data": [
    {
      "keyword": "hosted MCP server",
      "position": 3,
      "search_volume": 720,
      "url": "https://acmeauth.dev/docs"
    },
    {
      "keyword": "best authentication for Next.js",
      "position": 8,
      "search_volume": 2100,
      "url": "https://acmeauth.dev/blog/nextjs-auth"
    },
    {
      "keyword": "next.js authentication",
      "position": 12,
      "search_volume": 5400,
      "url": "https://acmeauth.dev/"
    }
  ]
}

Compare SERP competitors

Domains competing for a keyword set, with explicit result bounds. Use get_serp to inspect one keyword's live results.

Parameters

country?

string

ISO 3166-1 alpha-2 country. Omit only when the market is the United States default.

language?

stringDefault en

ISO 639 language, such as en or es.

city?

string

City name. Ambiguous cities must be disambiguated.

region?

string

State, province, or region name.

format?

compact | detailedDefault compact

compact returns decision fields only. detailed returns full provider detail.

max_usd?

number

Refuse without calling the provider when the estimate exceeds this USD cap.

idempotency_key?

string

Optional idempotency key for retries.

limit?

integerDefault 20

How many results to return. Default 20. Max 50.

cursor?

string

Opaque pagination cursor from a previous response.

keywords

array<string>

Keywords used to find competing domains. At most 20 per call.

Response body

ok

false

error

object

category

message

string

required_usd?

number

checkout_url?

string

estimated_usd?

number

max_usd?

number

remaining_usd?

number

remaining_similar_calls?

number

candidates?

array<object>

label

string

country

string

region?

string

city?

string

retry_after_seconds?

number

Example

{
  "ok": false,
  "error": {
    "category": "insufficient_credits",
    "message": "This request needs $0.04. Remaining prepaid subtotal is $0. Call create_checkout, wait for the User to finish Checkout, then retry.",
    "required_usd": 0.04,
    "remaining_usd": 0
  }
}

Example

Input

{
  "keywords": [
    "hosted MCP server"
  ],
  "country": "US"
}

Output

{
  "ok": true,
  "tool": "compare_serp_competitors",
  "request": {
    "scope": {
      "country": "US",
      "language": "en",
      "device": "desktop",
      "format": "compact"
    }
  },
  "freshness": {
    "observed_at": "2026-09-02T21:00:00.000Z",
    "provider_timestamp": "2026-09-01T00:00:00.000Z"
  },
  "usage": {
    "charged_usd": 0.04,
    "remaining_usd": 19.69,
    "remaining_similar_calls": 492,
    "pricing_version": "2026-09-02"
  },
  "data": {
    "observation": "estimated_serp_competitors",
    "historical_tracking": false,
    "items": [
      {
        "domain": "acmeauth.dev",
        "avg_position": 3.4,
        "keywords_count": 1,
        "visibility": 0.82
      },
      {
        "domain": "rivalauth.dev",
        "avg_position": 5.1,
        "keywords_count": 1,
        "visibility": 0.61
      }
    ]
  }
}

Research AI-search visibility

Mentions, visibility, and citations in AI answers. google and chat_gpt are supported. competitors is chat_gpt only. Not live generated answers.

Parameters

country?

string

ISO 3166-1 alpha-2 country. Omit only when the market is the United States default.

language?

stringDefault en

ISO 639 language, such as en or es.

city?

string

City name. Ambiguous cities must be disambiguated.

region?

string

State, province, or region name.

format?

compact | detailedDefault compact

compact returns decision fields only. detailed returns full provider detail.

max_usd?

number

Refuse without calling the provider when the estimate exceeds this USD cap.

idempotency_key?

string

Optional idempotency key for retries.

limit?

integerDefault 20

How many results to return. Default 20. Max 50.

cursor?

string

Opaque pagination cursor from a previous response.

query?

string

Brand, keyword, or prompt scope. Required unless domain is set.

domain?

string

Domain or URL to measure in AI answers. Required unless query is set.

platform?

google | chat_gpt | claude | gemini | perplexityDefault google

AI platform. google (AI Overview) and chat_gpt are supported. claude, gemini, and perplexity return a stable unsupported error rather than invented results.

operation?

Provider operation. mentions, visibility, and citations are supported on google and chat_gpt. competitors is ChatGPT-only brand comparisons. historical and live_response return a stable unsupported error rather than invented results.

Response body

ok

false

error

object

category

message

string

required_usd?

number

checkout_url?

string

estimated_usd?

number

max_usd?

number

remaining_usd?

number

remaining_similar_calls?

number

candidates?

array<object>

label

string

country

string

region?

string

city?

string

retry_after_seconds?

number

Example

{
  "ok": false,
  "error": {
    "category": "insufficient_credits",
    "message": "This request needs $0.25. Remaining prepaid subtotal is $0. Call create_checkout, wait for the User to finish Checkout, then retry.",
    "required_usd": 0.25,
    "remaining_usd": 0
  }
}

Example

Input

{
  "query": "AI SEO tools",
  "domain": "acmeauth.dev",
  "country": "US",
  "operation": "citations"
}

Output

{
  "ok": true,
  "tool": "research_ai_visibility",
  "request": {
    "scope": {
      "country": "US",
      "language": "en",
      "device": "desktop",
      "format": "compact"
    }
  },
  "freshness": {
    "observed_at": "2026-09-02T21:00:00.000Z",
    "provider_timestamp": "2026-09-01T00:00:00.000Z"
  },
  "usage": {
    "charged_usd": 0.25,
    "remaining_usd": 19.34,
    "remaining_similar_calls": 77,
    "pricing_version": "2026-09-02"
  },
  "data": {
    "operation": "citations",
    "observation": "llm_mentions",
    "historical_tracking": false,
    "query": "AI SEO tools",
    "domain": "acmeauth.dev",
    "platform": "google",
    "limitations": [
      "Observed LLM mentions, not a live generated answer and not Fig historical tracking."
    ],
    "mentions": 4,
    "items": [
      {
        "domain": "handbook.dev",
        "title": "AI SEO tools roundup",
        "mentions": 3
      },
      {
        "domain": "stacknotes.dev",
        "title": "Visibility checklist",
        "mentions": 1
      }
    ]
  }
}

Get backlink overview

Referring-domain and link-strength summary for a domain. Use get_backlinks for source and target URLs.

Parameters

format?

compact | detailedDefault compact

compact returns decision fields only. detailed returns full provider detail.

max_usd?

number

Refuse without calling the provider when the estimate exceeds this USD cap.

idempotency_key?

string

Optional idempotency key for retries.

domain

string

Domain or URL such as example.com or https://example.com/blog.

Response body

ok

false

error

object

category

message

string

required_usd?

number

checkout_url?

string

estimated_usd?

number

max_usd?

number

remaining_usd?

number

remaining_similar_calls?

number

candidates?

array<object>

label

string

country

string

region?

string

city?

string

retry_after_seconds?

number

Example

{
  "ok": false,
  "error": {
    "category": "insufficient_credits",
    "message": "This request needs $0.05. Remaining prepaid subtotal is $0. Call create_checkout, wait for the User to finish Checkout, then retry.",
    "required_usd": 0.05,
    "remaining_usd": 0
  }
}

Example

Input

{
  "domain": "rivalauth.dev"
}

Output

{
  "ok": true,
  "tool": "get_backlink_overview",
  "request": {
    "scope": {
      "format": "compact"
    }
  },
  "freshness": {
    "observed_at": "2026-09-02T21:00:00.000Z",
    "provider_timestamp": "2026-09-01T00:00:00.000Z"
  },
  "usage": {
    "charged_usd": 0.05,
    "remaining_usd": 19.64,
    "remaining_similar_calls": 392,
    "pricing_version": "2026-09-02"
  },
  "data": {
    "domain": "rivalauth.dev",
    "referring_domains": 84,
    "backlinks": 310,
    "rank": 42
  }
}

Get backlink profile

Bounded list of backlinks with source and target URLs, anchors, attributes, and dates. Not for outreach or contact discovery.

Parameters

format?

compact | detailedDefault compact

compact returns decision fields only. detailed returns full provider detail.

max_usd?

number

Refuse without calling the provider when the estimate exceeds this USD cap.

idempotency_key?

string

Optional idempotency key for retries.

limit?

integerDefault 20

How many results to return. Default 20. Max 50.

cursor?

string

Opaque pagination cursor from a previous response.

domain

string

Domain or URL such as example.com or https://example.com/blog.

Response body

ok

false

error

object

category

message

string

required_usd?

number

checkout_url?

string

estimated_usd?

number

max_usd?

number

remaining_usd?

number

remaining_similar_calls?

number

candidates?

array<object>

label

string

country

string

region?

string

city?

string

retry_after_seconds?

number

Example

{
  "ok": false,
  "error": {
    "category": "insufficient_credits",
    "message": "This request needs $0.05. Remaining prepaid subtotal is $0. Call create_checkout, wait for the User to finish Checkout, then retry.",
    "required_usd": 0.05,
    "remaining_usd": 0
  }
}

Example

Input

{
  "domain": "rivalauth.dev",
  "limit": 20
}

Output

{
  "ok": true,
  "tool": "get_backlinks",
  "request": {
    "scope": {
      "format": "compact",
      "limit": 20
    }
  },
  "freshness": {
    "observed_at": "2026-09-02T21:00:00.000Z",
    "provider_timestamp": "2026-09-01T00:00:00.000Z"
  },
  "usage": {
    "charged_usd": 0.05,
    "remaining_usd": 19.59,
    "remaining_similar_calls": 391,
    "pricing_version": "2026-09-02"
  },
  "data": [
    {
      "source_url": "https://handbook.dev/auth-stack",
      "target_url": "https://rivalauth.dev/docs",
      "anchor": "authentication library",
      "dofollow": true
    },
    {
      "source_url": "https://stacknotes.dev/mcp",
      "target_url": "https://rivalauth.dev/",
      "anchor": "hosted MCP",
      "dofollow": true
    }
  ]
}

Get local Maps SERP

Current Google Maps results for an explicit city and query. City is required. Use get_serp for organic web results.

Parameters

country?

string

ISO 3166-1 alpha-2 country. Omit only when the market is the United States default.

language?

stringDefault en

ISO 639 language, such as en or es.

device?

desktop | mobileDefault desktop

Device used for the lookup.

region?

string

State, province, or region name.

format?

compact | detailedDefault compact

compact returns decision fields only. detailed returns full provider detail.

max_usd?

number

Refuse without calling the provider when the estimate exceeds this USD cap.

idempotency_key?

string

Optional idempotency key for retries.

limit?

integerDefault 20

How many results to return after the fetch. Default 20. Max 50.

cursor?

string

Opaque pagination cursor from a previous response.

query

string

Local search query, such as identity platform or developer tools.

category?

string

Optional business category scope.

city

string

City name. Required. Ambiguous cities must be disambiguated with resolve_location.

depth?

integerDefault 100

How many Maps ranks to fetch. One page is 100. Default 100. Max 100.

Response body

ok

false

error

object

category

message

string

required_usd?

number

checkout_url?

string

estimated_usd?

number

max_usd?

number

remaining_usd?

number

remaining_similar_calls?

number

candidates?

array<object>

label

string

country

string

region?

string

city?

string

retry_after_seconds?

number

Example

{
  "ok": false,
  "error": {
    "category": "insufficient_credits",
    "message": "This request needs $0.01. Remaining prepaid subtotal is $0. Call create_checkout, wait for the User to finish Checkout, then retry.",
    "required_usd": 0.01,
    "remaining_usd": 0
  }
}

Example

Input

{
  "query": "identity platform",
  "city": "San Francisco",
  "region": "California",
  "country": "US"
}

Output

{
  "ok": true,
  "tool": "get_local_serp",
  "request": {
    "scope": {
      "country": "US",
      "language": "en",
      "device": "desktop",
      "format": "compact"
    }
  },
  "freshness": {
    "observed_at": "2026-09-02T21:00:00.000Z",
    "provider_timestamp": "2026-09-01T00:00:00.000Z"
  },
  "usage": {
    "charged_usd": 0.01,
    "remaining_usd": 19.33,
    "remaining_similar_calls": 1933,
    "pricing_version": "2026-09-02"
  },
  "data": {
    "query": "identity platform",
    "observation": "current_local_serp",
    "historical_tracking": false,
    "items": [
      {
        "position": 1,
        "title": "Acme Auth",
        "domain": "acmeauth.dev",
        "rating": 4.7,
        "reviews_count": 38
      },
      {
        "position": 2,
        "title": "Rival Auth",
        "domain": "rivalauth.dev",
        "rating": 4.4,
        "reviews_count": 21
      }
    ]
  }
}

Research local businesses

Maps and business listings for an explicit city plus a query or category. listings is supported. Other operations return a stable unsupported error.

Parameters

country?

string

ISO 3166-1 alpha-2 country. Omit only when the market is the United States default.

language?

stringDefault en

ISO 639 language, such as en or es.

device?

desktop | mobileDefault desktop

Device used for the lookup.

region?

string

State, province, or region name.

format?

compact | detailedDefault compact

compact returns decision fields only. detailed returns full provider detail.

max_usd?

number

Refuse without calling the provider when the estimate exceeds this USD cap.

idempotency_key?

string

Optional idempotency key for retries.

limit?

integerDefault 20

How many results to return. Default 20. Max 50.

cursor?

string

Opaque pagination cursor from a previous response.

query?

string

Business name or query. Required unless category is set.

category?

string

Business category. Required unless query is set.

city

string

City name. Required. Ambiguous cities must be disambiguated with resolve_location.

operation?

listings | reviews | questions | updates | categoriesDefault listings

Provider operation. listings is supported. reviews, questions, updates, and categories return a stable unsupported error rather than invented results.

Response body

ok

false

error

object

category

message

string

required_usd?

number

checkout_url?

string

estimated_usd?

number

max_usd?

number

remaining_usd?

number

remaining_similar_calls?

number

candidates?

array<object>

label

string

country

string

region?

string

city?

string

retry_after_seconds?

number

Example

{
  "ok": false,
  "error": {
    "category": "insufficient_credits",
    "message": "This request needs $0.04. Remaining prepaid subtotal is $0. Call create_checkout, wait for the User to finish Checkout, then retry.",
    "required_usd": 0.04,
    "remaining_usd": 0
  }
}

Example

Input

{
  "query": "identity platform",
  "city": "London",
  "country": "GB",
  "operation": "listings"
}

Output

{
  "ok": true,
  "tool": "research_local_business",
  "request": {
    "scope": {
      "country": "US",
      "language": "en",
      "device": "desktop",
      "format": "compact"
    }
  },
  "freshness": {
    "observed_at": "2026-09-02T21:00:00.000Z",
    "provider_timestamp": "2026-09-01T00:00:00.000Z"
  },
  "usage": {
    "charged_usd": 0.04,
    "remaining_usd": 19.29,
    "remaining_similar_calls": 482,
    "pricing_version": "2026-09-02"
  },
  "data": {
    "operation": "listings",
    "query": "identity platform",
    "items": [
      {
        "title": "Acme Auth London",
        "domain": "acmeauth.dev",
        "rating": 4.6,
        "reviews_count": 12
      }
    ]
  }
}

Resolve location

Candidate markets for an ambiguous city or region name. Fig never silently picks a city. Pass the chosen country, region, and city into the paid tool. Free.

Parameters

query

string

City, region, or market name to resolve.

country?

string

Optional ISO 3166-1 alpha-2 filter.

idempotency_key?

string

Optional idempotency key for retries.

Response body

ok

false

error

object

category

message

string

required_usd?

number

checkout_url?

string

estimated_usd?

number

max_usd?

number

remaining_usd?

number

remaining_similar_calls?

number

candidates?

array<object>

label

string

country

string

region?

string

city?

string

retry_after_seconds?

number

Example

{
  "ok": false,
  "error": {
    "category": "validation",
    "message": "City is ambiguous. Call resolve_location and pass country, region, and city into the paid tool.",
    "candidates": [
      {
        "label": "London, England, United Kingdom",
        "country": "GB",
        "region": "England",
        "city": "London"
      },
      {
        "label": "London, Ontario, Canada",
        "country": "CA",
        "region": "Ontario",
        "city": "London"
      }
    ]
  }
}

Example

Input

{
  "query": "London"
}

Output

{
  "ok": true,
  "tool": "resolve_location",
  "request": {
    "scope": {
      "query": "London"
    }
  },
  "freshness": {
    "observed_at": "2026-09-02T21:00:00.000Z",
    "provider_timestamp": "2026-09-01T00:00:00.000Z"
  },
  "usage": {
    "remaining_usd": 19.29,
    "pricing_version": "2026-09-02"
  },
  "data": {
    "candidates": [
      {
        "label": "London, England, United Kingdom",
        "country": "GB",
        "region": "England",
        "city": "London"
      },
      {
        "label": "London, Ontario, Canada",
        "country": "CA",
        "region": "Ontario",
        "city": "London"
      }
    ]
  }
}

Billing / Credits

These keep prepaid usage going. They are not keyword, SERP, or visibility research.

Check credit balance

Remaining prepaid USD before a research pass. Free. Shared across agents on the same verified email.

Parameters

idempotency_key?

string

Optional idempotency key for retries.

Response body

ok

false

error

object

category

message

string

required_usd?

number

checkout_url?

string

estimated_usd?

number

max_usd?

number

remaining_usd?

number

remaining_similar_calls?

number

candidates?

array<object>

label

string

country

string

region?

string

city?

string

retry_after_seconds?

number

Example

{
  "ok": false,
  "error": {
    "category": "authentication",
    "message": "Sign in with GitHub or Google to read the shared balance."
  }
}

Example

Input

{}

Output

{
  "ok": true,
  "tool": "balance",
  "usage": {
    "remaining_usd": 19.29,
    "pricing_version": "2026-09-02"
  },
  "data": {
    "remaining_usd": 19.29
  }
}

Create credit checkout

Start prepaid Checkout. Default $20, minimum $10. Humans approve payment on figaeo.com/pay. Not a research tool.

Parameters

amount_usd?

numberDefault 20

Credit subtotal in USD before tax. Omit to buy $20. Minimum $10.

idempotency_key?

string

Optional idempotency key for retries.

Response body

ok

false

error

object

category

message

string

required_usd?

number

checkout_url?

string

estimated_usd?

number

max_usd?

number

remaining_usd?

number

remaining_similar_calls?

number

candidates?

array<object>

label

string

country

string

region?

string

city?

string

retry_after_seconds?

number

Example

{
  "ok": false,
  "error": {
    "category": "validation",
    "message": "amount_usd must be at least 10."
  }
}

Example

Input

{
  "amount_usd": 20
}

Output

{
  "ok": true,
  "tool": "create_checkout",
  "data": {
    "pay_url": "https://figaeo.com/pay/example",
    "amount_usd": 20
  }
}

Research tools

get_serp

Get current SERP

Parameters

Response body

200application/json

4XXapplication/json

suggest_keywords

Suggest keywords

Parameters

Response body

200application/json

4XXapplication/json

get_keyword_metrics

Get keyword metrics

Parameters

Response body

200application/json

4XXapplication/json

research_domain

Research domain keywords

Parameters

Response body

200application/json

4XXapplication/json

compare_serp_competitors

Compare SERP competitors

Parameters

Response body

200application/json

4XXapplication/json

research_ai_visibility

Research AI-search visibility

Parameters

Response body

200application/json

4XXapplication/json

get_backlink_overview

Get backlink overview

Parameters

Response body

200application/json

4XXapplication/json

get_backlinks

Get backlink profile

Parameters

Response body

200application/json

4XXapplication/json

get_local_serp

Get local Maps SERP

Parameters

Response body

200application/json

4XXapplication/json

research_local_business

Research local businesses

Parameters

Response body

200application/json

4XXapplication/json

resolve_location

Resolve location

Parameters

Response body

200application/json

4XXapplication/json

Billing / Credits

balance

Check credit balance

Parameters

Response body

200application/json

4XXapplication/json

create_checkout

Create credit checkout

Parameters

Response body

200application/json

4XXapplication/json