Skip to content

Deprecation warning: offset parameter #187

@jonquandt

Description

@jonquandt

This is a pre-announcement that we are beginning the process to deprecate the offset parameter in the following endpoints:

  • collections
  • published
  • packages (granule list functionality)

As part of our upcoming December 2025 release, we will mark the parameter as deprecated, indicating to users that they should switch to the offsetMark parameter instead.

The API will continue to accept the offset parameter to allow existing users to have time to transition. We will be reaching out to known users based on API key that are currently using offset to understand how long it might take to fully transition.

Important: We do not have an established timeframe for removing the offset parameter functionality at this time. Based on feedback from current users, we will communicate the end date for offset support. The earliest possible time this would occur would be Summer 2026.

This effort will also include updates to our documentation in GitHub as well as on our GovInfo developer hub.

For more information on why we are deprecating this functionality, please see #101.

Metadata

Metadata

Assignees

Labels

FeaturesItems currently under consideration by the govinfo team for development.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions