Pagination

To ensure Chargetrip API remains performant and responsive, pagination is used to limit the amount of information that can be returned in list queries within a single request.

Supported pagination types

Currently, two types of pagination are used across the API.

• Cursor-based (New): Chargetrip's new pagination standard. All newly developed list queries will implement this pagination type.
• Offset-based (Legacy): Chargetrip's legacy pagination standard, still used in most of the existing list queries. These operations will eventually be deprecated and replaced by cursor-based versions.

Cursor-based pagination

Cursor pagination lets you define the starting point of each request via a unique identifier - cursor - for fetching the next set of results. Furthermore, the response format for this method differs from the legacy offset-based approach.

Arguments

• first (Integer): The number of items to return.
• after (String): The cursor from page_info.end_cursor returned in the previous request. To fetch the first page, omit or set this argument to null.

Limits: first is limited to 100, except for the getRouteStationsWithAmenities query, which is limited to 10 items. If the first argument exceeds these limits, an error is returned.

          // First requestvehicleModels(first: 12) {        total_count        page_info {            has_next_page            has_previous_page            start_cursor            end_cursor        }        nodes {            name        }    }  // Following requestsvehicleModels(first: 12 ,after:"eyJwYWdlIjoyfQ==" ) {        total_count        page_info {            has_next_page            has_previous_page            start_cursor            end_cursor        }        nodes {            name        }    }
        

Output

The cursor-based response format is inspired by Relay's Connection Pattern, providing both the data (nodes) and the metadata (page_info) required for subsequent requests. To provide a better developer experience, the "edges" layer found in the standard Relay pattern is omitted, and data is returned directly through the nodes array.

          //vehicleModels(first: 2 ,after:"eyJwYWdlIjoxfQ==" ){    "data": {        "vehicleModels": {            "total_count": 510,            "page_info": {                "has_next_page": true,                "has_previous_page": false,                "start_cursor": "eyJwYWdlIjoxfQ==",                "end_cursor": "eyJwYWdlIjoyfQ=="            },            "nodes": [                {                    "name": "500e"                },                {                    "name": "600e"                }            ]        }    }}
        

Offset-based pagination (Legacy)

Offset-based pagination uses page as an offset to determine the starting point of data to fetch and a size to limit the number of results returned.

Arguments

• size (Integer): The number of items to receive per page.
• page (Integer): The page number to fetch. To fetch the first page, omit or set this argument to 0.

Limits: The size is limited to 100. If the size argument exceeds these limits, an error is returned.

          vehicleList(size: 2, page: 2) {        id        region        purpose        type    }
        

Output

The response returns directly a list of data results, limited by the size value.

          vehicleList(size: 2, page: 2){    "data": {        "vehicleList": [            {                "id": "6731c0d20e68fb49fcfcfc43",                "region": [                    "EU"                ],                "purpose": "passenger",                "type": "car"            },            {                "id": "6707980511eb0435fbf01724",                "region": [                    "NA",                    "AS"                ],                "purpose": "passenger",                "type": "car"            }        ]    }}