Ripiotrade - Documentación de la API (v3.8)

Download OpenAPI specification:Download

Bienvenido a la página de detalles de los métodos públicos de la API de Ripio Trade. Las API se dividen en tres categorías: Public, Market y Transfers.

Versión Esta API está en la versión 3.

Importante Usá las API de categoría Market para todas las operaciones comerciales. Las API Public tienen un retraso de actualización de datos de hasta 30 segundos.

Todas las consultas que se ejecutan correctamente devuelven HTTP Status 200. Todas las consultas devuelven contenido JSON (aplicación/json) y tienen cuerpos predeterminados:

Éxito { "message": null, "data": { } }

Falha { "code": [Código de error], "message": "Descripción del error", "data": null }

Los métodos que filtran por fecha filtrarán hasta hace 6 meses si no se envía ningún valor en start_date.

Estructura de la url Las URL de las llamadas se ensamblan de acuerdo con el siguiente ejemplo:

https://api.ripiotrade.co/{version}/public/{moneda}/{método}/ https://api.ripiotrade.co/v3/public/BTC/ticker/

Status de las órdenes - executed_completely: Orden ejecutada completamente - executed_partially: Orden ejecutada parcialmente - waiting: Orden abierta en el mercado en espera de ejecución - canceled: Orden cancelada - pending_creation: Orden esperando en cola para su creación

Límites

Los límites de solicitud se basan en los límites operativos del usuario. Hay dos tipos de límites, uno de solicitudes por segundo y otro de solicitudes diarias. Se deben tener en cuenta ambos límites y equilibrar las solicitudes para que no se alcance el límite diario. Usuarios sin documentación aprobada tienen 1 solicitud por segundo o 86.400 solicitudes diarias. Los usuarios con documentación aprobada tienen 3,5 solicitudes por segundo o 302.400 solicitudes diarias. Los límites superiores se pueden proporcionar con el equipo de soporte. Cuando se alcanza el límite de solicitudes por segundo, el estado de respuesta será 429 y se devolverá la siguiente respuesta: { "message": "Too many requests" } Cuando se alcance el límite de solicitudes por día, el estado de respuesta será 429 y se devolverá la siguiente respuesta: { "message": "Limit Exceeded" }

Authentication

API Token

Token de autenticación generado en la sección API de tu cuenta. Se enviará en la cabecera x-api-key de las llamadas que requieran autenticación. Cada punto final requiere un permiso, que puede ser Read (lectura) o Write (escritura). Para los puntos finales que tienen permiso de Read, se requiere un token de tipo Read o Write, y para los puntos finales que tienen permiso de Write, se requiere un token de tipo Write.

Security Scheme Type API Key
Header parameter name: x-api-key

Changelog

v3.1 - 20/10/2020 ### Última actualización de saldo

GET /v3/wallets/balance: Se agregó un nuevo campo last_update con la última actualización en la lista de saldos de billetera del usuario. ### Códigos de error detallados Se agregaron códigos de detalle de errores de parámetros no válidos. ## v3.2 - 18/08/2021 ### Eliminación de propriedad id La propiedad id se eliminó de todos los objetos devueltos por la API. En todos los puntos finales donde se necesitaba id, ahora se debe usar code. ### Cambio de propiedad del código de pedido GET /v3/user_orders/list: La propiedad del código de pedido cambió de order_code a code. ### Eliminación de propiedades de la devolución de creación de pedidos POST /v3/market/create_order: Todas las propiedades, excepto code, se han eliminado de la devolución de creación de pedidos. El 'id' era la única propiedad necesaria antes, ahora ha sido reemplazado por el 'code', las otras propiedades eliminadas eran datos relacionados con la solicitud. ### Eliminación de identificación de cancelación de pedido DELETE /v3/market/user_orders: El id ha sido reemplazado por el code en la solicitud de cancelación del pedido. ### Cambio de propiedad de par en la respuesta de cancelación de pedido DELETE /v3/market/user_orders: La propiedad del par en la devolución de la cancelación del pedido cambió de pair_code a pair. ## v3.3 - 25/10/2021

Inclusión de la propiedad address

GET /v3/wallets/balance: Se agregó un nuevo campo address con la dirección de la billetera (solo válido para criptomonedas). ### Inclusión de la propiedad memo GET /v3/wallets/balance: Se agregó un nuevo campo memo con nota de dirección (solo válido para EOS). ### Inclusión de la propiedad tag GET /v3/wallets/balance: Se agregó un nuevo campo tag con etiqueta de dirección (solo válido para XRP). ## v3.4 - 29/11/2021

Creación del punto final de listado de monedas

GET /v3/public/currencies: Se creó un nuevo punto final para enumerar las monedas disponibles en la plataforma. ### Creación del punto final de la lista de pares de divisas GET /v3/public/pairs: Se creó un nuevo punto final para enumerar los pares de divisas disponibles en la plataforma. ### IInclusión de propiedades base y quote GET /v3/market/summary: Se agregaron nuevos campos base y quote que devuelven el par de divisas de cada elemento. ## v3.5 - 11/04/2022

