Código Versión: MANUAL DE USUARIO APLICACIÓN PATS Fecha …€¦ · El presente manual está...

MANUAL DE USUARIO APLICACIÓN PATS

Código: MU-GT-IS-0182

Versión: 1.0

Fecha de vigencia:

viernes, 12 de julio de 2019

Negocio: bvc

http://www.bvc.com.co Copyright Bolsa de Valores de Colombia 2019 Principal Bogotá: Carrera 7 No. 71-21 Torre B Piso 12. Edificio bvc. PBX (57-1) 3139800

TABLA DE CONTENIDO

1. OBJETIVO 2

2. ALCANCE 2

3. USUARIOS A LOS QUE APLICA 2

4. PALABRAS CLAVE 2

5. INGRESO A PATS 3

6. COMANDOS 3

7. FUNCIONES 4



Versión: 1.0

Fecha de vigencia:


Negocio: bvc


1. OBJETIVO

Describir las actividades que debe realizar el usuario trader suscrito al aplicativo Master Trader,

para el manejo del sistema PATS.

2. ALCANCE

Este procedimiento inicia con el ingreso al complemento PATS y termina con la descripción de los

comandos y las funciones contenidas dentro de este complemento.

3. USUARIOS A LOS QUE APLICA

El presente manual está dirigido a los usuarios trader de los clientes suscritos a la aplicación

Master Trader de la Bolsa de Valores de Colombia. Este producto va dirigido a traders, no a

técnicos, por lo tanto, su uso implica un conocimiento suficiente de Microsoft Excel.

4. PALABRAS CLAVE

PATS: Es un sistema para facilitar a usuarios sin conocimientos de programación la construcción de

modelos de algorithmic trading tanto simples como complejos y permitir el acceso al mercado

desde una hoja Excel.

PATS es un Add-In o complemento dentro de Excel para que el usuario se construya sus propios

modelos y algoritmos de trading, utilizando las funcionalidades propias de Excel y un conjunto de

funciones o comandos (las añadidas por el complemento PATS) para facilitarle el uso de elementos

propios del trading.



Versión: 1.0

Fecha de vigencia:


Negocio: bvc


Dichas funciones complementan las existentes en Excel y pueden mezclarse con ellas.

5. INGRESO A PATS

5.1 Una vez instalado con la configuración adecuada es necesario poseer además un usuario y

password del entorno (firma) al que se va a conectar, el cual será suministrado por bvc.

5.2 Se proporcionan dos hojas Excel de prueba, localizadas en <pats_path>\Doc la primera es para una

prueba simple de conexión (VtPats.Connect.xlsx).

5.3 Al momento de realizar la conexión se debe introducir en los campos C3, C5 y C6, los valores

correspondientes al código de la firma, el código del usuario y la contraseña del usuario.

posteriormente, en la celda C4 se debe cambiar el valor a TRUE. Al establecerse de manera

correcta la conexión en las celdas G3 y G4 se visualizará el estado “ESTABLISHED”, y en las celdas

H3 y H4, se visualizará el estado “ON”.

5.4 La siguiente hoja (VtPats.Full.<ResourceCode>.xlsx) se proporciona como ejemplo de toda la

funcionalidad disponible.

6. COMANDOS

6.1 VtConnect:

Realiza la conexión a los servidores de difusión y órdenes



Versión: 1.0

Fecha de vigencia:


Negocio: bvc


7. FUNCIONES

7.1 RDTR

Obtiene la versión de la librería RTD. Esta una llamada directa a RDT para garantizar su

funcionamiento incluso aunque la XLL no esté cargada. Su formato es por lo tanto distinto a las

demás funciones.

RDTR("vtpatsrtd.rtd";;"VERSION")

Resultado: Retorna la versión de VtPatsRTD.dll

7.1.1 VtGetXllVersion

Obtiene la versión de la XLL

VtGetXllVersion()

Resultado: Retorna la versión de VtPatsXll.xll

7.1.2 VtGetExtVersion

Obtiene la versión de la librería Extra

VtGetExtVersion()



Versión: 1.0

Fecha de vigencia:


Negocio: bvc


Resultado: Retorna la versión de VtPatsExtra.dll

7.1.3 VtSetUser

Establece el usuario que accede a los servicios:

VtSetUser(User)

Parámetros:

● User: Código de usuario

La función retorna el Código de usuario.

7.1.4 VtSetPassword

Establece el password del usuario indicado

VtSetPassword(Password)

Parámetros:

● Password: Contraseña del usuario

La función retorna la cadena de asteriscos ****** por razones de seguridad. Para solicitudes de

reinicialización de la contraseña contactese a la línea de servicio al cliente bvc.

7.1.5 VtSetEnv

Establece el entorno (firma) al que se conecta.

VtSetEnv(“Codigo de La firma”)

Parámetros:

● Código de la firma: Corresponde al código de la firma.



Versión: 1.0

Fecha de vigencia:


Negocio: bvc


La función retorna el código de la firma si se ingresó correctamente, de lo contrario, arrojará #N/A.

VtConnect

Establece el estado de la conexión a los servicios de master trader. Para ejecutar este comando,

previamente se deben tener configurados el usuario, password y la firma a la cual pertenece el

código. Deben ser establecidos con las funciones (VtSetUser, VtSetPassword, VtSetEnv)

Parámetros

● Connect: "TRUE"|"FALSE" Si es "TRUE" conecta, con "FALSE" desconecta.

Resultado: "ON" Si fue conectado (Parámetro era "TRUE"), "OFF" si fue desconectado (Parámetro

era "FALSE"). Si falla o los parámetros son incorrectos o retorna #N/A

7.1.6 VtGet

Obtiene el estado de una conexión con los servicios de la plantilla de PATS a los canales de trading

y difusión de la pantalla de Master Trader.

VtGetStatus(Channel)

Parámetros

● Channel: Corresponde al canal sobre el que se requiere conocer el estado de la conexión,

debe ser “MDT_STS” o "TRD_STS" o "MDT_LOG" o "TRD_LOG".

○ TRD_STS: corresponde a la conexión de trading (órdenes).

○ MDT_STS: corresponde a la conexión de la difusión.



