To call an endpoint on the RealEquity API, you will need to get an auth token.
Get a Bearer token
With your Partner Client Id and Client Secret you can get a Bearer token that must be used when calling the RealEquity API.
| Field | type | Description |
|---|---|---|
| grant_type | string (required) | Should always be set to: client_credentials |
| scope | string (required) | api |
| client_id | string (required) | Your partner client id |
| client_secret | string (required) | Your partner client secret |
| rg | Query parameter (optional) | The Id of the Resource Group that you want to act on behalf of. If no Resource Group is provided, the access will only provide data that are shared with the System users Actor directly or data that are available to anyone. |
Postman example:
Remember to get access to the Resource Group you want to act through
The owner of a Resource Group can give Partners access by adding the Partner Id to the Partner Access list in the Admin portal in the Resource Group context.
The Bearer token should be added to the Authorization header on all requests to the RealEquity API. The value of the Authorization Key should be:
Bearer {token}