Validación de rango de fechas

Se agregó validación de rango de fechas, donde el rango no puede ser mayor a 6 meses y la fecha de inicio no puede ser menor a 2017-10-01. ## v3.6 - 15/04/2022

Creación del punto final de resumen para todos los pares

GET /v3/public/ticker: Se creó un nuevo punto final para el resumen de todos los pares. ### Creación del punto final de saldos de divisas en una fecha específica GET /v3/wallets/{date}/balance: Se creó un nuevo punto final para enumerar los saldos de divisas en una fecha específica. ### Creación del punto final para extracciones GET /v3/user/statement: Se creó un nuevo punto final de extracción de usuario. ### Creación del punto final del estado de cuenta de moneda GET /v3/user/{currency}/statement: Se creó un nuevo punto final de declaración de usuario por moneda. ### Creación del punto final de operaciones del usuario GET /v3/market/trades: Se creó un nuevo punto final de lista comercial de usuario. ## v3.7 - 06/05/2022

Creación de punto final de orden abierta

GET /v3/market/user_orders/open: Se creó un nuevo punto final para enumerar las órdenes abiertas del usuario.

Errors

El código de error se devuelve en el parámetro code en la carga de respuesta.

400 - Parámetros Inválidos

Código HTTP: 400 Ajustá la solicitud de acuerdo con la documentación o el mensaje de error y vuelva a intentarlo.

401 - No autorizado

Código HTTP: 401 Se requiere autenticación para acceder al recurso.

402 - Token bloqueado

Código HTTP: 401 Contactá a soporte para recuperar el acceso.

403 - Acesso Proibido

Código HTTP: 403 Recurso fuera del alcance del usuario.

404 - No encontrado

Código HTTP: 400 Verificá la dirección de la solicitud.

405 - Error al recuperar los datos

Código HTTP: 400 Volvé a intentarlo y si el error continúa, contactá a soporte

429 - Límite de solicitudes excedido

Código HTTP: 429 Esperá para intentar nuevamente.

500 - Error al procesar la solicitud

Código HTTP: 500 Volvé a intentarlo y si el error continúa, contactá a soporte.

502 - Error de comunicación

Código HTTP: 500 Volvé a intentarlo y si el error continúa, contactá a soporte.

503 - Mantenimiento

Código HTTP: 503 Esperá para intentar nuevamente.

Public

Las llamadas públicas tienen un límite de solicitud reducido y un caché de 30 segundos. Para límites más grandes, usá métodos privados.

Ticker

Devuelve información con el resumen de las últimas 24 horas de negociaciones

path Parameters
pair
required
string (PairCodeParam)
Example: USDCBTC

Código del par de monedas

Responses

Response Schema: application/json
message
required
string or null
required
object (TickersResponseDataV3)

Response samples

Content type
application/json
{
  • "message": null,
  • "data": {
    • "high": 15999.12,
    • "low": 15000.12,
    • "volume": 123.12345678,
    • "trades_quantity": 123,
    • "last": 15500.12,
    • "buy": 15400.12,
    • "sell": 15600.12,
    • "date": "2017-10-20T00:00:00Z"
    }
}

Ticker - All Currency Pairs

Devuelve información con el resumen de las últimas 24 horas de operaciones para todos los pares

Responses

Response Schema: application/json
message
required
string or null
required
Array of objects (AllTickersResponseDataV3) [ items ]

Response samples

Content type
application/json
{
  • "message": null,
  • "data": [
    • {
      • "pair": "USDCBTC",
      • "high": 15999.12,
      • "low": 15000.12,
      • "volume": 123.12345678,
      • "trades_quantity": 123,
      • "last": 15500.12,
      • "buy": 15400.12,
      • "sell": 15600.12,
      • "date": "2017-10-20T00:00:00Z"
      }
    ]
}

Orders

Devuelve la lista de órdenes actualmente activas en el libro de ofertas

path Parameters
pair
required
string (PairCodeParam)
Example: USDCBTC

Código del par de monedas

query Parameters
limit
number <int32> (LimitParam) [ 1 .. 200 ]
Default: "50"
Example: limit=25

Registros máximos devueltos

Responses

Response Schema: application/json
message
required
string or null
required
object (PublicOrdersResponseData)

Response samples

Content type
application/json
{
  • "message": null,
  • "data": {
    • "bids": [
      • {
        • "unit_price": 14650.25,
        • "code": "B1qRRuFBN",
        • "amount": 0.46097295
        },
      • {
        • "unit_price": 1610.15,
        • "code": "B1dcgFKrE",
        • "amount": 1
        }
      ],
    • "asks": [
      • {
        • "unit_price": 14704.45,
        • "code": "BkmGgYtrV",
        • "amount": 0.01187517
        },
      • {
        • "unit_price": 1873.48,
        • "code": "r1XolYtBN",
        • "amount": 1
        }
      ]
    }
}

Trades

Lista de trades históricos basados en criterios de búsqueda

path Parameters
pair
required
string (PairCodeParam)
Example: USDCBTC

Código del par de monedas