Versión: 1.0

Fecha de vigencia:


Negocio: bvc


○ TRD_STS: corresponde al estado de la conexión de trading.

○ MTD_LOG: corresponde al estado de la conexión de la difusión.

Resultado: Error/Estado. Los posibles estados para “TRD_STS y “MTD_STS” pueden ser; WAIT,

CONNECTING, REFUSED, ABORTED, TIMEOUT, ESTABLISHED, LOST, DISCONNECTED,

DISCONNECTING, ERROR. La conexión correcta se denota ESTABLISHED. Los posibles estados para

“TRD_STS” o “MTD_LOG” pueden ser: ON, OFF. La conexión exitosa se denota con las siglas ON.

7.1.7 VtGetIsOrderOnFly

Esta función indica si hay órdenes pendientes de respuesta por parte del servidor OMS de Master

Trader. Los parámetros para esta orden son VERDADERO / FALSO para cada uno de los tipos de

órdenes que se quiere revisar.

VtGetIsOrderOnFly(Send, Modify, Cancel)

Parámetros:

● Send: Booleano. Busca si hay respuestas de órdenes nuevas pendientes

● Modify: Booleano. Busca si hay respuestas de modificaciones pendientes

● Cancel: Booleano. Busca si hay respuestas de cancelaciones pendientes

Resultado: Error/booleano

7.1.8 VtGetIsPendingOrders

Esta función informa si hay órdenes pendientes en las colas internas. No existen parámetros para

esta función. Al momento de enviar la cancelación o modificación de una orden, el resultado de

esta función será VERDADERO hasta que se reciba respuesta del sistema.

VtGetIsPendingOrders()

Resultado: Error/booleano(VERDADERO/FALSO)

7.1.9 VtGetNotifyCount

Esta función retorna el número de notificaciones RTD emitidas. Las fórmulas RDT sólo se vuelven a

llamar si hay algún cambio en las celdas de entrada. Esto es por diseño del propio Excel. Las

notificaciones RTD emitidas es el número de veces que la librería del PATS notifica al Excel de

cambios (esto incluye cualquier tipo de cambio, tanto de precios como de órdenes). Por lo que se

puede usar para forzar el recálculo de Excel con cualquier cambio de datos.

VtGetNotifyCount()

Resultado: Error/ contador(Número de notificaciones)



Versión: 1.0

Fecha de vigencia:


Negocio: bvc


7.1.10 VtGetTimer

Esta función permite obtener la hora Local o UTC.

VtGetTimer(Time)

Parámetros

● Time: puede ser “ServerUTC” o “ServerLocal”. ServerUTC” retorna la hora del servidor en

UTC, mientras “ServerLocal” retorna la hora del servidor en horario local de la máquina del PATS.

Si no se especifica se retorna la hora en UTC. Se utiliza el servidor de precios.

Las horas requieren un mensaje del servidor de precios (market data de bvc), por lo que algunos

segundos pueden pasar entre la conexión y su obtención.

Resultado: Error/Hora

7.1.11 VtGetHeaders

Obtiene los diferentes encabezados de las matrices estándar para funciones de consultas de

órdenes y posiciones, así como envío, modificación o cancelación de órdenes. Esta función debe

ser operada de forma matricial, por lo cual es necesario al momento de aplicar la función

seleccionar el rango en el cual se requiere establecer los encabezados, y con este rango

seleccionado se de oprimir Ctrl+Shift+Enter al momento de ejecutar la función.

{=VtGetHeaders("Type";"Mode")}

Las sintaxis permitidas son:

● {=VtGetHeaders("POS")}: Esta sintaxis permite en un rango de 1 fila y 31 columnas conocer

los encabezados asociadas al resultado de la función VtGetPosition.

● {=VtGetHeaders("ORD";”SHT”)}: Esta sintaxis permite en un rango de 1 fila y 38 columnas

conocer los encabezados asociados al resultado corto de las funciones VtGetOrder y VtGetEvent.

● {=VtGetHeaders("ORD";"LNG")}: Esta sintaxis permite en un rango de 1 fila y 91 columnas

conocer los encabezados asociados al resultado largo de las funciones VtGetOrder, VtGetEvent y

VtGetOrderEvent.

● {=VtGetHeaders("SUB","SHT")}: Esta sintaxis permite en un rango de 1 fila y 31 columnas

conocer los encabezados asociados a los campos requeridos para el uso de las funciones

VtSendOrder, VtSendMOdify, VtSendCancel, VtSendCancellAll y VtMultiSumbmit.

● {=VtGetHeaders("SUB","LNG")}: Esta sintaxis permite en un rango de 1 fila y 31 columnas

conocer los encabezados asociados a los campos requeridos para el uso de las funciones

VtSendOrder, VtSendMOdify, VtSendCancel, VtSendCancellAll y VtMultiSumbmit.

Resultado: Error/Rango con encabezados

A continuación, se presenta un ejemplo de la sintaxis por medio de la que se pueden obtener los

encabezados para el type “POS”.



Versión: 1.0

Fecha de vigencia:


Negocio: bvc


A continuación, se presenta un ejemplo de la sintaxis por medio de la que se pueden obtener los

encabezados para el type “POS” y Mode “LNG”.

7.1.12 VtGetData

Esta función permite obtener el valor de un campo específico de la difusión, para un mercado y un

nemotécnico específico. A continuación se describen los insumos de la función:

VtGetData( Market, Symbol, Field)

Parámetros

● Market: Corresponde al nombre de la rueda de Negociación (ASPT, DSPT, ABLO, AGBL, …).

● Symbol: Corresponde al Nemotécnico del título (TFIT16240724, TUVT11070525,…).

● Field: Nombre del campo de la difusión del cual se quiere traer la información. Los

campos disponibles de la difusión son:

○ TrdPhase: Fase de negociación.

○ LastTime: Hora de la última negociación.

○ TotTurnover: Efectivo del mercado.

○ TotVolume: Volumen del mercado.

○ BidNum: Número de órdenes en compra.

○ BidQty: Cantidad en compra.

○ BidDPx: Precio sucio en compra.

○ BidYld: Tasa en compra.

