diff --git a/.changeset/dev-169-listevents-open-default.md b/.changeset/dev-169-listevents-open-default.md new file mode 100644 index 0000000..d6df4e8 --- /dev/null +++ b/.changeset/dev-169-listevents-open-default.md @@ -0,0 +1,5 @@ +--- +"@polymarket/client": patch +--- + +Default `listEvents` to open events when `closed` is omitted. diff --git a/packages/client/src/actions/events.ts b/packages/client/src/actions/events.ts index c406642..7b1b04d 100644 --- a/packages/client/src/actions/events.ts +++ b/packages/client/src/actions/events.ts @@ -33,7 +33,7 @@ import { snakeCase, toDataSearchParams, toSearchParams } from './params'; const ListEventsRequestSchema = z.object({ ascending: z.boolean().optional(), - closed: z.boolean().optional(), + closed: z.boolean().default(false), cursor: PaginationCursorSchema.optional(), pageSize: PageSizeSchema.optional(), cyom: z.boolean().optional(), @@ -135,6 +135,8 @@ export const ListEventsError = makeErrorGuard( /** * Lists events. * + * Defaults to open events. Pass `closed: true` to list settled events. + * * @remarks * This is a low-level function. Most SDK consumers should prefer the client instance API. * diff --git a/packages/client/src/decorators/discovery.ts b/packages/client/src/decorators/discovery.ts index c737c37..0dac117 100644 --- a/packages/client/src/decorators/discovery.ts +++ b/packages/client/src/decorators/discovery.ts @@ -63,6 +63,8 @@ export type DiscoveryActions = { /** * Lists events. * + * Defaults to open events. Pass `closed: true` to list settled events. + * * @throws {@link ListEventsError} * Thrown on failure. *