Skip to main content

Documentation Index

Fetch the complete documentation index at: https://polymarket-data.com/llms.txt

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

client.gamma.search.publicSearch powers discovery in the Polymarket app. Query events, tags, and user profiles with sophisticated filters.

​
Request

const results = await client.gamma.search.publicSearch(params);

​
Parameters

NameTypeRequiredDefaultNotes
qstring✅–Query string.
cacheboolean–Enable cached responses.
events_statusstring–Filter events by status.
limit_per_typenumber (≥ 0)–Result cap per section.
pagenumber (≥ 0)–Pagination control.
events_tagstring[]–Include events with these tag slugs.
keep_closed_marketsnumber (≥ 0)–Retain closed markets.
sortstring–Sorting expression.
ascendingboolean–Sort direction.
search_tagsboolean–Toggle tag section.
search_profilesboolean–Toggle profile section.
recurrencestring–Filter by recurrence (e.g., daily).
exclude_tag_idnumber[]–Tag IDs to exclude.
optimizedboolean–Request optimised payload.

​
Response

type SearchResponse = {
  events: Event[] | null | undefined;
  tags: Tag[] | null | undefined;
  profiles: Profile[] | null | undefined;
  pagination: { hasMore: boolean; totalResults: number };
};
Each section contains rich metadata—titles, imagery, volume stats, chat info, and more. Check for null/undefined before iterating.

​
Usage example

const search = await client.gamma.search.publicSearch({
  q: "election",
  search_tags: true,
  search_profiles: true,
  limit_per_type: 10,
});

console.log(search.events?.map((event) => event.title));

​
Failure modes

  • Missing q → validation error.
  • Negative pagination values → validation error.