○ BidPx: Precio en compra.

○ AskPx: Precio en venta.

○ AskYld: Tasa en venta.

○ AskDPx: Precio sucio en venta.

○ AskQty: Cantidad en venta.

○ AskNum: Número de órdenes en venta.

○ LastPx: Último precio negociado.

○ LastQty: Última cantidad negociada.

○ LastYield: Última tasa negociada.

○ LastAmount: Último efectivo.

○ LastDirtyPx: Precio sucio.



Versión: 1.0

Fecha de vigencia:


Negocio: bvc


○ LastTck: Sube, baja o repite (+ / - / =).

○ Open: Precio de apertura.

○ Close: Precio de cierre.

○ High: Precio máximo.

○ Low: Precio mínimo.

○ Avg: Precio medio.

○ OpenYield: Tasa de apertura.

○ CloseYield: Tasa de cierre.

○ HighYield: Tasa máxima.

○ LowYield: Tasa mínima.

○ AvgYield: Tasa media.

○ Prev: Precio previo.

○ RefPx: Precio de referencia.

○ AuctionPx: Precio de la subasta.

○ AuctionQty: Cantidad de la subasta.

○ HighSpread: No aplica.

○ LowSpread: No aplica.

○ LowThreshold: No aplica.

○ HighThreshold: No aplica.

A continuación, se presenta un ejemplo de la sintaxis requerida para obtener la primera línea del

campo “BidQty”, para el título TFIT16240724 en el mercado ASPT.

Los campos “BidNum”, “BidQty”, “BidDPx”, “BidYld”, “BidPx”, “AskPx”, “AskYld”, “AskDPx”,

“AskQty” y “AskNum”, se pueden obtener para líneas específicas de la profundidad del mercado

por precios.

A continuación, se presenta un ejemplo de la sintaxis necesaria para obtener la cuarta línea del

mercado por precios para el campo “BidNum”. Como se puede observar, en este caso es necesario

cambiar el nombre del campo por “BidNum4”, donde el número adicionado corresponde a la línea

de la profundidad que se quiere observar. Esta misma lógica debe ser utilizada en cada uno de los

campos para obtener las diferentes líneas de la profundidad.



Versión: 1.0

Fecha de vigencia:


Negocio: bvc


Nota: Es posible consultar hasta la décima línea de la profundidad del mercado por precios en

Master Trader.

Resultado: Error/Dato.

7.1.13 VtGetRData

Esta función permite obtener diferentes campos de la difusión del mercado por precios con salida

a un rango de celdas indicado. A diferencia de la función VtGetData, esta función permite replicar

diferentes líneas de la difusión sin necesidad de utilizar diferentes funciones. A continuación se

describen los insumos de la función:

VtGetRData (Market, Symbol, Fields, OutputRange)

Parámetros


● Symbol: Corresponde al Nemotécnico del título (TFIT16240724, TUVT11070525,…).

● Fields: Corresponde a un rango que contiene los campos de la difusión que se quieren obtener. Los

campos de la difusión del mercado por precios disponibles en diferentes líneas son; BidNum,

BidQty, BidDPx, BidYld, BidPx, AskPx, AskYld, AskDPx, AskQty, AskNum.

Esta función también permite obtener una línea de la profundidad del mercado por precios, con

campos de estadísticas como; LastTime, TotTurnover, TotVolume, LastPx, LastQty, LastYield,

LastAmount, LastTick, Open, High, Low, Avg, OpenYield, AvgYield, Prev, RefPx, AutionPx,

AuctionQty, HighSread, LowSpread, LowTreshold, HighTreshold. La descripción de estos campos se

presentó en la función VtGetData.



Versión: 1.0

Fecha de vigencia:


Negocio: bvc


● OutputRange: Es el rango de Excel en el cual se quieren obtener los datos. El tamaño de

este rango debe contemplar el número de líneas de la difusión así como el número de campos que

se quieren obtener.

Los rangos de los parámetros Fields y OutputRange deben ser del mismo tamaño, de lo contrario,

la salida no se dará de forma correcta.

A continuación, se presenta un ejemplo de la sintaxis requerida en Excel para replicar el mercado

por precios, es importante tener en cuenta que cuando el objetivo es el de replicar las diferentes

líneas de la profundidad el parámetro Fields se escribe de la siguiente forma: “BOOK[Número de

líneas de la profundidad,Nombre de los campos requeridos]". La función permite traer hasta 10

líneas de la profundidad.

A continuación, se presenta un ejemplo de la sintaxis requerida en Excel para replicar la

información de estadísticas de la difusión.



Versión: 1.0

Fecha de vigencia:


Negocio: bvc


Nota: Esta función podrá ser consultada en más detalle en la plantilla de PATS, en la hoja Price

BVC.

Resultado: Error/0.

7.1.14 VtGetEvent

Esta función permite consultar la información de todas las órdenes enviadas al sistema, así como,

todos los eventos y modificaciones por las cuales las órdenes han pasado. Es posible realizar filtros

para obtener solo la información de un mercado, un nemotécnico, una firma, un usuario o un

estado para las distintas órdenes, para consultar los diferentes estados y modificaciones de una

sola orden el usuario podrá utilizar la función VtGetOrderEvent (Descrita posteriormente). A

continuación se describen los insumos de la función:

VtGetEvent(Mode, RangeName, Market, Symbol, Firm, User, Filter)

Parámetros

● Mode: "SHT"|"LNG", Short/Long. Este modo hace referencia a la cantidad de columnas

mencionadas con la función VtGetHeaders. El modo corto son 35 columnas, en modo largo son 88.

● RangeName: Nombre del rango en el que se escribe la salida incluyendo todas las filas

escritas. La primera fila es la dada por el Output menos una fila para incluir el encabezado.

● Market: Código de mercado para el que se quiere obtener las órdenes "ASPT", "ABLO" ...,

puede ser '*' para todos los mercados.

● Symbol: Código de símbolo "TFIT16240724", "TFIT06110919" ..., puede ser '*' Todos los

títulos.

● Firm: Código de firma, puede ser '*' para todas las firmas.

● User: Código de usuario.

