API Reference

Authentication

All API requests require authentication. To authenticate, you'll need an API key, which can be generated from the API key section on the dashboard.

Include the API key in your request header as follows:

Authorization: YOUR_API_KEY

We automatically infer your relay instance using the API key provided.

Base URL

All URLs referenced in the API documentation have the following base:

https://api.relay.angellist.com/v1/external

Endpoints

The Endpoints section provides detailed information about the API routes you can utilize to fetch your portfolio data. Currently, we offer two main endpoints:

Fetch Companies (/v1/companies): Use this endpoint to retrieve a list of companies in your portfolio, along with the funds they are associated with. Ideal for understanding your investment spread.

Fetch Company Updates (/v1/company/{id}/updates): This endpoint allows you to get all updates for a specific company by its ID. Useful for staying up-to-date on the companies you're invested in.

Each endpoint documentation includes the HTTP method, URL parameters, query parameters, and example responses to help you understand how to interact with our API effectively.

Fetch companies

Fetch an entire list of companies including the funds those companies are associated with.

• URL: /companies
• Method: GET
• Query Params:
  • cursor: Cursor for pagination (Optional)
• Headers:
  • Authorization: YOUR_API_KEY

Example:

{
    "data": [
        {
            "id": "3595020d-0885-484b-9422-6bf750eb2098",
            "legalName": "Giraffe360",
            "createdAt": "2023-09-19T11:09:56.536Z",
            "funds": [
                {
                    "id": "7f28e2e9-ff6a-48e0-9527-02b3325362aa",
                    "name": "Fund I LLC"
                }
            ]
        }
    ],
    "total": 1,
    "hasNextPage": false,
    "nextCursor": null
}

curl --location --request  \
GET 'https://api.relay.angellist.com/v1/external/companies' \
--header 'Authorization: YOUR_API_KEY'

Fetch company updates

Fetch all the updates for a specified company by ID.

• URL: /company/{id}/updates
• Method: GET
• URL Params:
  • id: ID of the company
• Query Params:
  • cursor: Cursor for pagination (Optional)
• Headers:
  • Authorization: YOUR_API_KEY

Example

{
    "data": [
        {
            "id": "013d1013-e666-41bf-a456-4eade1f33cc2",
            "createdAt": "2023-09-19T11:10:05.457Z",
            "updatedAt": "2023-09-19T11:10:05.457Z",
            "title": "August 2023 - Company Update",
            "updateDate": "2023-08-24T12:00:00.000Z",
            "cashInBankAmountValue": 2000,
            "cashInBankAmountCurrency": "USD",
            "productUpdatesSummary": null,
            "businessUpdatesSummary": null,
            "numberOfCustomers": 300,
            "hasNewRound": null,
            "newRoundDescription": null,
            "runwayInMonths": null,
            "summary": null
        }
    ],
    "hasNextPage": false,
    "total": 1,
    "nextCursor": null
}

curl --location --request  \
GET 'https://api.relay.angellist.com/v1/external/company/{ID}/updates' \
--header 'Authorization: YOUR_API_KEY'