GET Econ

GET

econ

Authorizations

apikey

string

headerrequired

include key in either query or header

Query Parameters

view

enum<string>

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.

Available options:

current,

range,

day,

week,

month

rows

integer

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

pastevents

integer

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.

hoursbefore

integer

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

keyword

string

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

countrycode

enum<string>

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

Available options:

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,

false,

PL,

PT,

RO,

RU,

SG,

SK,

ZA,

ES,

SE,

CH,

TR,

UK,

US

Response

200 - */*

Event

object

Event.Id

string

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.DateUtc

string

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.Name

string

The name of the eventdate

Event.Description

string

This field seems to always be null

Event.HTMLDescription

string

Description of the event. This field includes HTML markup tags

Event.CuntryID

string

The unique ID of the country for the eventdate

Event.InternationalCountryCode

enum<string>

The short country code of the country for the eventdate

Available options:

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,

PL,

PT,

RO,

RU,

SG,

SK,

ZA,

ES,

SE,

CH,

TR,

UK,

US

Event.CountryName

string

The name of the country for the eventdate

Event.EventTypeID

enum<string>

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

Available options:

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

Event.EventTypeDescription

string

The name of the category of the eventdate

Event.Potency

number

The number associated to PotencySymbol. Importance of event.

Event.PotencySymbol

string

Potency Symbol

Event.CurrencyId

string

The abbreviated currency code like that used in currency pairs

Event.CurrencySymbol

string

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

Event.Symbol

string

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

Event.IsSpeech

boolean

True if event is a speech.

Event.IsReport

boolean

True if event is a report.

Event.RiseType

string

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.

string

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

DateUtc

string

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.

Comments

string

comments

IsPreliminary

boolean

True if the eventdate is preliminary

PeriodType

string

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

ForPeriod

string

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

Volatility

integer

Volitility for the eventdate

Consensus

number

Consensus estimate of numbers to be announced at eventdate

HasRelatedContent

boolean

True if the eventdate has related content

number

Value of the numbers previously announced at same event

Revised

number

Revised numbers for the eventdate if applicable

IsTentative

boolean

True if the eventdate is tentative

IsAllDay

boolean

True if the eventdate lasts all day

IsBetterThanExpected

boolean

True if the numbers announced are better than expected

HasNews

boolean

True if the eventdate has news

HasRelateds

boolean

True if the eventdate has relateds

HasHistory

boolean

True if the eventdate has history

UrlSource

string

The URL source of the eventdate if applicable

CreateDateUtc

string

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

Was this page helpful?

GET Company Bull vs. Bear

Introduction

Benzinga APIs

Libraries

Authorizations

Query Parameters

Response