WSH Meta Data

Introduction

The function EClient.reqWshMetaData is used to request available event types, or supported filter values, that may be used in the call for EClient.reqWshEventData filter field.

Regardless of whether or not you are aware of the Meta Data filters, this request must always be called once per session prior to the EClient.reqWshEventData function.

Request Meta Data

EClient.reqWshMetaData(requestId)

Requests metadata from the WSH calendar.

self.reqWshMetaData(1100)

Receive Meta Data

EWrapper.wshMetaData(requestId, dataJson)

Returns meta data from the WSH calendar.

Once the json content has been received, the specific event types used to filter EClient.reqWshEventData are listed under “meta_data” -> “event_types”.

The “name” field will express what the filter will return, such as “Board of Directors Meeting”.

The “tag” field will return the filter used in your JSON query. The related example would be “wshe_bod”.

def wshMetaData(self, reqId: int, dataJson: str):
	print("WshMetaData.", "ReqId:", reqId, "Data JSON:", dataJson)

Cancel Meta Data

EClient.cancelWshMetaData(requestId)

Cancels pending request for WSH metadata.

self.cancelWshMetaData(1100)