● Filter: Selecciona aquellos eventos que estén en un estado determinado "NEW",

"PART_FILL"..., puede ser '*' para todos los estados.

● Output: Celdas a rellenar, debe ser una fila y 35-88 columnas.

A continuación, se presenta un ejemplo de la sintaxis requerida para consultar la información de

las distintas órdenes de la rueda ASPT.



Versión: 1.0

Fecha de vigencia:


Negocio: bvc


Resultado: Error/Número de filas diligenciadas. Al poner ‘*’ como dato de filtrado, trae todos los

valores posibles del tipo de filtro.

7.1.15 VtGetOrder

Esta función permite consultar la información de las órdenes enviadas al sistema con su último

estado correspondiente, permitiendo realizar filtros sobre las mismas. A continuación se describen

los insumos de la función.

VtGetOrder(Mode, RangeName, Market, Symbol, Firm, User, Filter, Output)

Parámetros



● RangeName: Nombre del rango en el cual se escribe la salida incluyendo todas las filas

escritas. La primera fila es la dada por el Output menos una fila para incluir el encabezado.

● Market: Código de mercado para el que se quiere obtener las órdenes (ASPT, DSPT, ABLO,

AGBL, …), puede ser “*” para obtener todos los mercados.

● Symbol: Código de un instrumento ("TFIT16240724", "TFIT06110919", …), puede ser “*”

para obtener todos los títulos.

● Firm: Código de firma, puede ser “*” para obtener la información de la firma.

● User: Código de usuario, puede ser “*” para obtener la información de los usuarios, sobre

los cuales se tiene jerarquía.

● Filter: Selecciona aquellos eventos que estén en un estado determinado "NEW",

"PART_FILL", “REJC”, “FILL”, “CANC”..., puede ser “*” para obtener las órdenes con todos los

estados.

● Output: Celdas a rellenar, debe ser una fila y 38-91 columnas.

Los Campos disponibles de la difusión son:



Versión: 1.0

Fecha de vigencia:


Negocio: bvc


➢ ExecepSeq

➢ ExecRepDate

➢ Mkt

➢ Symbol

➢ Firm

➢ User

➢ CIOrdID

➢ SecurityIDS

➢ SecurityID

➢ Accnt

➢ AvgPx

➢ CumQty

➢ Cur

➢ ExecID

➢ ExecInst

➢ ExecRefID

➢ HandlInst

➢ LastMkt

➢ LastPx

➢ LastQty

➢ OrdID

➢ OrdQty

➢ OrdStatus

➢ OrdType

➢ OrigTime

➢ Price

➢ OrigText

➢ Text

➢ TimeInForce

➢ TransacTime

➢ SettlType

➢ TradeDate

➢ CxlQty

➢ StopPx

➢ ExDestination

➢ OrdRejReason

➢ ExpireTime

➢ ExecType



Versión: 1.0

Fecha de vigencia:


Negocio: bvc


➢ LeavesQty

➢ EffectiveTime

➢ SecOrdID

➢ PegOffsetValue

➢ TradingSessionID

➢ ExecRestatementReason

➢ DiscretionOffsetValue

➢ SecClOrdID

➢ SecondaryExecID

➢ OrderCapacity

➢ CrossID

➢ ClOrdLinkID

➢ WorkingIndicator

➢ PegOffsetType

➢ PeggedPrice

➢ PegScope

➢ DiscretionMoveType

➢ VTRejectReason

➢ ExchangeTradeType

➢ VTOrderLiveQty

➢ VTFilterID

➢ VTFilterOwner

➢ VTFreezeReason

➢ VTInstructions

➢ VTPolicyCode

➢ VTAskForConfirmation

➢ VTSIBESourceIndicator

➢ VTSIBEModificationCounter

➢ VTOrderIDParent

➢ VTCommType

➢ VTLeavesMkt

➢ VTQtyComm

➢ VTQtyAvailable

➢ VTOrderIDSource

➢ VTCommStatus

➢ VTExecLinkIDSource

➢ VTExecLinkID

➢ VTOrdLinkIDType



Versión: 1.0

Fecha de vigencia:


Negocio: bvc


➢ CtxRejReason

➢ VTRouteCode

➢ ShownQty

➢ ClientId

➢ InvestorId

➢ ExecutorId

➢ Liquidity

➢ TradingCapacity

➢ Depositary

➢ Yield

➢ MinQty

➢ TradeAmt

➢ DirtyPx

➢ LastYld

Nota:

● El campo TradeAmt corresponde al valor de giro de la última operación

● El campo LastYld corresponde a la tasa de calce de la operación

Resultado: Error/Número de filas diligenciadas.

7.1.16 VtGetOrderEvent

Esta función permite consultar la información de una orden específica, evidenciando cada uno de

los eventos por los cuales esta orden ha pasado, así como cada una de las modificaciones

realizadas.

VeGetOrderEvent(Mode, RangeName,OrderId,Output)

Parámetros



● RangeName: Nombre del rango en el que se escribe la salida incluyendo todas las filas escritas. La

primera fila es dada por el Output menos una fila para incluir el encabezado.

● OrderId: corresponde al identificador de la orden en MT, puede ser consultado en la columna

OrdID de la función VtGetOrder.



Versión: 1.0

Fecha de vigencia:


Negocio: bvc


● Output: rango de celdas a rellenar, debe ser de una fila por 35 o 91 columnas.

Resultado: Error/Número de filas diligenciadas.

7.1.17 VtSendOrder

Esta función permite realizar el envío de una orden al sistema, con base en unos parámetros

establecidos por el usuario.

VtSendOrder(On,Market,Symbol,CIOrderID,Side,Price,OrderQty,OrdType,Text,TimeInForce,ExpireTi

me,Account,Capacity,Currency,ISIN,Route,OrdIdParent,HandInst,StopPrice,ShownQty,MinQty,Depo

sitary,ExDestination,LoteType,Facial,IssueDate,MaturityDate,PayFreq,Yield)

Parámetros

● On: Debe ser "TRUE", "FALSE", “AUTO”. “TRUE” activa el comando de envío de órdenes. En

cualquier otro caso se retorna “0”. Es pertinente tener en cuenta que al estar activado este

