Getting started
All requests are made on https://startalberta.com/api/ via GET requests and url parameters.
Authentification
No authentification is required at the moment.
Rate limiting
A maximum of 60 requests per minut is allowed. If you make too many requests, you will receive a 429 error.
Response format
The response is in JSON format. We recommend adding the Accept: application/json header to your requests. All requests are paginated and have the following format:
{ "current_page": 1, "data": [...], "first_page_url": "https://startalberta.com/api/companies?page=1", "from": 1, "last_page": 201, "last_page_url": "https://startalberta.com/api/companies?page=201", "next_page_url": "https://startalberta.com/api/companies?page=2", "path": "https://startalberta.com/api/companies", "per_page": 25, "prev_page_url": null, "to": 25, "total": 5005 }
The data attribute contains an array of every item matching your request.
Entities
Entity | Url |
---|---|
Article | articles |
Company | companies |
Event | events |
Individual | individuals |
Investment | investments |
Investor | investors |
Job | jobs |
Organization | organization |
Program | program |
Vc Firm | vc-firm |
For example, this is the request to retrieve all companies
GET https://startalberta.com/api/companies
Pagination
All responses are paginated, change page via the page parameter
GET https://startalberta.com/api/companies?page=2
Search
You can search on all the fields of an entity with the search parameter.
GET https://startalberta.com/api/companies?search=Acme
Filter
You can filter on specific fields of an entity.
GET https://startalberta.com/api/companies?name=Acme&created_at=2018-01-01&stage=Validating
This will search all companies containing 'Acme' in their name, created on 2018-01-01 and having the 'Validating' stage.
Sort
You can sort on specific fields of an entity with the sort_field and sort_order parameters.
GET https://startalberta.com/api/companies?sort_field=id&sort_order=desc
Bug or issues?
Please report on GitHub