The base URL for all InvestGlass API requests is https://app.investglass.com/api/v1. The API is built on RESTful principles with resource-oriented URL endpoints. HTTP status codes are used to indicate any API errors and all responses are returned in JSON format. All requests must be made over an HTTPS connection to ensure a secure transmission of data. Following a RESTful structure, requests should hit API endpoints using the appropriate HTTP method, which will depend on the desired action.
| Method | Description |
|---|---|
| GET | Use the GET method to retrieve information about your users, their accounts, and any associated financial data. This will always be a read-only request, so queried objects will never be modified by a GET request. |
| POST | Use a POST method to update an object, such as a new user or connection. Request parameters should be given in JSON format. The response body will typically return the newly created resource. |
| PUT | Use a PUT method to create a new object, such as a new user or connection. Request parameters should be given in JSON format. The response body will typically return the newly created resource. |
| DELETE | Use a DELETE method to delete an object, such as deleting one of your users. Successful DELETE requests will typically return an empty response body. |