query Parameters
start_time
string <datetime> (StartDateTimeNoMinParam)
Default: "[6 meses atrás]"
Example: start_time=2020-01-01T00:00:00-03:00

Fecha de inicio de la búsqueda en el formato combinado de fecha y hora ISO-8601

end_time
string <datetime> (EndDateTimeNoMinParam)
Default: "[Fecha y hora actual]"
Example: end_time=2020-01-02T23:59:59-03:00

Fecha de finalización de la búsqueda en formato combinado de fecha y hora ISO-8601

page_size
number <int32> (PageSizeParam) [ 1 .. 1000 ]
Default: "200"
Example: page_size=100

Número de registros por página

current_page
number <int32> (CurrentPageParam)
Default: "1"
Example: current_page=3

Página actual

Responses

Response Schema: application/json
message
required
string or null
required
object (TradesResponseDataV3)

Response samples

Content type
application/json
{
  • "message": null,
  • "data": {
    • "trades": [
      • {
        • "type": "sell",
        • "amount": 0.2404764,
        • "unit_price": 15160,
        • "active_order_code": "Bk0fQxsZV",
        • "passive_order_code": "rJEcVyob4",
        • "date": "2019-01-03T02:27:33.947Z"
        },
      • {
        • "type": "sell",
        • "amount": 0.00563617,
        • "unit_price": 15163,
        • "active_order_code": "Bk0fQxsZV",
        • "passive_order_code": "B1cl2ys_4",
        • "date": "2019-01-03T02:27:33.943Z"
        },
      • {
        • "type": "sell",
        • "amount": 0.00680154,
        • "unit_price": 15163.03,
        • "active_order_code": "Bk0fQxsZV",
        • "passive_order_code": "Synrhyj_V",
        • "date": "2019-01-03T02:27:33.940Z"
        }
      ],
    • "pagination": {
      • "total_pages": 1,
      • "current_page": 1,
      • "page_size": 100,
      • "registers_count": 21
      }
    }
}

Currencies

Lista de criptomonedas activas disponibles en la plataforma

query Parameters
currency
string (CurrencyCodeParam)
Example: currency=BTC

Código de la moneda

Responses

Response Schema: application/json
message
required
string or null
required
Array of objects (PublicCurrency) [ items ]

Response samples

Content type
application/json
{
  • "message": null,
  • "data": [
    • {
      • "active": true,
      • "code": "BTC",
      • "id": "string",
      • "min_withdraw_amount": 0,
      • "name": "string",
      • "needs_block_id_for_tx_sync": true,
      • "networks": [
        • {
          • "code": "string",
          • "memo": {
            • "deposit": true,
            • "withdrawal": true
            },
          • "tag": {
            • "deposit": true,
            • "withdrawal": true
            }
          }
        ],
      • "precision": 0
      }
    ]
}

Pairs

Lista de pares de monedas activas disponibles en la plataforma

query Parameters
pair_code
string (PairCodeParam)
Example: pair_code=USDCBTC

Código del par de monedas

Responses

Response Schema: application/json
message
required
string or null
required
Array of objects (PublicPair) [ items ]

Response samples

Content type
application/json
{
  • "message": null,
  • "data": [
    • {
      • "amount_tick": 0,
      • "base": "BTC",
      • "base_name": "string",
      • "quote": "BTC",
      • "quote_name": "string",
      • "symbol": "USDCBTC",
      • "enabled": true,
      • "min_amount": 0,
      • "price_tick": 0,
      • "min_value": 0
      }
    ]
}

Market

Summary

Resumen de operaciones de un par (o de todas, si no se envía el parámetro) en las últimas 24 horas

Authorizations:
API Token (
  • Read
)
query Parameters
pair
string (PairCodeParam)
Example: pair=USDCBTC

Código del par de monedas

Responses

Response Schema: application/json
message
required
string or null
required
Array of objects (SummaryDataV3) [ items ]

Response samples

Content type
application/json
{
  • "message": null,
  • "data": [
    • {
      • "unit_price_24h": 54049,
      • "volume_24h": 0,
      • "last_transaction_unit_price": 54049,
      • "pair": "USDCBTC",
      • "max_price": 54049,
      • "min_price": 54049,
      • "transactions_number": 10,
      • "base": "BTC",
      • "quote": "USDC"
      }
    ]
}

Estimate Price

Estimar el precio unitario de una determinada cantidad de moneda si se ejecutara en el mercado

Authorizations:
API Token (
  • Read
)
query Parameters
pair
required
string (PairCodeParam)
Example: pair=USDCBTC

Código del par de monedas

amount
required
number <double>

Cantidad de moneda utilizada en el cálculo.

type
required
string (OrderTypeParamV3)
Enum: "buy" "sell"

Tipo de orden (compra o venta)

Responses

Response Schema: application/json
message
required
string or null
required
object (EstimatedPriceResponseData)

Response samples

Content type
application/json
{
  • "message": null,
  • "data": {
    • "price": 54049.12
    }
}

Get Book Orders

Órdenes de compra y venta del libro de pedidos

