Pagination

Springstreet supports pagination API requests to retrieve larger lists of information.

To ensure fast and reliable performance, the Springstreet API uses pagination to handle large sets of results. Instead of returning thousands of records in a single response, the API delivers data in "pages."

Pagination is controlled by a simple page query parameter included in the URL of your GET request.

Controlling Pagination

To request a specific page of results, include the page parameter in the URL's query string.

Parameter	Type	Required	Description
page	integer	No	The page number you wish to retrieve. If omitted, the API will default to page 1.

Reading the Response

Every successful paginated response will contain a pagination object. This object provides all the information you need to navigate through the full set of results.

Field	Type	Description
current_page	integer	The page number of the results in the current response.
total_pages	integer	The total number of pages available for your query.
page_size	integer	The number of items returned per page. This is fixed at 5.

Example Response for Page 1

After making a request, the response indicates you are on page 1 and there are a total of 120 pages available.

JSON

{
    "ucc_liens": [
        // ... 5 lien results for page 1
    ],
    "pagination": {
        "current_page": 1,
        "total_pages": 120,
        "page_size": 5
    },
    "response_metadata": {
        "timestamp": "2025-09-02T23:01:45.123Z",
        "request_id": "b4a3c2d1-e5f6-7890-1234-abcdef123456"
    }
}

Example Request for Specific Page (i.e Page 2)

To get the second page of results, you would set the page parameter to 2.

Bash

curl --location 'https://api.springstreet.io/filings/recent-by-state?state=TX&page=2' \
--header 'x-api-key: YOUR_API_KEY'

How to Loop Through All Pages

Your application should continue making requests and incrementing the page parameter until the current_page equals the total_pages.

1. Make your initial request (e.g., ...&page=1).

2. Process the results from the response.

3. Check the pagination object.

4. If current_page < total_pages, make a new request with page incremented by one (e.g., ...&page=2).

5. Repeat this process until you have retrieved the final page.