Introduction

Welcome to the IFR Events API documentation page. Here you will find information about published economic events, API endpoints, authentication and how to process the response returned by the API.

Events

The IFR Events API includes all published economic calendar events.

Subscriptions

Please contact your IFR account manager to discuss.

Endpoints

The Events API is composed of the following endpoints:

Authentication

Use this endpoint to request a token that will be sent with subsequent requests for events.

The endpoint can either be used via the Swagger UI or programmatically.

  • Swagger UI - login using your credentials and copy the returned token into your client code for use in the authentication header.
  • Programmatically - call the endpoint once at the beginning of a session and use the token in subsequent requests.

Method POST
URL https://events-api.ifre.com/v1/auth
Input Username and Password
Request content type application/x-www-form-urlencoded
Response content type application/xml
Success An XML response with token and success message. Sample below 
<TokenResponse>
    <Token>XXXXXXXXXXXXXXX</Token>
    <Message>Success</Message>
</TokenResponse>
Login failed 401 code and XML below 
<TokenResponse>
    <Message>Response status code does not indicate success: 401 (Unauthorized).</Message>
</TokenResponse>
Other possible errors Code 500, if there is an issue with the server

Events Endpoint

Use this endpoint to request the latest published economic calendar events.

Method GET
URL https://events-api.ifre.com/v1/events
Parameters

Token

The authentication token from the authentication endpoint


Format

The format in which you wish to view the results. Can be json or xml. By default the API returns json. Any other value is rejected with a 400 Bad Request. Format: format=['json' or 'xml']

Response content type application/json or application/xml as specified in the format parameter.
Success JSON or XML list of economic calendar events
Bad request 400 code when the format query parameter is not json or xml. 
{ "message": "Invalid query parameter: format must be either 'json' or 'xml'" }
Rate limit exceeded 429 code when requests are made faster than the allowed polling interval. The response includes a Retry-After header giving the number of seconds to wait before retrying. Clients should honour this value and self-throttle rather than retrying immediately. 
Retry-After: 5
Authorisation failed 403 code and JSON/XML below 
{
    "service_info": [
        {
            "last_query_time": 1708605560,
            "message": "Invalid credentials supplied. (ERR: 4)"
        }
    ]
}
<body>
    <service_info>
        <last_query_time>1708605659</last_query_time>
        <message>Invalid credentials supplied. (ERR: 4)</message>
    </service_info>
</body>
Other possible errors Code 500

Swagger

Swagger UI can be found here.

Getting Help

For any queries regarding the Events API please contact https://support.lseg.com/s/

For any queries regarding subscriptions please contact your LSEG account manager.