Authorizations:
API Token (
  • Read
)
query Parameters
pair
required
string (PairCodeParam)
Example: pair=USDCBTC

Código del par de monedas

limit
number <int32> (LimitParam) [ 1 .. 200 ]
Default: "50"
Example: limit=25

Registros máximos devueltos

filter_user_orders
boolean <boolean> (FilterUserOrdersParam)
Default: "false"
Example: filter_user_orders=true

Flag para filtrar ordens do usuário (false = ordens do usuário inclusas, false = ordens do usuário não inclusas)

Responses

Response Schema: application/json
message
required
string or null
required
object (OrdersDataV3)

Response samples

Content type
application/json
{
  • "message": null,
  • "data": {
    • "buying": [
      • {
        • "unit_price": 54049,
        • "code": "BypTSfJSz",
        • "user_code": "H1u6_cuGM",
        • "amount": 0.02055746
        }
      ],
    • "selling": [
      • {
        • "unit_price": 1923847,
        • "code": "IasDflk",
        • "user_code": "H1u6_cuGM",
        • "amount": 0.1283746
        }
      ],
    • "executed": [
      • {
        • "create_date": "2018-01-23T00:20:27.71Z",
        • "amount": 0.02055746,
        • "unit_price": 54049,
        • "type": "buy",
        • "pair_code": "USDCBTC",
        • "active_order_code": "SJ40k_NSM",
        • "active_order_user_code": "HkUrRQIxM",
        • "passive_order_code": "ByKNLGySz",
        • "passive_order_user_code": "H1u6_cuGM"
        }
      ]
    }
}

Get User Orders

Listado de órdenes de usuario

Authorizations:
API Token (
  • Read
)
query Parameters
pair
required
string (PairCodeParam)
Example: pair=USDCBTC

Código del par de monedas

status
Array of strings (OrderStatusParamV3)
Items Enum: "executed_completely" "executed_partially" "waiting" "canceled" "pending_creation"
type
string (OrderTypeParamV3)
Enum: "buy" "sell"

Tipo de orden (compra o venta)

subtype
string (OrderSubtypeParam)
Enum: "limited" "market"

Subtipo de orden (limitada o de mercado)

order_code
string (OrderCodeParam)

Código de orden (se ignoran otros parámetros)

start_date
string <date> (StartDateParam)
Default: "[6 meses atrás]"

Fecha de inicio de la búsqueda en el formato fecha ISO-8601 (la fecha de inicio no debe ser inferior a 2017-10-01)

end_date
string <date> (EndDateParam)
Default: "[Día actual]"

Data final da pesquisa no formato data ISO-8601 (o intervalo entre a data inicial e a data final não deve ser maior que 6 meses)

page_size
number <int32> (PageSizeParam) [ 1 .. 1000 ]
Default: "200"
Example: page_size=100

Número de registros por página

current_page
number <int32> (CurrentPageParam)
Default: "1"
Example: current_page=3

Página actual

Responses

Response Schema: application/json
message
required
string or null
required
object (UserOrdersDataV3)

Response samples

Content type
application/json
{
  • "message": null,
  • "data": {
    • "orders": [
      • {
        • "code": "SkvtQoOZf",
        • "type": "buy",
        • "subtype": "limited",
        • "requested_amount": 0.02347418,
        • "remaining_amount": 0,
        • "unit_price": 42600,
        • "status": "executed_completely",
        • "create_date": "2017-12-08T23:42:54.960Z",
        • "update_date": "2017-12-13T21:48:48.817Z",
        • "pair": "USDCBTC",
        • "total_price": 1000,
        • "executed_amount": 0.02347418,
        • "remaining_price": 0
        },
      • {
        • "code": "SyYpGa8p_",
        • "type": "buy",
        • "subtype": "market",
        • "requested_amount": 0.00033518,
        • "remaining_amount": 0,
        • "unit_price": 16352.12,
        • "status": "executed_completely",
        • "create_date": "2017-10-20T00:26:40.403Z",
        • "update_date": "2017-10-20T00:26:40.467Z",
        • "pair": "USDCBTC",
        • "total_price": 5.48090358,
        • "executed_amount": 0.00033518,
        • "remaining_price": 0
        }
      ],
    • "pagination": {
      • "total_pages": 1,
      • "current_page": 1,
      • "page_size": 100,
      • "registers_count": 21
      }
    }
}

Get User Open Orders

Lista de órdenes abiertas de usuario

Authorizations:
API Token (
  • Read
)
query Parameters
pair
string (PairCodeParam)
Example: pair=USDCBTC

Código del par de monedas

type
string (OrderTypeParamV3)
Enum: "buy" "sell"

Tipo de orden (compra o venta)

subtype
string (OrderSubtypeParam)
Enum: "limited" "market"

Subtipo de orden (limitada o de mercado)

start_date
string <date> (StartDateNoMinParam)
Default: "[6 meses atrás]"

Fecha de inicio en formato de fecha ISO-8601

end_date
string <date> (EndDateNoMinParam)
Default: "[Día actual]"

