Entity sitemap boundaries

View as Markdown

Per-page boundary timestamps for entity sitemap index generation. Front-end sitemap.xml consumer metadata over large URL inventories; not an enrichment read or write surface.

Query parameters

typeRecordlist of stringsRequired

Entity type filter (Company, Investment Firm, etc.)

sizeintegerOptional

The size of the page to be returned; only 5000 is supported.

Response headers

X-RateLimit-Limitinteger

Requests allowed per client IP in the current rate-limit window.

X-RateLimit-Remaininginteger

Requests left before the tightest applicable rate-limit bucket rejects.

X-RateLimit-Resetinteger

Seconds until the exhausted rate-limit bucket admits another request; 0 when none is exhausted.

Response

OK
boundarylist of objects
sizeinteger
totalinteger

Errors

400
Bad Request Error
406
Not Acceptable Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error