Skip to navigation
aVenture APIDirectory

Export Directory Records

View as Markdown

Export up to 100 visible directory records as JSON, CSV or XLSX using Accept. Each distinct record consumes export allowance once per billing period; a refused page charges nothing.

Authentication

AuthorizationBearer

Your aVenture API key (https://aventure.vc/settings/api-keys) or OAuth access token

Request

This endpoint expects an object.
directoryenumRequired
Directory whose records are exported.
Allowed values:
pageintegerRequired>=0

Zero-based view page; ignored with id.

sizeintegerRequired1-100

View page size, from 1 through 100; ignored with id.

columnlist of strings or nullOptional

Core columns in the requested order; absent uses the directory’s defaults.

entityFilterobject or nullOptional
The companies or investors view's entity search filter.
idlist of strings or nullOptional

Ordered selection; ignores filters, sort, page and size. Inaccessible records are omitted.

personFilterobject or nullOptional
The people view's person search filter.
sortstring or nullOptional

View order as property,asc or property,desc; ignored with id.

urlTypelist of strings or nullOptional

URL columns after the core columns. Passing urlType keeps columns stable across pages; absent emits types present on this page in declaration order.

Response headers

Content-DispositionstringOptional

attachment with the file name aventure-<directory>-<yyyy-MM-dd>-p<page>.csv or .xlsx; absent on JSON

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

A JSON export or an attachment in the negotiated CSV/XLSX representation.

allowanceobject
Usage allowance for one meter in one billing period, the UTC month by default
columnlist of strings
directoryenum
Public directory page whose filtered view is shared.
Allowed values:
hasNextboolean
pageinteger
rowlist of lists of strings
sizeinteger
totalElementslong

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
406
Not Acceptable Error
409
Conflict Error
415
Unsupported Media Type Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error