Skip to main content

​
Parameters

All list endpoints support offset-based pagination:
ParameterTypeDefaultRangeDescription
limitinteger201–100Number of results per page
offsetinteger00+Number of results to skip

​
Usage

# First page (20 results)
curl "https://worker.rushed.com.br/api/articles?limit=20&offset=0" \
  -H "X-API-Key: rsh_live_xxx"

# Second page
curl "https://worker.rushed.com.br/api/articles?limit=20&offset=20" \
  -H "X-API-Key: rsh_live_xxx"

​
Response format

Paginated endpoints include a pagination object: 
{
  "success": true,
  "data": [ ... ],
  "pagination": {
    "limit": 20,
    "offset": 0,
    "total": 1847,
    "hasMore": true
  }
}
FieldDescription
limitNumber of results requested
offsetCurrent offset
totalTotal number of matching results
hasMoretrue if more results exist beyond this page

​
Iterating through all results

import requests

API_KEY = "rsh_live_xxx"
BASE = "https://worker.rushed.com.br/api/articles"

offset = 0
limit = 100
all_articles = []

while True:
    res = requests.get(
        f"{BASE}?limit={limit}&offset={offset}",
        headers={"X-API-Key": API_KEY}
    ).json()

    all_articles.extend(res["data"])

    if not res["pagination"]["hasMore"]:
        break

    offset += limit

print(f"Fetched {len(all_articles)} articles")

​
Endpoints that support pagination

  • GET /api/articles
  • GET /api/articles/by-sector/{sector}
  • GET /api/articles/search
  • GET /api/entities
  • GET /api/entities/{id}/articles