parámetro, si se realiza cualquier modificación a alguno de los otros parámetros de la función se

enviará una nueva orden al sistema. “FALSE”, detiene el envió de órdenes y “AUTO” realiza un

envío continuo de órdenes al sistema con las características establecidas, es posible cambiar las

características de las nuevas órdenes durante el envío continuo. **

● Market: Corresponde al nombre de la rueda de Negociación (ASPT, DSPT, ABLO, AGBL,

…).**

● Symbol: Código de un instrumento ("TFIT16240724", "TFIT06110919", …), puede ser “*”

para obtener todos los títulos.**

● ClOrderID: Identificador de la orden asignada por el usuario, debe ser único y es opcional. Si no se

incluye se asignará uno por el componente. Este campo hace referencia al IDENT. SECUND. de

Master Trader.*



Versión: 1.0

Fecha de vigencia:


Negocio: bvc


● Side: Indica el sentido de la orden. BUY, SELL.**

● Price: Se deja vacío si es una orden de Mercado. NOTA: Si no se da precio y no es una orden de

mercado, 0 es usado como precio.*

● OrderQty: Cantidad de la orden.**

● OrdType: Tipo de la orden (Mercado:“MKT”, Limite:“LMT”, Market Limit“MKT_LMT”, Stop:“STP”,

Stop Limit“STP_LMT”).**

● Text: Texto libre.*

● TimeInForce: DAY.**

ExpireTime: Hora de expiración de la orden. Debe estar en formato HH:MM:SS.*

● Account: Cuenta del portafolio al cual va a ingresar la orden.**

● Capacity (no aplica para el mercado colombiano): Capacidad (AGEN, PROP, INDV, PRIN, RSK_PRIN,

AGT_MBR)*

● Currency: Código de moneda (EUR, USD, COP, etc.)**

● ISIN: International Securities Identification Number.*

● Route: Cadena que identifica la ruta por la que irá la orden.*

● OrdIdParent: Identificador de orden padre (CARE).*

● HandInst: Handing Instance*

● StopPrice: Precio de activación (obligatorio para órdenes que usen precio de activación MKT_LMT,

STP, STP_LMT)*

● ShownQty: Cantidad visible*

● MinQty: Cantidad mínima de la orden a ser ejecutada*

● Depositary: Depósito**

● ExDestination: Destination defined by institution*

● LoteType: Tipo de lote (Total=T “que la orden debe ser calzada en la totalidad de su nominal” o

Parcial=P “que su nominal puede ser calzado parcialmente”)*

● Facial: Valor facial

● IssueDate: Fecha en la que el título es emitido (Deuda Privada)*

● MaturityDate: Fecha de vencimiento (Deuda Privada)*

● PayFreq: Frecuencia de pago de cupón (Mensual “M”, Trimestral “T”, Semestral “S”. Deuda

Privada)*

● Yield: Tasa a la cual se quiere comprar o vender el título, puede reemplazar al campo precio, caso

en el cual éste deja de ser obligatorio (En el caso que se ingresen valores en los campos Precio y

Tasa, la aplicación tomará el valor de la Tasa para ingresar la orden). **

*Campo opcional, puede estar vacío pero debe contemplarse en la sintaxis.

**Campo obligatorio.

A continuación se presenta la sintaxis para el envío de una orden de venta en la rueda ASPT, en el

título TFIT16240724, por una cantidad de 1.000 millones a un precio de 120.



Versión: 1.0

Fecha de vigencia:


Negocio: bvc


Nota: Para obtener en un rango los nombres de los parámetros, consultar la función

VtGetHeaders.

Resultado: Error/ClOrdId asignado

7.1.19 VtSendModify

Esta función permite la modificación de una orden.

VtSendModify(On,Market,Symbol,CIOrderID,Side,Price,OrderQty,OrdType,Text,TimeInForce,ExpireT

ime,Account,Capacity,Currency,ISIN,Route,OrdIdParent,HandInst,StopPrice,ShownQty,MinQty,Dep

ositary,ExDestination,LoteType,Facial,IssueDate,MaturityDate,PayFreq,Yield)

Parámetros

● On: Debe ser "TRUE", "FALSE", “AUTO”. “TRUE” activa el comando, cualquier modificación que se

realice con este comando será tomada como una orden nueva por el sistema al momento de

realizarse. “FALSE” detiene cualquier modificación que se realice a la orden desde Excel. “AUTO”

envía de manera continua modificaciones a la orden, en caso que los otros parámetros continúen

siendo iguales, la orden no se verá modificada en Master Trader.**

● Market: Corresponde al nombre de la rueda de Negociación (ASPT, DSPT, ABLO, AGBL, …).**

● Symbol: Código de un instrumento ("TFIT16240724", "TFIT06110919", …), puede ser “*” para

obtener todos los títulos.**

● ClOrderID: Identificador de orden asignado por el usuario. Debe ser único. Es opcional. Si no se

incluye se asignará uno por la aplicación. Hace referencia al IDENT. SECUND. de Master Trader.**


● Price: Se deja vacío si es una orden de Mercado. NOTA: Si no se da precio y no es una orden de

mercado, 0 es usado como precio.*

● OrderQty: Cantidad de la orden.**



Versión: 1.0

Fecha de vigencia:


Negocio: bvc


● OrdType: Tipo de la orden (Mercado:“MKT”, Limite:“LMT”, Market Limit“MKT_LMT”, Stop:“STP”,

Stop Limit“STP_LMT”).**


● TimeInForce: DAY.**

● ExpireTime: Hora de expiración de la orden. Debe estar en formato HH:MM:SS.*

● Account: Cuenta del portafolio al cual va a ingresar la orden.**

● Capacity: Capacidad (AGEN, PROP, INDV, PRIN, RSK_PRIN, AGT_MBR)*

● Currency: Código de moneda (EUR, USD, COP, etc.)**

● ISIN: International Securities Identification Number.*

● Route: Cadena que identifica la ruta por la que irá la orden.*

● OrdIdParent: Identificador de orden padre (CARE).*

● HandInst: Handing Instance*

