Utilities
in package
Utilities class for Market Data API.
This class provides utility methods for checking API status and retrieving request headers.
Table of Contents
Properties
Methods
- __construct() : mixed
- Utilities constructor.
- api_status() : ApiStatus
- Check the current status of Market Data services.
- headers() : Headers
- Retrieve the headers sent by the application.
Properties
$client
private
Client
$client
The Market Data API client instance.
Methods
__construct()
Utilities constructor.
public
__construct(Client $client) : mixed
Parameters
- $client : Client
-
The Market Data API client instance.
api_status()
Check the current status of Market Data services.
public
api_status() : ApiStatus
Check the current status of Market Data services and historical uptime. The status of the Market Data API is updated every 5 minutes. Historical uptime is available for the last 30 and 90 days.
TIP: This endpoint will continue to respond with the current status of the Market Data API, even if the API is offline. This endpoint is public and does not require a token.
Tags
Return values
ApiStatus —The current API status and historical uptime information.
headers()
Retrieve the headers sent by the application.
public
headers() : Headers
This endpoint allows users to retrieve a JSON response of the headers their application is sending, aiding in troubleshooting authentication issues, particularly with the Authorization header.
TIP: The values in sensitive headers such as Authorization are partially redacted in the response for security purposes.
Tags
Return values
Headers —The headers sent in the request.