Prerequisites
Scale Plan Required
API access is available exclusively to Scale plan subscribers. If you don't have a Scale plan, please upgrade your subscription to access the API.
Authentication
All API requests require authentication using an API key. You can create API keys in your account settings.
Step 1: Create an API Key
- Go to your Dashboard
- Click on "Settings" in the sidebar
- Navigate to the "API" tab
- Click "Generate New Key"
- Give your key a name and select the type (Production or Test)
- Copy the generated API key (you won't see it again!)
Step 2: Use Your API Key
Include your API key in the Authorization header of all requests:
Authorization: Bearer YOUR_API_KEY_HERE
Your First Request
Let's start with a simple health check to verify your API key is working:
Health Check
curl -X GET "https://fundup.ai/api/v1/health" \
-H "Authorization: Bearer YOUR_API_KEY_HERE"
{
"status": "healthy",
"timestamp": 1640995200
}
Get Companies
Now let's retrieve some companies with filtering and pagination:
Example Request
curl -X GET "https://fundup.ai/api/v1/companies?limit=5&countries[]=US&industries[]=AI" \
-H "Authorization: Bearer YOUR_API_KEY_HERE"
{
"data": [
{
"id": "comp_123",
"companyName": "Example AI Corp",
"description": "AI-powered solution for enterprise",
"country": "US",
"country_name": "United States",
"industries": ["AI", "SaaS"],
"stage": "Series A",
"fundingAmount": 5000000,
"fundingAmountFormatted": "$5M"
}
],
"pagination": {
"limit": 5,
"offset": 0,
"total": 1,
"has_more": false
}
}
Available Filter Values
Get the list of available values for filters to ensure you're using valid parameters:
Get Filter Values
curl -X GET "https://fundup.ai/api/v1/filters" \
-H "Authorization: Bearer YOUR_API_KEY_HERE"
{
"success": true,
"data": {
"countries": ["US", "GB", "DE", "FR", "CA"],
"industries": ["AI", "Fintech", "Healthcare", "SaaS"],
"stages": ["Seed", "Series A", "Series B", "Series C+", "Debt", "undisclosed"],
"company_sizes": ["1-10", "11-50", "51-200", "201-1000"]
}
}
Filtering and Pagination
The API supports powerful filtering and pagination options:
Common Filters
countries[]
- Filter by countries (use 2-letter ISO codes like "US", "GB")industries[]
- Filter by industries (e.g., "AI", "Fintech")stages[]
- Filter by funding stages (e.g., "Seed", "Series A")min_funding
- Minimum funding amount (e.g., "1M", "500K")max_funding
- Maximum funding amount (e.g., "10M", "2B")search
- Search in company names/descriptions
Pagination
limit
- Number of results (max 50)offset
- Skip results for pagination- Response includes pagination metadata
- Use
has_more
to check for more results
Funding Amount Format
Funding amounts support flexible formats with suffixes:
1M
= $1,000,000 (1 million)500K
= $500,000 (500 thousand)2.5B
= $2,500,000,000 (2.5 billion)1000000
= $1,000,000 (plain number)$1M
= $1,000,000 (with currency symbol)
Supported suffixes: K
(thousands), M
(millions), B
(billions)
Next Steps
Ready to explore more?
- Check out the API Reference for detailed endpoint documentation
- Try the Interactive Docs to test endpoints in your browser
- Learn about Rate Limits & Security