● StopPrice: Precio de activación (obligatorio para órdenes que usen precio de activación MKT_LMT,

STP, STP_LMT)*

● ShownQty: Cantidad visible*

● MinQty: Cantidad mínima de la orden a ser ejecutada*

● Depositary: Depósito**

● ExDestination: Destination defined by institution*

● LoteType: Tipo de lote (Total=T “que la orden debe ser calzada en la totalidad de su nominal” o

Parcial=P “que su nominal puede ser calzado parcialmente”)*

● Facial: Valor facial

● IssueDate: Fecha en la que el título es emitido (Deuda Privada)*

● MaturityDate: Fecha de vencimiento (Deuda Privada)*

● PayFreq: Frecuencia de pago de cupón (Mensual “M”, Trimestral “T”, Semestral “S”. Deuda

Privada)*

● Yield: Tasa a la cual se quiere comprar o vender el título, puede reemplazar al campo precio, caso

en el cual éste deja de ser obligatorio. **

*Campo opcional

**Campo obligatorio

A continuación, se presenta un ejemplo de la sintaxis requerida para la modificación de una orden:



Versión: 1.0

Fecha de vigencia:


Negocio: bvc



VtGetHeaders.


VtSendCancel

Esta función permite cancelar una orden existente en el sistema.

VtSendCancel(On,Market,Symbol,CIOrderID, OrderId, Side, Text)

Parámetros

● On: Debe ser "TRUE", "FALSE", “AUTO”. “TRUE” activa el comando de cancelación de la orden.

“FALSE”, desactiva el comando de cancelación de la orden. “AUTO”, envía de manera continua

mensajes de cancelación de la orden. En cualquier otro caso se retorna “0”.**


● Symbol: Código de un instrumento ("TFIT16240724", "TFIT06110919", …), puede ser “*” para

obtener todos los títulos.**

● ClOrderID: Identificador de orden asignado por el usuario. Debe ser único. Es opcional. Si no se

incluye se asignará uno por el componente. Hace referencia al IDENT. SECUND. de Master Trader.*

● OrderId: Corresponde al identificador de la orden en MT, puede ser consultado en la columna

OrdID de la función VtGetOrder. Si no se tiene por no haber llegado se usará el ClOrderID**.



Versión: 1.0

Fecha de vigencia:


Negocio: bvc




●

*Campo opcional

**Campo obligatorio

A continuación, se presenta un ejemplo de la sintaxis requerida para cancelar una orden:


VtGetHeaders.


7.1.20 VtSendCancelAll

Esta función permite cancelar todas las órdenes enviadas al sistema. Así mismo, permite cancelar

todas las órdenes de una rueda determinada, de un título determinado, o de una combinación

específica de rueda y título.

VtSendCancelAll(On,Market,Symbol,Text)

Parámetros



Versión: 1.0

Fecha de vigencia:


Negocio: bvc


● On: Debe ser "TRUE", "FALSE", “AUTO”. “TRUE” activa el comando de cancelación masiva de

órdenes. “FALSE” desactiva el envío de cancelaciones de órdenes al sistema. “AUTO”, envía de

manera continua solicitudes de cancelación de las órdenes que cuenten con las características

definidas. En cualquier otro caso se retorna “0”.**

● Market: Corresponde al nombre de la rueda de Negociación (ASPT, DSPT, ABLO, AGBL, …).*

● Symbol:Código de un instrumento ("TFIT16240724", "TFIT06110919", …), puede ser “*” para

obtener todos los títulos.*

● Text: Texto libre

●

*Campo opcional

**Campo obligatorio

Nota: si se quiere cancelar todas las órdenes enviadas al sistema, es necesario dejar los campos de

los parámetros Market y Symbol vacíos. Si se quiere cancelar todas las órdenes enviadas a una

rueda, se debe dejar el campo título vacío y se debe escribir el nombre de la rueda en el campo

Market. Si se quiere eliminar todas las órdenes sobre un título en las diferentes ruedas, se debe

dejar el campo Market vacío, y se debe escribir el nemotécnico del instrumento en el campo

Symbol.

A continuación, se presenta un ejemplo de la sintaxis requerida para cancelar todas las órdenes en

la rueda ASPT, en el título TFIT16240724.


VtGetHeaders.

7.1.21 VtMultiSubmit



Versión: 1.0

Fecha de vigencia:


Negocio: bvc


Esta función permite aplicar múltiples comandos de orden, con base en la información de un

rango establecido. Permitiendo envío masivo, retiro masivo o modificaciones masivas de órdenes.

VtMultiSubmit(InputRange)

Parámetros

● InputRange: Corresponde al rango de entrada de los datos, cada campo corresponde a un

comando, este rango debe contener 31 columnas, y un número de filas que depende del número

de acciones que se quieran realizar de manera conjunta, ya sea envío modificación, o cancelación.

Descripción de los campos correspondientes a cada Columna del rango seleccionado en la función.

1. Type: “ORD”, “MOD”, “CAN”, Envío de orden, modificación o cancelación.

2. On: Debe ser "VERDADERO", "TRUE", o booleano true para disparar el comando. AUTO se puede usar

para tener NOT(VtGetIsOrderOnFly AND VtGetIsPendingOrders).

3. Market: Código de mercado sobre el cual se realizarán los envíos, cancelaciones o modificaciones (ASPT,

DSPT, ABLO, AGBL, …).

4. Symbol: Código del instrumento ("TFIT16240724", "TFIT06110919", … ).

5. ClOrderID: Identificador de orden asignado por el usuario. Debe ser único. Es opcional si no se incluye se

asignará uno por el componente.

6. OrderId: Identificador de los eventos/órdenes, si no se tiene por no haber llegado se usará el ClOrderID.

Corresponde al identificador de la orden en MT, puede ser consultado en la columna OrdID de la

función VtGetOrder.

7. Side: Compra (“BUY”), Venta(“SELL”).

8. Price: Precio de envío o modificación de una orden, este campo es nulo para el envío de una orden de

mercado o para una anulación, puede ser reemplazado por el campo Yield. En caso de no contener

un valor para una orden límite, el precio corresponderá a 0.

9. OrderQty: Cantidad de la orden.