Fecha de finalización de la encuesta en formato de fecha ISO-8601

page_size
number <int32> (PageSizeParam) [ 1 .. 1000 ]
Default: "200"
Example: page_size=100

Número de registros por página

current_page
number <int32> (CurrentPageParam)
Default: "1"
Example: current_page=3

Página actual

Responses

Response Schema: application/json
message
required
string or null
required
object (UserOpenOrdersDataV3)

Response samples

Content type
application/json
{
  • "message": null,
  • "data": {
    • "orders": [
      • {
        • "code": "SkvtQoOZf",
        • "type": "buy",
        • "subtype": "limited",
        • "requested_amount": 0.02347418,
        • "remaining_amount": 0.02347418,
        • "unit_price": 42600,
        • "status": "waiting",
        • "create_date": "2017-12-08T23:42:54.960Z",
        • "update_date": "2017-12-13T21:48:48.817Z",
        • "pair": "USDCBTC",
        • "total_price": 1000,
        • "executed_amount": 0,
        • "remaining_price": 0
        },
      • {
        • "code": "SyYpGa8p_",
        • "type": "buy",
        • "subtype": "limited",
        • "requested_amount": 0.00033518,
        • "remaining_amount": 0.00033518,
        • "unit_price": 16352.12,
        • "status": "waiting",
        • "create_date": "2017-10-20T00:26:40.403Z",
        • "update_date": "2017-10-20T00:26:40.467Z",
        • "pair": "USDCBTC",
        • "total_price": 5.48090358,
        • "executed_amount": 0,
        • "remaining_price": 0
        }
      ],
    • "pagination": {
      • "total_pages": 1,
      • "current_page": 1,
      • "page_size": 100,
      • "registers_count": 21
      }
    }
}

User Order by Code

Detalles de una orden de usuario

Authorizations:
API Token (
  • Read
)
path Parameters
code
required
string (OrderCodeParam)

Código de orden (se ignoran otros parámetros)

Responses

Response Schema: application/json
message
required
string or null
required
object (UserPreparedOrderWithExecutionsV3)

Response samples

Content type
application/json
{
  • "message": null,
  • "data": {
    • "code": "SkvtQoOZf",
    • "type": "buy",
    • "subtype": "limited",
    • "requested_amount": 0.02347418,
    • "remaining_amount": 0,
    • "unit_price": 42600,
    • "status": "executed_completely",
    • "create_date": "2017-12-08T23:42:54.960Z",
    • "update_date": "2017-12-13T21:48:48.817Z",
    • "pair": "USDCBTC",
    • "total_price": 1000,
    • "executed_amount": 0.02347418,
    • "remaining_price": 0,
    • "transactions": [
      • {
        • "amount": 0.2,
        • "create_date": "2020-02-21 20:24:43.433",
        • "fee": 0.1,
        • "fee_currency": "BTC",
        • "total_price": 1000,
        • "unit_price": 5000
        },
      • {
        • "amount": 0.2,
        • "create_date": "2020-02-21 20:49:37.450",
        • "fee": 0.1,
        • "fee_currency": "BTC",
        • "total_price": 1000,
        • "unit_price": 5000
        }
      ]
    }
}

Create Order

Crear una orden de compra o venta

Authorizations:
API Token (
  • Write
)
Request Body schema: application/json
unit_price
required
number <double>

Precio unitario de la moneda.

amount
required
number <float>

Cantidad de moneda que desea comprar o vender

subtype
required
string (OrderSubtypeParam)
Enum: "limited" "market"

Subtipo de orden (limitada o de mercado)

type
required
string (OrderTypeParamV3)
Enum: "buy" "sell"

Tipo de orden (compra o venta)

pair
required
string (PairCodeParam)

Código del par de monedas

Responses

Response Schema: application/json
message
required
string or null
required
object (UserOrderOutputV3)

Request samples

Content type
application/json
{
  • "unit_price": 14500,
  • "amount": 0.5,
  • "subtype": "limited",
  • "type": "buy",
  • "pair": "USDCBTC"
}

Response samples

Content type
application/json
{
  • "message": null,
  • "data": {
    • "code": "string"
    }
}

Cancel Order

Cancela una orden activa

Authorizations:
API Token (
  • Write
)
Request Body schema: application/json
code
required
string

Código de la orden

Responses

Response Schema: application/json
message
required
string or null
required
object (OrderResponseV3)

Request samples

Content type
application/json
{
  • "code": null
}

Response samples

Content type
application/json
{
  • "message": null,
  • "data": {
    • "code": "string",
    • "create_date": "string",
    • "executed_amount": 0,
    • "pair": "USDCBTC",
    • "remaining_amount": 0,
    • "remaining_price": 0,
    • "requested_amount": 0,
    • "status": "string",
    • "subtype": "string",
    • "total_price": 0,
    • "type": "string",
    • "unit_price": 0,
    • "update_date": "string"
    }
}

Get User Trades

Lista de operaciones de usuario

Authorizations:
API Token (
  • Read
)
query Parameters
pair
string (PairCodeParam)
Example: pair=USDCBTC

