Skip to content

Latest commit

 

History

History
113 lines (66 loc) · 2.91 KB

README.md

File metadata and controls

113 lines (66 loc) · 2.91 KB
Raw

Documentación phpRofex

phpRofex es una librería de PHP que permite interacciones con las API Rest de Matba Rofex.

La librería está diseñada para evitar a los desarrolladores las horas de investigación y codificación necesarias para conectarse con las API de ROFEX, de modo que puedan concentrarse en la parte importante de su software.

Puede leer la documentación oficial de la API para familiarizarse con las respuestas y la funcionalidad de la API en https://apihub.primary.com.ar/

Instalación

git clone https://github.com/stndc/phpRofex.git

Dentro de phpRofex instalar Composer.

composer install

Credenciales API

Para usar la librería, debe tener las credenciales de autenticación correctas para el entorno.

Para obtener nuevas credenciales vaya al sitio web de Remarket y cree una cuenta de forma gratuita.

Póngase en contacto con el equipo de MPI (Market and Platform Integration), [email protected]

Método

El método retorna un diccionario JSON.

  • get_marketdata($url): obtiene Segementos, Instrumentos, Órdenes y Market Data.

Modo de uso

La inicialización se debe realizar en dos pasos. En el primer paso se autentifica con el servidor de Matba Rofex por medio de usuario y contraseña. El segundo paso es pasar los datos que necesita obtener al método get_marketdata($url) en su parámetro $url.

Si la autenticación falla, la propiedad status del callback será “ERROR”.

<?php

namespace Api;

require __DIR__ . '/vendor/autoload.php';

use Api\ApiRofex;

$rofex = new ApiRofex('X-Username','X-password');

Ejemplo

<?php

namespace Api;

require __DIR__ . '/vendor/autoload.php';

use Api\ApiRofex;

$rofex = new ApiRofex('XXXXXXXXXXX','XXXXXXXXXXX');

$instruments = $rofex->get_marketdata('https://api.remarkets.primary.com.ar/rest/instruments/all');

var_dump($instruments);

Importante:

Es necesario que lea la documentación para obtener los datos que necesite y ajustarlos al parámetro $url dentro del método get_marketdata.

Lista de Segmentos disponibles

$segment = $rofex->get_marketdata('https://api.remarkets.primary.com.ar/rest/segment/all');

var_dump($segment);

Lista de Instrumentos disponibles

$instruments = $rofex->get_marketdata('https://api.remarkets.primary.com.ar/rest/instruments/all');

var_dump($instruments);

Lista detallada de Instrumentos disponibles

$instrument_details = $rofex->get_marketdata('https://api.remarkets.primary.com.ar/rest/instruments/details');

var_dump($instrument_details);

Consultar último estado por Client Order ID

$order_id = $rofex->get_marketdata('https://api.remarkets.primary.com.ar/rest/order/id');

var_dump($order_id);

Consultar todos los estados por Client Order ID

$order_status = $rofex->get_marketdata('https://api.remarkets.primary.com.ar/rest/order/allById');

var_dump($order_status);