Entities
tier:standard

Search entities

Find a person, company, or knowledge graph entity by free-text query — a name, partial name, nickname, stock ticker, @handle, or website domain. Returns the best matches ranked by relevance, each tagged with a match_quality so you can tell an exact identification from a fuzzy guess. Use it to turn what a user typed into a specific entity — for example before creating an alert to watch it for podcast mentions. Unlike a knowledge graph entity, a result's top-level type may be person, company, or knowledge_graph_entity; pass its id or slug to the matching resource endpoint (/v1/people, /v1/companies, /v1/entities), or its id to alert creation.

get/v1/entities/search

Request

  • Base URL: https://api.particle.pro
  • URL: https://api.particle.pro/v1/entities/search
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Query parameters

limitinteger

Results per page

cursorstring

Opaque pagination cursor from previous response

qstring required

Free-text query: a name, partial name, nickname, stock ticker, @handle, or website domain (e.g. 'sam altman', 'coca cola', 'AAPL', '@sama', 'apple.com').

type'person' | 'company' | 'knowledge_graph_entity'

Restrict results to one kind. Omit to search people, companies, and knowledge graph entities together.

Response

OK

cursorstring

Pass to next request for more results

has_moreboolean required

Whether more results exist

Changes

No recorded changes to this operation across all 2 revisions of this API.