Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.particle.pro/llms.txt

Use this file to discover all available pages before exploring further.

Resolve a company by free-text name, ticker, SEC CIK, Wikidata QID, or domain. Returns candidates with the agent-facing identifier (slug, falling back to domain or id) you can pass to other company-aware tools. At least one identifier is required. Multiple are ANDed together — useful for disambiguating (e.g. ticker plus a name hint). For people or other knowledge-graph entities (not companies) use entities/resolve_entity instead.

​
Inputs

At least one of query, ticker, domain, cik, or qid is required.
FieldTypeRequiredDefaultDescription
querystringone of—Free-text company name (case-insensitive). Use for human-typed names.
tickerstringone of—Stock ticker symbol (e.g. "NVDA", "AAPL"). Comma-separated for multi-ticker lookup.
domainstringone of—Company website domain (e.g. "apple.com"). Comma-separated for bulk.
cikstringone of—SEC Central Index Key (e.g. "0000320193"). Comma-separated for bulk.
qidstringone of—Wikidata QID (e.g. "Q312"). Comma-separated for bulk.
limitinteger (1–25)no5Maximum candidates to return.

​
Output

A markdown document with ## Company matches (N) and one ### Name section per result. Each section carries bullet-style **Slug:**, **ID:**, **Description:**, **Ticker:**, **Domain:**, **CIK:**, **QID:** lines — only those that have values appear. The **Slug:** line is omitted only when the slug equals the domain or the ID (to avoid duplication). Sample (ticker="NVDA"): 
## Company matches (1)

### Nvidia

**Slug:** nvidia
**ID:** 3CensCwu5G2oKCFgPrNf89
**Description:** Nvidia is a leading developer of graphics processing units. …
**Ticker:** NVDA
**Domain:** nvidia.com
**CIK:** 0001045810
**QID:** Q182477
The string after **Slug:** (or **Domain:** if no slug line is present, or **ID:** as a final fallback) is what you pass to other tools as company_slug — every tool that takes company_slug accepts knowledge-graph slug, domain, or encoded ID interchangeably.

​
Example

Agent calls: companies/resolve_company { "ticker": "NVDA" }
            → reads "Slug:" line → "nvidia"

Agent calls: advertising/get_company_ad_presence { "company_slug": "nvidia" }