Fxstreet Economic Calendar API Reference

Free Trial ➡

macroeconomic data of the most revelant events

API Endpoint
https://api.benzinga.io/v4.1/fxstreet
Schemes

https

Version

4.1.0

Authentication

tokenQuery authentication

include key in either query or header

Type:
apiKey
Name:
apike
In:
query

tokenHeader authentication

include key in either query or header

Type:
apiKey
Name:
apikey
In:
header

Playground

Endpoints

GET /econ

Get an array of event date objects

Parameters

NameTypeLocationDescription
viewstring , x ∈ { current , range , day , week , month }query

Filter the returned data by specific time periods. current - Displays n events (parameter 'rows'), tacking m from the past (parameter 'pastevents'), limited to k hours back (parameter 'hoursbefore'). range - Displays events from a start date to a end day - Displays the events for the current day week - Displays the events for the current week month - Displays the events for the current day and the rest of the days in the current month.

rowsintegerquery

The number of rows to display. Only applicable for view=current

pasteventsintegerquery

The number of events from the past. Max 100. Only applicable for view=current. If hoursbefore is specified the events from the past will be limited to those within specified hours.

hoursbeforeintegerquery

When view=current hoursbefore limits the previousevents returned to within the specified hours.

keywordstringquery

Keyword to filter results. Must be at least 3 characters long

countrycodestring (csv) , x ∈ { AU , AT , BE , BR , CA , CL , CN , CO , CZ , DK , EMU , FI , FR , DE , GR , HK , HU , IS , IN , ID , IE , IT , JP , MX , NL , NZ , NO , PL , PT , RO , RU , SG , SK , ZA , ES , SE , CH , TR , UK , US }query

Filter results by specific countries. To filter by multiple, separate by comma - US,FR,DE

categoriesstring (csv) , x ∈ { c94405b5-5f85-4397-ab11-002a481c4b92 , 33303f5e-1e3c-4016-ab2d-ac87e98f57ca , se229c890-80fc-40f3-b6f4-b658f3a02635 , 91da97bd-d94a-4ce8-a02b-b96ee2944e4c , 24127f3b-edce-4dc4-afdf-0b3bd8a964be , fa6570f6-e494-4563-a363-00d0f2abec37 , e9e957ec-2927-4a77-ae0c-f5e4b5807c16 }query

Limit the returned results to specific categories. To filter by multiple, separate by comma - categories=c94405b5-5f85-4397-ab11-002a481c4b92,33303f5e-1e3c-4016-ab2d-ac87e98f57ca Central Banks - c94405b5-5f85-4397-ab11-002a481c4b92 Consump. & Inflation - 33303f5e-1e3c-4016-ab2d-ac87e98f57ca Confidence Indice - se229c890-80fc-40f3-b6f4-b658f3a02635 Employment - 91da97bd-d94a-4ce8-a02b-b96ee2944e4c Industrial & Non-Industrial Activity - 24127f3b-edce-4dc4-afdf-0b3bd8a964be Liquidity & Balance - fa6570f6-e494-4563-a363-00d0f2abec37 Government - e9e957ec-2927-4a77-ae0c-f5e4b5807c16

timezonestring (Fiji+Standard+Time)query

Find a list of possible values here - http://calendar.fxstreet.com/country/GetTimeZones?v=2&f=json Use the FXSstandardName value

Responses

CodeModelDescription
200 OKEventDate

success

Response (200 OK)

[
  {
    "Event": {
      "Id": "string",
      "DateUtc": "string (ISO date)",
      "Name": "string",
      "Description": "string",
      "HTMLDescription": "string",
      "CuntryID": "string",
      "InternationalCountryCode": "string",
      "CountryName": "string",
      "EventTypeID": "string",
      "EventTypeDescription": "string",
      "Potency": "number",
      "PotencySymbol": "string",
      "CurrencyId": "string",
      "CurrencySymbol": "string",
      "Symbol": "string",
      "IsSpeech": "boolean",
      "IsReport": "boolean",
      "RiseType": "string"
    },
    "Id": "string",
    "DateUtc": "string (ISO Date)",
    "Comments": "string",
    "IsPreliminary": "boolean",
    "PeriodType": "string",
    "ForPeriod": "string (ISO Date)",
    "Volatility": "integer",
    "Consensus": "number",
    "HasRelatedContent": "boolean",
    "Previous": "number",
    "Revised": "number",
    "IsTentative": "boolean",
    "IsAllDay": "boolean",
    "IsBetterThanExpected": "boolean",
    "HasNews": "boolean",
    "HasRelateds": "boolean",
    "HasHistory": "boolean",
    "UrlSource": "string",
    "CreateDateUtc": "string (ISO Date)"
  }
]

Models

EventDate: object

PropertyTypeDescription
Eventobject-
Event.Idstring

The event ID - This is a unique identifier for all instances of an event. For example, if the event is yearly, the eventdate row for next year's event will match the event ID of this year's event, but the eventdate IDs will differ.

Event.DateUtcstring (ISO date)

UTC date/time of the eventdate. For example, if the event is the announcment of economic numbers, this is the date/time that the numbers are announced

Event.Namestring

The name of the eventdate

Event.Descriptionstring

This field seems to always be null

Event.HTMLDescriptionstring

