Quickstart

Your first three requests against the aVenture API
View as Markdown

This page assumes a client secret. If you do not have one yet, or you need write access, start at Authentication.

Set it once in your shell:

$export AVENTURE_CLIENT_SECRET="..."

1. List entities

GET /v1/entities returns a page of companies, investors, and accelerators.

$curl -H "X-Client-Secret: $AVENTURE_CLIENT_SECRET" \
> "https://api.aventure.vc/v1/entities?size=5"

The response is a page object — the records are in content, and the rest describes your position in the result set:

1{
2 "content": [ ... ],
3 "number": 0,
4 "size": 5,
5 "totalElements": 12345,
6 "totalPages": 2469,
7 "first": true,
8 "last": false
9}

number is zero-based, so the first page is 0.

2. Narrow it with filters

Filters are query parameters, and most accept the parameter more than once to mean “any of these”:

$curl -H "X-Client-Secret: $AVENTURE_CLIENT_SECRET" \
> "https://api.aventure.vc/v1/entities?stage=seed&headquartersCountry=US&size=5"

GET /v1/entities accepts more than sixty filters covering industry, location, accelerator cohort, fundraising activity, and operating status. Pagination and filtering covers how they combine.

3. Search across everything

When you have a phrase rather than a set of filters, POST /v1/search/all runs the entity, person, and news engines and returns a typed result page for each scope:

$curl -X POST \
> -H "X-Client-Secret: $AVENTURE_CLIENT_SECRET" \
> -H "Content-Type: application/json" \
> -d '{"query": "climate tech seed round"}' \
> "https://api.aventure.vc/v1/search/all?size=10"

page and size apply to every scope. Cross-domain sort is not supported — each scope orders its own results by relevance.

Next