Código del par de monedas

start_date
string <date> (StartDateNoMinParam)
Default: "[6 meses atrás]"

Fecha de inicio en formato de fecha ISO-8601

end_date
string <date> (EndDateNoMinParam)
Default: "[Día actual]"

Fecha de finalización de la encuesta en formato de fecha ISO-8601

page_size
number <int32> (PageSizeParam) [ 1 .. 1000 ]
Default: "200"
Example: page_size=100

Número de registros por página

current_page
number <int32> (CurrentPageParam)
Default: "1"
Example: current_page=3

Página actual

Responses

Response Schema: application/json
message
required
string or null
required
object (UserTradesDataV3)

Response samples

Content type
application/json
{
  • "message": null,
  • "data": {
    • "trades": [
      • {
        • "amount": 0.00270754,
        • "unit_price": 18550,
        • "total_price": 50.22,
        • "date": "2019-04-02T11:22:22.403Z",
        • "type": "sell",
        • "subtype": "market",
        • "fee": 0.25,
        • "fee_currency": "USDC",
        • "pair_code": "USDCBTC"
        },
      • {
        • "amount": 0.0026938,
        • "unit_price": 18550,
        • "total_price": 49.96,
        • "date": "2019-04-02T11:25:41.512Z",
        • "type": "buy",
        • "subtype": "market",
        • "fee": 0.00001347,
        • "fee_currency": "BTC",
        • "pair_code": "USDCBTC"
        }
      ],
    • "pagination": {
      • "total_pages": 1,
      • "current_page": 1,
      • "page_size": 100,
      • "registers_count": 21
      }
    }
}

Transfers

API para enviar y recibir criptomonedas.

Withdraw Fee Estimate

Tasa de minería estimada por el retiro de criptomonedas

Authorizations:
API Token (
  • Read
)
path Parameters
currency
required
string (CryptocurrencyNameParam)
Example: bitcoin

Nombre de la criptomoneda

query Parameters
network
string (NetworkParam)

Red utilizada

Responses

Response Schema: application/json
message
required
string or null
required
Array of objects (WithdrawalFeeData) [ items ]

Response samples

Content type
application/json
{
  • "message": null,
  • "data": [
    • {
      • "name": "regular",
      • "amount": 0.000012
      }
    ]
}

Deposit List

Listado de depósitos de usuarios

Authorizations:
API Token (
  • Read
)
path Parameters
currency
required
string (CryptocurrencyNameParam)
Example: bitcoin

Nombre de la criptomoneda

query Parameters
status
string (DepositStatusParam)
Enum: "confirmation_pending" "confirmed" "canceled"

Estado del depósito

start_date
string <date> (StartDateNoMinParam)
Default: "[6 meses atrás]"

Fecha de inicio en formato de fecha ISO-8601

end_date
string <date> (EndDateNoMinParam)
Default: "[Día actual]"

Fecha de finalización de la encuesta en formato de fecha ISO-8601

page_size
number <int32> (PageSizeParam) [ 1 .. 1000 ]
Default: "200"
Example: page_size=100

Número de registros por página

current_page
number <int32> (CurrentPageParam)
Default: "1"
Example: current_page=3

Página actual

network
string (NetworkParam)

Red utilizada

Responses

Response Schema: application/json
message
required
string or null
required
object (DepositsData)

Response samples

Content type
application/json
{
  • "message": null,
  • "data": {
    • "deposits": [
      • {
        • "code": "SJbLkdTh_",
        • "hash": "4f87d009d88524e627b60c6fbe4ebe671a99lk9ad72aab17e0963c5fbef118e2",
        • "amount": 2.29999999,
        • "status": "confirmed",
        • "create_date": "2017-10-12T22:40:08.273Z",
        • "confirmation_date": "2017-10-12T22:40:08.273Z",
        • "currency_code": "BTC",
        • "is_internal": false
        },
      • {
        • "code": "rkxHPorahb",
        • "hash": "181378774394ec47b9861d9facfcd4d4ea11a447tr82532c654d5ee1306b4857",
        • "amount": 2.29999999,
        • "status": "confirmed",
        • "create_date": "2017-10-12T20:06:52.983Z",
        • "confirmation_date": "2017-10-12T20:06:52.983Z",
        • "currency_code": "BTC",
        • "is_internal": false
        }
      ],
    • "pagination": {
      • "total_pages": 1,
      • "current_page": 1,
      • "page_size": 100,
      • "registers_count": 21
      }
    }
}

Withdrawals List

Listado de retiros de usuarios

Authorizations:
API Token (
  • Read
)
path Parameters
currency
required
string (CryptocurrencyNameParam)
Example: bitcoin

Nombre de la criptomoneda

query Parameters
status
string (WithdrawalStatusParam)
Enum: "pending" "confirmed" "canceled"

Estado de retiro

start_date
string <date> (StartDateNoMinParam)
Default: "[6 meses atrás]"

Fecha de inicio en formato de fecha ISO-8601

end_date
string <date> (EndDateNoMinParam)
Default: "[Día actual]"