Versión: 1.0

Fecha de vigencia:


Negocio: bvc


10. OrdType: Tipo de la orden (Mercado:“MKT”, Limite:“LMT”, Market Limit“MKT_LMT”, Stop:“STP”, Stop

Limit“STP_LMT”).

11. Text: Texto libre.

12. TimeInForce: (“DAY”, “GTC”, “OPG”, “IOC”, “FOK”, “GTD”, “CLG”).

13. ExpireTime: Fecha de expiración de la orden, Obligatorio si TimeInForce = GTD (Good till Date).

14. Account: Cuenta a usar.

15. Capacity: Capacidad (AGEN, PROP, INDV, PRIN, RSK_PRIN, AGT_MBR).

16. Currency: Código de moneda (EUR, USD, COP, etc.).

17. ISIN: International Securities Identification Number.

18. Route: Cadena que identifica la ruta por la que irá la orden.

19. OrdIdParent: Identificador de orden padre (CARE).

20. HandInst (no aplica para el mercado colombiano): Handing Instance (AUT_PRV por defecto):

AUT_PRV: Automated execution order, private, no Broker intervention

AUT_PUB: Automated execution order, public, Broker intervention OK

MAN_BST: Manual order, best execution

OPR_AUT: Órdenes autorizadas por operadores con examen SIBE

BSK_ARB: Cestas que hacen arbitraje contra el futuro Ibex35

ARB_AUT: “Arbitraje autorizado"

21. StopPrice: Precio de parada.

22. ShownQty: Cantidad mostrada en orden con cantidad oculta.

23. MinQty: Cantidad mínima de la orden a ser ejecutada.

24. Depositary: Settlement Location.

25. ExDestination: Destination defined by institution.



Versión: 1.0

Fecha de vigencia:


Negocio: bvc


26. LoteType: Tipo de lote (Total=T o Parcial=P).

27. Facial: Valor facial.

28. IssueDate: Fecha en la que el título es emitido.

29. MaturityDate: Fecha de maduración.

30. PayFreq: Frecuencia de pago de cupón.

31. Yield:Tasa a la cual se quiere comprar o vender el título, puede reemplazar al campo precio, caso en el

cual éste deja de ser obligatorio. **

Los campos necesarios para el envío, cancelación o modificación son los mismo requeridos en las

funciones VtSendOrder, VtSendModify, VtSendCancel.

Nota: Para obtener en un rango los nombres de los parámetros, consultar la función VtGetHeaders.

Resultado: Error/Número de comandos enviados

7.1.22 VtGetPosition

Esta función permite conocer las posiciones (en cantidad nominal) en el mercado para cada

combinación de market, symbol, firm, user y account.

VtGetPosition(RangeName,Market,symbol,firm,user,account)

Parámetros

● RangeName: Nombre del rango en el que se escribe la salida incluyendo todas las filas escritas, La

primera fila es la dada por el Range menos una fila para incluir el encabezado.

● Market: Corresponde al nombre de la rueda de Negociación (ASPT, DSPT, ABLO, AGBL, …), puede

ser '*' para visualizar todas las ruedas.



Versión: 1.0

Fecha de vigencia:


Negocio: bvc


● Symbol:Corresponde al Nemotécnico del título (TFIT16240724, TUVT11070525,…), puede ser '*'

para visualizar todos los títulos.

● Firm: Código de firma, puede ser '*'.

● User: Código de usuario, puede ser '*'.

● Account: Código de cuenta, puede ser '*'.

● Range: Celdas a rellenar, debe ser una fila y 31 columnas, correspondientes a cada campo.

Descripción de los campos correspondientes a cada Columna del Rango seleccionado en la función.

1. Mkt: Mercado

2. Symbol: Nemotécnico del instrumento.

3.Firm: Firma

4. User: Código del usuario.

5. Account: Código de la cuenta.

6. BuyCum: Cantidad acumulada de compra.

7. BuyLeaves: Cantidad pendientes de compra.

8. BuyAverage: precio VWAP de compra.

9. SellCum: Cantidad Acumulada de ventas.

10. SellLeaves: Cantidad pendiente de venta.

11. SellAverage. precio VWAP de venta.

12. L/S: Acumulado de cantidad de compras menos ventas.

13. BUY_SEND: Número de órdenes de compra en estado “SEND”.

14. SELL_SEND: Número de órdenes de venta en estado “SEND”.

15. BUY_NEW: Número de órdenes de compra en estado “New”.

16. SELL_NEW: Número de órdenes de venta en estado “New”.



Versión: 1.0

Fecha de vigencia:


Negocio: bvc


17. BUY_PART_FILL: Número de órdenes de compra en estado “PART_FILL”.

18. SELL_PART_FILL: Número de órdenes de venta en estado “PART_FILL”.

19. BUY_FILL: Número de órdenes de compra en estado “FILL”.

20. SELL_FILL: Número de órdenes de venta en estado “FILL”.

21. DONE_DAY: No aplica.

22. CANC: Número de órdenes en estado “CANC”.

23. STOP: Número de órdenes en estado “STOP”.

24. REJC: Número de órdenes en estado “REJC”.

25. SUSP: Número de órdenes en estado “SUSP”.

26. PEND_NEW: Número de órdenes en estado “PEND_NEW”.

27. CALC: No aplica.

28. EXPR: No aplica.

29. ACCP_BID: No aplica.

30. WAIT: Número de órdenes en estado “WAIT”.

31. HELD: Número de órdenes en estado “HELD”.

A continuación, se presenta un ejemplo de la sintaxis requerida para visualización de posiciones,

sobre diferentes títulos y ruedas.



Versión: 1.0

Fecha de vigencia:


Negocio: bvc


Resultado: Error/ Número de filas de salida.

7.1.23 VtFilterRange

A partir de un rango seleccionado, permite realizar un filtro de datos igual al presentado en la

función de filtro avanzado de Excel.

VtFilterRange(From, Criteria, Copy, NameRange)

Parámetros

● From: Rango a filtrar, la primera fila de este rango debe contener los nombres de los parámetros

del rango de datos. A continuación se presenta un ejemplo del rango:

