Sintéticos

Llamadas relacionadas a las sintéticos de un usuario.

Obtener sintéticos de un usuario

GET https://api-qa.tiendabroker.com/v1/retail/synthetic

Devuelve todas las órdenes de un usuario paginadas. Acepta filtros por query.

Query Parameters

Name
Type
Description

page

String

página

limit

String

líimite por página

status

String

estado de orden

from

String

fecha en formato ISO

to

String

fecha en formato ISO

type

String

tipo de sintético. Acepta DOLAR_MEP o FIXED_DOLAR_MEP.

Headers

Name
Type
Description

tb-api-key*

String

API Key de la compañía

{
    "totalCount": 2,
    "pageCount": 1,
    "pageSize": 1,
    "page": 1,
    "lastPage": 2,
    "data": [
        {
            "id": "654e8e2bebecec56487a6da6",
            "userId": "654e853bebecec56487a6af0",
            "status": "COMPLETED",
            "type": "FIXED_DOLAR_MEP",
            "details": {
                "side": "BUY",
                "amount": 10000,
                "operatedAmount": 9833.54
            },
            "currentStage": 2,
            "stages": {
                "1": {
                    "executionTime": "2023-11-10T17:10:19.472-03:00",
                    "side": "BUY",
                    "type": "MARKET",
                    "asset": "AL30",
                    "against": "ARS",
                    "amount": 44,
                    "price": 22291,
                    "settlement": "INSTANT",
                    "feeInfo": {
                        "platformFee": "0.0025",
                        "marketRight": "0.0001",
                        "usesIva": false,
                        "totalFee": "0.0026000000"
                    },
                    "orderId": "654e8e2bebecec56487a6dae"
                },
                "2": {
                    "executionTime": "2023-11-09T13:39:11.125-03:00",
                    "side": "SELL",
                    "type": "MARKET",
                    "asset": "AL30",
                    "against": "USD",
                    "amount": 44,
                    "price": 22.41,
                    "settlement": "INSTANT",
                    "feeInfo": {
                        "platformFee": "0.0025",
                        "marketRight": "0.0001",
                        "usesIva": false,
                        "totalFee": "0.0026000000"
                    },
                    "orderId": "654e8e34ebecec56487a6df2"
                }
            },
            "fee": 0.0052,
            "creationTime": "2023-11-10T17:10:19.474-03:00"
        }
    ]
}

Obtener un sintético por ID

GET https://api-qa.tiendabroker.com/v1/retail/synthetic/{syntheticId}

Devuelve un sintético por ID.

Path Parameters

Name
Type
Description

syntheticId*

String

Id de un sintético

Headers

Name
Type
Description

tb-api-key*

String

API Key de la compañía

{
    "id": "654e8e2bebecec56487a6da6",
    "userId": "654e853bebecec56487a6af0",
    "status": "COMPLETED",
    "type": "FIXED_DOLAR_MEP",
    "details": {
        "side": "BUY",
        "amount": 10000,
        "operatedAmount": 9833.54
    },
    "currentStage": 2,
    "stages": {
        "1": {
            "executionTime": "2023-11-10T17:10:19.472-03:00",
            "side": "BUY",
            "type": "MARKET",
            "asset": "AL30",
            "against": "ARS",
            "amount": 44,
            "price": 22291,
            "settlement": "INSTANT",
            "feeInfo": {
                "platformFee": "0.0025",
                "marketRight": "0.0001",
                "usesIva": false,
                "totalFee": "0.0026000000"
            },
            "orderId": "654e8e2bebecec56487a6dae"
        },
        "2": {
            "executionTime": "2023-11-09T13:39:11.125-03:00",
            "side": "SELL",
            "type": "MARKET",
            "asset": "AL30",
            "against": "USD",
            "amount": 44,
            "price": 22.41,
            "settlement": "INSTANT",
            "feeInfo": {
                "platformFee": "0.0025",
                "marketRight": "0.0001",
                "usesIva": false,
                "totalFee": "0.0026000000"
            },
            "orderId": "654e8e34ebecec56487a6df2"
        }
    },
    "fee": 0.0052,
    "creationTime": "2023-11-10T17:10:19.474-03:00"
}

Pausar un sintético

POST https://api-qa.tiendabroker.com/v1/retail/synthetic/{syntheticId}

Pausa un sintético. Evita la ejecución de los stages restantes al momento de la pausa.

Path Parameters

Name
Type
Description

syntheticId*

String

Id del sintético a pausar

Headers

Name
Type
Description

tb-api-key*

String

API Key de la compañía

Reanudar un sintético

POST https://api-qa.tiendabroker.com/v1/retail/synthetic/{syntheticId}

Reanuda un sintético que se encuentra pausado.

Path Parameters

Name
Type
Description

syntheticId*

String

Id del sintético a reanudar

Headers

Name
Type
Description

tb-api-key*

String

API Key de la compañía

Cancelar un sintético por ID

DELETE https://api-qa.tiendabroker.com/v1/retail/synthetic/{syntheticId}

Cancela un sintético por ID. Sólo es posible cancelar un sintético si se encuentra en los statuses WAITING o PAUSED.

Path Parameters

Name
Type
Description

syntheticId*

String

Id de una orden

Headers

Name
Type
Description

tb-api-key*

String

API Key de la compañía

Last updated