Comercios
Obtener el saldo cripto
Obtén los saldos de la billetera de criptomonedas de un comercio específico u obtén los totales agregados de todos los comercios vinculados a tu clave de API.
GET
/
v2
/
assets
/
account
/
assets
Obtener el saldo cripto
curl --request GET \
--url https://api-test.velafi.com/v2/assets/account/assets \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/assets/account/assets"
headers = {"X-BH-TOKEN": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-BH-TOKEN': '<api-key>'}};
fetch('https://api-test.velafi.com/v2/assets/account/assets', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.get("https://api-test.velafi.com/v2/assets/account/assets")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"canDeposit": true,
"balances": [
{
"asset": "<string>",
"assetId": "<string>",
"assetName": "<string>",
"total": "<string>",
"free": "<string>",
"locked": "<string>"
}
]
}
}Usa este endpoint para consultar los saldos de activos cripto que se guardan en la billetera de custodia de un comercio. Envía un
merchantId específico para limitar los resultados a un solo comercio, o envía 0 para recibir los totales agregados de todos los comercios vinculados a tu clave de API. Cada activo muestra el saldo total, la parte libre (disponible) y cualquier monto bloqueado (reservado para órdenes pendientes).
Todas las solicitudes deben incluir el header
X-BH-TOKEN con un token de negocio de GET /v2/token/generate.Endpoint
GET https://api.velafi.com/v2/assets/account/assets
Parámetros de consulta
integer
requerido
El ID del comercio que se va a consultar. Envía
0 para agregar los saldos de todos los comercios vinculados a esta clave de API.Campos de la respuesta
number
Código de respuesta de tipo HTTP.
200 indica éxito.string
Mensaje de estado legible, por ejemplo
SUCCESS.object
Mostrar campos de data
Mostrar campos de data
boolean
Indica si la cuenta puede recibir depósitos cripto en este momento.
array
Mostrar campos de cada elemento de balances
Mostrar campos de cada elemento de balances
string
Símbolo del activo, por ejemplo
USDT, BTC, USDC.string
Identificador interno del activo.
string
Nombre legible del activo para mostrar.
string
Saldo total que se tiene en este activo.
string
Saldo disponible no reservado para órdenes pendientes.
string
Saldo reservado para órdenes abiertas o en curso.
Ejemplos
- Comercio específico
- Agregado (todos los comercios)
cURL
curl -G https://api.velafi.com/v2/assets/account/assets \
-H "X-BH-TOKEN: YOUR_TOKEN" \
--data-urlencode "merchantId=12345"
Response
{
"code": 200,
"msg": "SUCCESS",
"data": {
"canDeposit": true,
"balances": [
{
"asset": "USDT",
"assetId": "USDT",
"assetName": "USDT",
"total": "1000",
"free": "800",
"locked": "200"
},
{
"asset": "BTC",
"assetId": "BTC",
"assetName": "BTC",
"total": "0.5",
"free": "0.3",
"locked": "0.2"
}
]
}
}
cURL
curl -G https://api.velafi.com/v2/assets/account/assets \
-H "X-BH-TOKEN: YOUR_TOKEN" \
--data-urlencode "merchantId=0"
Response
{
"code": 200,
"msg": "SUCCESS",
"data": {
"canDeposit": true,
"balances": [
{
"asset": "USDT",
"assetId": "USDT",
"assetName": "USDT",
"total": "5000",
"free": "4000",
"locked": "1000"
},
{
"asset": "BTC",
"assetId": "BTC",
"assetName": "BTC",
"total": "2",
"free": "1.5",
"locked": "0.5"
}
]
}
}
Cuando
merchantId es 0, la API suma los saldos de todos los comercios vinculados a la misma cuenta. Úsalo para obtener una vista a nivel de portafolio sin recorrer uno por uno los IDs de comercio.⌘I
Obtener el saldo cripto
curl --request GET \
--url https://api-test.velafi.com/v2/assets/account/assets \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/assets/account/assets"
headers = {"X-BH-TOKEN": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-BH-TOKEN': '<api-key>'}};
fetch('https://api-test.velafi.com/v2/assets/account/assets', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.get("https://api-test.velafi.com/v2/assets/account/assets")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"canDeposit": true,
"balances": [
{
"asset": "<string>",
"assetId": "<string>",
"assetName": "<string>",
"total": "<string>",
"free": "<string>",
"locked": "<string>"
}
]
}
}