● Criteria: Rango de criterios a usar, el número de columnas dependerá del número de criterios a

filtrar, mientras que el número de filas dependerá de las condiciones requeridas en el rango de

salida, ya sean de tipo Y/O (Ver filtro avanzado de Excel). La primera fila de este rango debe

contener los nombres de los parámetros a filtrar.

Ejemplo 1: Al seleccionar este rango, se filtran los campos del rango de datos a filtrar, donde las

columnas correspondientes a SIDE sean igual a BUY, ó que el campo CumQty sea mayor a 0.

Ejemplo 2: Al seleccionar este rango, se filtran los campos del rango de datos a filtrar, donde las

columnas correspondientes a LeavesQty sean mayores a 0, y que el campo CumQty sea mayor a 0.



Versión: 1.0

Fecha de vigencia:


Negocio: bvc


● Copy: Primera fila del rango de salida de la información filtrada. Necesita sólo de los encabezados,

correspondientes a los nombres de las columnas sobre las que se quieren extraer los datos. El

tamaño de este rango es de una fila por el número de columnas sobre el que se requiriera extraer

la información, como se observa a continuación:

● NameRange: Nombre de rango de salida del filtro.

A continuación, se presenta un ejemplo de un filtro para un rango en el cual la columna LeavesQty

o la columna CumQty contengan valores mayores a 0. Del rango de datos a filtrar se extraen las

columnas; Mkt, Symbol, User, CIOrdId, Side, LeavesQty, CumQty, OrdId y Price.

Nota: Para este caso los campos LeavesQty y CumQty, con columnas del rango del cual se quiere

filtrar la información, es decir, el rango “OrdShtRng” en este caso.

Resultado: Error/Número de filas filtradas.

7.1.24 VtGetSummary

Esta función permite obtener en un rango determinado un resumen de las negociaciones

realizadas en el mercado, agregado con base en una unidad de tiempo.

VtGetSummary (RangeName,Time,Market,Symbol,Fields, OutputRange)

Parámetros



Versión: 1.0

Fecha de vigencia:


Negocio: bvc


● RangeName: Nombre del rango en el que se escribe la salida incluyendo todas las filas escritas y el

encabezado.

● Time: Número de segundos que transcurren para agregar una nueva línea de las negociaciones

realizadas, cada vez que se cumpla este número de segundos se generará una línea nueva en el

resultado de la función. De 1 a 86400. 86400 debe ser divisible por el tiempo dado.


● Symbol:Corresponde al Nemotécnico del título (TFIT16240724, TUVT11070525,…).

● Fields: Corresponde a un rango de 1 fila y múltiples columnas que deben contener el nombre de

los campos requeridos de la difusión (array), estos campos pueden ser:

● TrdPhase: Fase de negociación

TOTAL

○ TotNumTrades: Número de operaciones realizadas a lo largo de la jornada de negociación.

○ TotVolume: Volumen negociado a lo largo de la jornada de negociación.

○ TotTurnover: Efectivo negociado a lo largo de la jornada de negociación.

○ TotAvg: Precio promedio ponderado por la cantidad negociada a lo largo de la jornada de

negociación.

PERIOD

○ PerNumTrades: Número de operaciones realizadas durante el rango de tiempo establecido.

○ PerVolume: Cantidad negociada durante el rango de tiempo establecido.

○ PerTurnover: Efectivo negociado durante el rango de tiempo establecido.

○ PerAvg: Precio promedio ponderado por cantidad, generado durante el rango de tiempo

establecido.

○ PerFirstPx: Primer precio negociado durante el rango de tiempo establecido.

○ PerLastPx: Último precio negociado durante el rango de tiempo establecido.

○ PerMinPx: Precio mínimo negociado durante el rango de tiempo establecido.

○ PerMaxPx: Precio máximo negociado durante el rango de tiempo establecido.

BUY

○ BuyNumTrades: Número de las operaciones generadas por órdenes agresoras de compra, durante

el rango de tiempo establecido.

○ BuyVolume: Volumen en cantidad generado por las órdenes agresoras de compra durante el rango

de tiempo establecido.

○ BuyTurnover: Volumen en efectivo generado por las órdenes agresoras de compra durante el

rango de tiempo establecido.



Versión: 1.0

Fecha de vigencia:


Negocio: bvc


○ BuyAvg: Precio Promedio ponderado por cantidad, de las órdenes agresoras de compra durante el


SELL

○ SellNumTrades: Número de las operaciones generadas por órdenes agresoras de venta, durante el


○ SellVolume: Volumen en cantidad generado por las órdenes agresoras de venta durante el rango


○ SellTurnover: Volumen en efectivo generado por las órdenes agresoras de venta durante el rango


○ SellAvg: Precio Promedio ponderado por cantidad, de las órdenes agresoras de venta durante el


● OutputRange: Corresponde al rango de celdas a rellenar, debe ser una fila y el número de

columnas debe ser el número de campos seleccionado más dos columnas (start/end).

● A continuación, se presenta un ejemplo de la sintaxis requerida para el uso de la función, así como

el resultado esperado.

● El resultado de las columnas “BuyNumTrades”, “BuyVolume”, “BuyTurnover”, “BuyAvg”,

“SellNumTrades”, “SellVolume”, “SellTurnover”, “SellAvg” contempla un algoritmo que con base

en los precios de la profundidad de mercado, busca indicar de manera aproximada la dirección de

la punta agresora en las operaciones realizadas durante el intervalo de tiempo definido. Si bien el

algoritmo no indica en su totalidad el sentido de las órdenes agresoras de manera acertada, este

funciona como un indicador aproximado de la dirección del mercado.



Versión: 1.0

Fecha de vigencia:


Negocio: bvc


Nota: Ante la anulación de una operación, en los campos de periodo de la función VTGetSummary

refleja la información correspondiente a la primera operación realizada en el día.

Resultado: Error/Número de filas de salida.

Código Versión: MANUAL DE USUARIO APLICACIÓN PATS Fecha …€¦ · El presente manual está...

Documents

Transcript of Código Versión: MANUAL DE USUARIO APLICACIÓN PATS Fecha …€¦ · El presente manual está...