Fecha de finalización de la encuesta en formato de fecha ISO-8601

page_size
number <int32> (PageSizeParam) [ 1 .. 1000 ]
Default: "200"
Example: page_size=100

Número de registros por página

current_page
number <int32> (CurrentPageParam)
Default: "1"
Example: current_page=3

Página actual

network
string (NetworkParam)

Red utilizada

Responses

Response Schema: application/json
message
required
string or null
required
object (WithdrawalsData)

Response samples

Content type
application/json
{
  • "message": null,
  • "data": {
    • "withdrawals": [
      • {
        • "code": "HJzpwYDrz",
        • "origin_address": "mpe8FKtvDktBN1FGToFpYN2pdktySxD8wg",
        • "destination_address": "1AU4BoYaxSunkFTTEMYXJ41c9bvQG6Wa2",
        • "amount": 0.0094963,
        • "miner_fee": 0.0005037,
        • "miner_fee_type": "slow",
        • "network": "bitcoin",
        • "tax_index": 0,
        • "tax_index_calculated": 0,
        • "tax_amount": 0,
        • "status": "pending",
        • "create_date": "2018-01-25T16:37:15.443Z",
        • "update_date": "2018-01-25T16:37:15.017Z",
        • "transaction_id": null,
        • "link": null
        },
      • {
        • "code": "HyFhWFDSz",
        • "origin_address": "mpe8FKtvDktBN1FTRoFpYN2pdktySxD8wg",
        • "destination_address": "1AU4BoYaxSunkFRjkEMYXJ41c9bvQG6Wa2",
        • "amount": 0.0094963,
        • "miner_fee": 0.0005037,
        • "miner_fee_type": "slow",
        • "network": "bitcoin",
        • "tax_index": 0,
        • "tax_index_calculated": 0,
        • "tax_amount": 0,
        • "status": "pending",
        • "create_date": "2018-01-25T16:11:30.410Z",
        • "update_date": "2018-01-25T16:11:29.937Z",
        • "transaction_id": null,
        • "link": null
        }
      ],
    • "pagination": {
      • "total_pages": 1,
      • "current_page": 1,
      • "page_size": 100,
      • "registers_count": 21
      }
    }
}

Create Withdrawal

Crear una solicitud de retiro de criptomonedas

Authorizations:
API Token (
  • Write
)
path Parameters
currency
required
string (CryptocurrencyNameParam)
Example: bitcoin

Nombre de la criptomoneda

Request Body schema: application/json
external_id
required
string

External ID to identify the withdraw register

It enables the API users to identify the withdraw created for recovering the register later.

tag
string

Identificador de billetera de destino. ⚠️ Si el retiro es de Ripple y la billetera de destino es una billetera interna de Ripio Trade, este campo se vuelve obligatorio

network
string

Red de destino

memo
string

Identificador de billetera de destino. ⚠️ Si el retiro es de EOS y la billetera de destino es una billetera interna de Ripio Trade, este campo se vuelve obligatorio

fee_type
required
string (FeeTypeParam)
Enum: "fast" "regular" "slow"

Tipo de tasa de minería

amount
required
number <float>

Cantidad de moneda

destination
required
string

Destino del retiro

Responses

Response Schema: application/json
message
required
string or null
required
object (Withdrawal)

Request samples

Content type
application/json
{
  • "external_id": "string",
  • "tag": null,
  • "network": "ethereum",
  • "memo": null,
  • "fee_type": "fast",
  • "amount": 7.77,
  • "destination": "1AU4BoYaxSunkEWikEMYXJ41c9bvQG6Wa2"
}

Response samples

Content type
application/json
{
  • "message": null,
  • "data": {
    • "code": "B1qBrtEBN",
    • "origin_address": "rJhgs18yEFLLSnPa3CwviTo2UDkesdPoSQ",
    • "destination_address": "rw9nf3WgsagJiZnkAeZzXZuqeCQ6LHm2h1",
    • "amount": 0.1,
    • "miner_fee": 0.000012,
    • "miner_fee_type": "regular",
    • "network": "bitcoin",
    • "tax_index": 0,
    • "tax_index_calculated": 0,
    • "tax_amount": 0,
    • "status": "pending",
    • "create_date": "2019-01-25T16:37:15.443Z",
    • "update_date": "2019-01-25T16:37:15.017Z",
    • "transaction_id": null,
    • "link": null,
    • "tag": "0100000020"
    }
}

Synchronize Transaction

Sincronizar una transacción de criptomoneda

Authorizations:
API Token (
  • Write
)
path Parameters
currency
required
string (CryptocurrencyNameParam)
Example: bitcoin

Nombre de la criptomoneda

Request Body schema: application/json
block_id
number <double>

Id del bloque en el que se inserta la transacción. ⚠️ Verifique la información sobre esta moneda en el endpoint público de monedas para ver si requiere un número de bloque para la sincronización de transacciones.

hash
required
string

Hash de la transacción

Responses

Response Schema: application/json
message
required
string or null
data
required
number or null
Value: null

Request samples