Description of the event. This field includes HTML markup tags

Event.CuntryIDstring

The unique ID of the country for the eventdate

Event.InternationalCountryCodestring , x ∈ { AU , AT , BE , BR , CA , CL , CN , CO , CZ , DK , EMU , FI , FR , DE , GR , HK , HU , IS , IN , ID , IE , IT , JP , MX , NL , NZ , NO , PL , PT , RO , RU , SG , SK , ZA , ES , SE , CH , TR , UK , US }

The short country code of the country for the eventdate

Event.CountryNamestring

The name of the country for the eventdate

Event.EventTypeIDstring , x ∈ { c94405b5-5f85-4397-ab11-002a481c4b92 , 33303f5e-1e3c-4016-ab2d-ac87e98f57ca , se229c890-80fc-40f3-b6f4-b658f3a02635 , 91da97bd-d94a-4ce8-a02b-b96ee2944e4c , 24127f3b-edce-4dc4-afdf-0b3bd8a964be , fa6570f6-e494-4563-a363-00d0f2abec37 , e9e957ec-2927-4a77-ae0c-f5e4b5807c16 }

The unique ID of the category for the eventdate Central Banks - c94405b5-5f85-4397-ab11-002a481c4b92 Consump. & Inflation - 33303f5e-1e3c-4016-ab2d-ac87e98f57ca Confidence Indice - se229c890-80fc-40f3-b6f4-b658f3a02635 Employment - 91da97bd-d94a-4ce8-a02b-b96ee2944e4c Industrial & Non-Industrial Activity - 24127f3b-edce-4dc4-afdf-0b3bd8a964be Liquidity & Balance - fa6570f6-e494-4563-a363-00d0f2abec37 Government - e9e957ec-2927-4a77-ae0c-f5e4b5807c16

Event.EventTypeDescriptionstring

The name of the category of the eventdate

Event.Potencynumber

The number associated to PotencySymbol. Importance of event.

Event.PotencySymbolstring

Potency Symbol

Event.CurrencyIdstring

The abbreviated currency code like that used in currency pairs

Event.CurrencySymbolstring

The symbol used for the currency. For example, $ for USD.

Event.Symbolstring

The units of the economic numbers reported in the fields Actual, Consensus, and Previous

Event.IsSpeechboolean

True if event is a speech.

Event.IsReportboolean

True if event is a report.

Event.RiseTypestring

Rise type - Positive, Negative or Neuteral. Used to calculate IsBetterThanExpected. If RiseType is positive, and the actual is higher than the consensus, IsBetterThanExpected will be true.

Idstring

Unique ID of the eventdate. An eventdae is the single specific occurance in time of an event.

DateUtcstring (ISO Date)

The date/time that the eventdate occurs. For example, if the event is an announcment of economic numbers, this is the date/time that the numbers are announced.

Commentsstring

comments

IsPreliminaryboolean

True if the eventdate is preliminary

PeriodTypestring

The period type. For example, PeriodType will be Q if the event is an announcment of quarterly numbers.

ForPeriodstring (ISO Date)

The date/time that the eventdate is reguarding. For example, if it is an announcment of numbers from Q1, this field will be 2017-03-31T00:00:00Z

Volatilityinteger

Volitility for the eventdate

Consensusnumber

Consensus estimate of numbers to be announced at eventdate

HasRelatedContentboolean

True if the eventdate has related content

Previousnumber

Value of the numbers previously announced at same event

Revisednumber

Revised numbers for the eventdate if applicable

IsTentativeboolean

True if the eventdate is tentative

IsAllDayboolean

True if the eventdate lasts all day

IsBetterThanExpectedboolean

True if the numbers announced are better than expected

HasNewsboolean

True if the eventdate has news

HasRelatedsboolean

True if the eventdate has relateds

HasHistoryboolean

True if the eventdate has history

UrlSourcestring

The URL source of the eventdate if applicable

CreateDateUtcstring (ISO Date)

The date/time that the eventdate was created in FXstreet's system

Structure (JSON)
{
  "Event": {
    "Id": "string",
    "DateUtc": "string (ISO date)",
    "Name": "string",
    "Description": "string",
    "HTMLDescription": "string",
    "CuntryID": "string",
    "InternationalCountryCode": "string",
    "CountryName": "string",
    "EventTypeID": "string",
    "EventTypeDescription": "string",
    "Potency": "number",
    "PotencySymbol": "string",
    "CurrencyId": "string",
    "CurrencySymbol": "string",
    "Symbol": "string",
    "IsSpeech": "boolean",
    "IsReport": "boolean",
    "RiseType": "string"
  },
  "Id": "string",
  "DateUtc": "string (ISO Date)",
  "Comments": "string",
  "IsPreliminary": "boolean",
  "PeriodType": "string",
  "ForPeriod": "string (ISO Date)",
  "Volatility": "integer",
  "Consensus": "number",
  "HasRelatedContent": "boolean",
  "Previous": "number",
  "Revised": "number",
  "IsTentative": "boolean",
  "IsAllDay": "boolean",
  "IsBetterThanExpected": "boolean",
  "HasNews": "boolean",
  "HasRelateds": "boolean",
  "HasHistory": "boolean",
  "UrlSource": "string",
  "CreateDateUtc": "string (ISO Date)"
}