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

cURL

cURL

curl -H "X-API-Key: $PARTICLE_API_KEY" \
  "https://api.particle.pro/v1/entities/search?limit=25&q=%3Cq%3E"

200

{
  "data": [
    {
      "match_quality": "exact",
      "mentions": {
        "news_articles": 123,
        "podcast_episodes": 123
      },
      "type": "person",
      "company": {
        "id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "domain": "<string>",
        "image_mode": "AUTOMATIC",
        "image_url": "<string>",
        "slug": "<string>",
        "ticker": "<string>"
      },
      "knowledge_graph_entity": {
        "id": "<string>",
        "name": "<string>",
        "slug": "<string>",
        "company": {
          "id": "<string>",
          "domain": "<string>",
          "ticker": "<string>"
        },
        "description": "<string>",
        "image_url": "<string>",
        "person": {
          "id": "<string>",
          "company": "<string>",
          "image_url": "<string>",
          "title": "<string>"
        },
        "type": {
          "name": "<string>",
          "slug": "<string>"
        },
        "wikipedia_url": "<string>"
      },
      "person": {
        "id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "image_url": "<string>",
        "slug": "<string>"
      },
      "social_links": [
        {
          "platform": "<string>",
          "url": "<string>",
          "followers": 123
        }
      ]
    }
  ],
  "has_more": true,
  "cursor": "<string>"
}

Authorizations

ApiKeyHeaderBearerAuth

X-API-Key · string · header · required

Pass your API key in the X-API-Key header (recommended).

Query Parameters

limit · integer<int64> · default: 25

Results per page

Required range: 1 <= x <= 100

cursor · string

Opaque pagination cursor from previous response

q · string · 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').

Minimum string length: 1

type · enum<string>

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

Available options: person, company, knowledge_graph_entity

Response

200

application/json

OK

data · object[] | null · required

List of results

Show child attributes

has_more · boolean · required

Whether more results exist

cursor · string

Pass to next request for more results