Content type
application/json
{
  • "block_id": 123456,
  • "hash": "7b6155e3d010b530f484e0cd05429328a514dd0158dc31c23cdd3ebb59f335ae"
}

Response samples

Content type
application/json
{
  • "message": null,
  • "data": null
}

Wallets

API para verificar direcciones de billetera.

Balance

Lista de saldos de billetera de usuario

Authorizations:
API Token (
  • Read
)

Responses

Response Schema: application/json
message
required
string or null
required
Array of objects (BalanceResponseData) [ items ]

Response samples

Content type
application/json
{
  • "message": null,
  • "data": [
    • {
      • "currency_code": "BTC",
      • "address": "string",
      • "available_amount": 0,
      • "last_update": "string",
      • "locked_amount": 0,
      • "memo": "string",
      • "tag": "string",
      • "supported_networks_for_deposit": [
        • "string"
        ]
      }
    ]
}

Balance On Date

Lista de saldos de billetera del usuario en la fecha especificada

Authorizations:
API Token (
  • Read
)
path Parameters
date
required
string <date> (DateParam)

Fecha de la encuesta, en formato de fecha ISO-8601

Responses

Response Schema: application/json
message
required
string or null
required
Array of objects (BalanceOnDateResponseData) [ items ]

Response samples

Content type
application/json
{
  • "message": null,
  • "data": [
    • {
      • "amount": 5.23423423,
      • "currency_code": "BTC",
      • "last_update": "2020-10-20T18:39:45.198Z"
      },
    • {
      • "amount": 75.31057927,
      • "currency_code": "XRP",
      • "last_update": "2020-10-20T18:39:45.198Z"
      }
    ]
}

User

Statement

Extracto del usuario

Authorizations:
API Token (
  • Read
)
query Parameters
start_time
string <datetime> (StartDateTimeNoMinParam)
Default: "[6 meses atrás]"
Example: start_time=2020-01-01T00:00:00-03:00

Fecha de inicio de la búsqueda en el formato combinado de fecha y hora ISO-8601

end_time
string <datetime> (EndDateTimeNoMinParam)
Default: "[Fecha y hora actual]"
Example: end_time=2020-01-02T23:59:59-03:00

Fecha de finalización de la búsqueda en formato combinado de fecha y hora ISO-8601

page_size
number <int32> (PageSizeParam) [ 1 .. 1000 ]
Default: "200"
Example: page_size=100

Número de registros por página

current_page
number <int32> (CurrentPageParam)
Default: "1"
Example: current_page=3

Página actual

Responses

Response Schema: application/json
message
required
string or null
required
object (UserStatementDataV3)

Response samples

Content type
application/json
{
  • "message": null,
  • "data": {
    • "statement": [
      • {
        • "amount": -0.00000476,
        • "after_balance": 8605.31353851,
        • "currency": "BTC",
        • "date": "2022-01-27T18:16:10.557Z",
        • "operation": "Tax over buy, executed"
        },
      • {
        • "amount": 0.00119048,
        • "after_balance": 8605.31354327,
        • "currency": "BTC",
        • "date": "2022-01-27T18:16:10.557Z",
        • "operation": "Buy"
        }
      ],
    • "pagination": {
      • "total_pages": 1,
      • "current_page": 1,
      • "page_size": 100,
      • "registers_count": 21
      }
    }
}

Statement by Currency

Extracto del usuario por código de moneda

Authorizations:
API Token (
  • Read
)
path Parameters
currency
required
string (CurrencyCodeParam)
Example: BTC

Código de la moneda

query Parameters
start_time
string <datetime> (StartDateTimeNoMinParam)
Default: "[6 meses atrás]"
Example: start_time=2020-01-01T00:00:00-03:00

Fecha de inicio de la búsqueda en el formato combinado de fecha y hora ISO-8601

end_time
string <datetime> (EndDateTimeNoMinParam)
Default: "[Fecha y hora actual]"
Example: end_time=2020-01-02T23:59:59-03:00

Fecha de finalización de la búsqueda en formato combinado de fecha y hora ISO-8601

page_size
number <int32> (PageSizeParam) [ 1 .. 1000 ]
Default: "200"
Example: page_size=100

Número de registros por página

current_page
number <int32> (CurrentPageParam)
Default: "1"
Example: current_page=3

Página actual

Responses

Response Schema: application/json
message
required
string or null
required
object (UserStatementDataV3)

Response samples

Content type
application/json
{
  • "message": null,
  • "data": {
    • "statement": [
      • {
        • "amount": -0.00000476,
        • "after_balance": 8605.31353851,
        • "currency": "BTC",
        • "date": "2022-01-27T18:16:10.557Z",
        • "operation": "Tax over buy, executed"
        },
      • {
        • "amount": 0.00119048,
        • "after_balance": 8605.31354327,
        • "currency": "BTC",
        • "date": "2022-01-27T18:16:10.557Z",
        • "operation": "Buy"
        }
      ],
    • "pagination": {
      • "total_pages": 1,
      • "current_page": 1,
      • "page_size": 100,
      • "registers_count": 21
      }
    }
}