Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.beta.dealroom.co/llms.txt

Use this file to discover all available pages before exploring further.

Filters use a single filter query parameter with an expression string: 
filter=<expression>

​
Expression syntax

FormSyntaxExample
Singlefield[op]:valuetotal_funding[gte]:1000000
ANDand(expr,expr,...)and(total_funding[gte]:1000000,location[eq]:233)
ORor(expr,expr,...)or(location[eq]:118871,location[eq]:1297711)
Nestedand(or(...),expr)and(or(location[eq]:118871,location[eq]:1297711),total_funding[gte]:1000000)
Cross-refrelation__field[op]:valueinvestor__total_invested[gte]:100000000

​
Operators

OperatorDescription
eqExact match
neqNot equal
gtGreater than
gteGreater than or equal
ltLess than
lteLess than or equal
in_anyMatches any of the given values
nin_anyMatches none of the given values
in_allMatches all values (relation filters only)
nin_allExcludes all values (relation filters only)
in and nin are legacy aliases for in_any and nin_any. Prefer the canonical names.

​
Examples

​
Filter by HQ country

Locations are matched by numeric ID from the Dealroom location taxonomy, not by country name. Look up an ID once via GET /api/filters/location/values and reuse it: 
# Discover the ID (returns { id: 233, name: "United States", ... })
curl "https://api-next.beta.dealroom.co/api/filters/location/values?q=United+States" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

# Then filter
curl "https://api-next.beta.dealroom.co/api/entities?sort=-launch_date&filter=location[eq]:233" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "X-Client-Id: YOUR_CLIENT_ID"

​
Filter by industry (match any)

Industries (and other taxonomy values) live behind the tag_id filter. Pass ?type=industry on the values endpoint to scope the lookup, then pipe-separate the resulting IDs in the filter expression: 
# Discover IDs first — returns { id: 42, name: "Fintech", ... } etc.
curl "https://api-next.beta.dealroom.co/api/filters/tag_id/values?q=fintech&type=industry" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

# Then filter
curl "https://api-next.beta.dealroom.co/api/entities?sort=-latest_valuation&filter=tag_id[in_any]:42|99" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "X-Client-Id: YOUR_CLIENT_ID"

​
Combine multiple filters

Use and() to require all conditions: 
# 165 = Netherlands (discover via /api/filters/location/values)
curl "https://api-next.beta.dealroom.co/api/entities?sort=-launch_date&filter=and(location[eq]:165,launch_date[gte]:2018,total_funding[gte]:1000000)" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "X-Client-Id: YOUR_CLIENT_ID"

​
Cross-reference filter

Filter companies by their investors’ total invested amount: 
filter=investor__total_invested[gte]:100000000

​
Sorting

Use the sort parameter with a field name. Prefix with - for descending order. 
sort=-launch_date      # newest first
sort=-total_funding    # highest funded first
The full list of accepted sort keys per resource is in the Filters & Sorting Reference.

​
Available filters

For a complete list of all filters and sort keys grouped by scope, see the Filters & Sorting Reference. You can also fetch available filters programmatically: 
curl "https://api-next.beta.dealroom.co/api/filters?scope=companies" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "X-Client-Id: YOUR_CLIENT_ID"