HashCore Docs
API

Referencia de Endpoints

Activación de la garantía del miner. Requiere autorización. Devuelve el estado de la garantía.

Respuesta 200: WarrantyStatus Respuesta 200 (OK): array ApiKeysJsonItem

ParámetroTipo de datosObligatorioDescripción
successbooleanIndicador de éxito de la operación
warrantystring (enum)NoEstado de la garantía. Valores: active — activa; inactive — inactiva; expired — expirada; cancelled — cancelada; not_provided — no proporcionada

Obtención de la lista de API-keys. Requiere autorización. Devuelve un array de claves.

Respuesta 200 (OK): array ApiKeysJsonItem

ParámetroTipo de datosObligatorioDescripción
keystringAPI-key de exactamente 32 caracteres de longitud
descriptionstringDescripción de la clave

Adición de una nueva API-key. Requiere autorización. En el cuerpo de la solicitud se transmite la clave y la descripción (AddApikeyQuery = ApiKeysJsonItem).

Respuesta 200 (OK): AddApiKeyRes

ParámetroTipo de datosObligatorioDescripción
statusstring (enum)Resultado de la operación. Valores: inserted — clave añadida; updated — clave actualizada; nochanges — sin cambios

Eliminación de una API-key. Requiere autorización. En el cuerpo de la solicitud se transmite la clave (DeleteApikeyQuery).

Respuesta 200 (OK): cuerpo ausente (Key deleted successfully).

Verificación de autorización. Devuelve información sobre el tiempo restante hasta el final del bloqueo temporal del dispositivo.

Respuesta 200 (OK): AuthCheck

Si el dispositivo no está en bloqueo temporal, se devuelve un objeto vacío:

{}

Si el dispositivo está en bloqueo temporal, la respuesta incluye el campo unlock_timeout, que contiene el número de segundos restantes hasta el final del bloqueo:

{
  "unlock_timeout":58
}

Nota: la ausencia del campo unlock_timeout es equivalente a un valor null e indica que no hay bloqueo temporal.

ParámetroTipo de datosObligatorioDescripción
unlock_timeoutinteger (int64) | nullNoTiempo de espera de bloqueo (seg), valor no negativo

Obtención de la lista de Presets de Auto-tune. Requiere autorización. Devuelve un array de Presets con la configuración de tuning.

Respuesta 200 (OK): array AutotunePresetDto

ParámetroTipo de datosObligatorioDescripción
namestringIdentificador (id) del Preset
prettystringNombre legible del Preset
statusstring (enum)Estado del Preset. Valores: untuned — no configurado; tuned — configurado con éxito
tune_settingsobject (AutotuneResultsItem) | nullNoResultados del tuning (ver abajo)

Objeto anidado tune_settings ( AutotuneResultsItem ):

ParámetroTipo de datosObligatorioDescripción
hashrateinteger (int32)Hashrate, no negativo
voltinteger (int32)Voltaje, no negativo
freqinteger (int32)Frecuencia, no negativa
chainsarray (AutotuneBoard)Lista de Hashboards: freq (int32), chips (array int32), serial (string | null)
modifiedbooleanIndicador de modificación manual
datestring | nullNoFecha de tuning

Restablecimiento de la lista especificada de perfiles de Auto-tune. Requiere autorización.

Respuesta 200 (OK): cuerpo ausente.

Cuerpo de la solicitud: AutotuneReset

ParámetroTipo de datosObligatorioDescripción
presetsarray of stringLista de Presets para restablecer
restartbooleanReinicio después de eliminar los Presets

Restablecimiento de todos los perfiles de Auto-tune. Requiere autorización.

Respuesta 200 (OK): cuerpo ausente.

Cuerpo de la solicitud: AutotuneResetAll

ParámetroTipo de datosObligatorioDescripción
restartbooleanReinicio después del restablecimiento

Obtención de las Hashboards del miner con detalles de chips y sensores. No requiere autorización.

Respuesta 200 (OK): array AntmBoardChips

ParámetroTipo de datosObligatorioDescripción
idintegerIdentificador de la Hashboard, no negativo
statusobject (CgBoardStatus)Estado de la Hashboard: state (enum), failure_message (string | null)
hr_realtimenumber (float)Hashrate en tiempo real
hr_nominalnumber (float)Hashrate nominal
freqnumber (float)Frecuencia
sensorsarray (AntmChipSensor)Sensores: state, board, chip, loc
chipsarray (AntmChip)Chips (ver abajo)

Objeto anidado status ( CgBoardStatus ):

ParámetroTipo de datosObligatorioDescripción
statestring (enum)Estado de la Hashboard. Valores: initializing, mining, stopped, failure, disconnected, disabled, unknown
failure_messagestring | nullNoDescripción textual del error (normalmente se rellena en caso de failure)

Objeto anidado sensors[] ( AntmChipSensor ) — un elemento del array por cada sensor:

ParámetroTipo de datosObligatorioDescripción
statestring (enum)Estado del sensor. Valores: init, ready, measure, error, unknown
boardinteger (int32)Número de la Hashboard a la que pertenece el sensor
chipinteger (int32)Número del chip al que pertenece el sensor
locinteger (int32)Ubicación del sensor — se refiere a chip.id, no negativo

Objeto anidado del chip AntmChip :

ParámetroTipo de datosObligatorioDescripción
idintegerIdentificador del chip
hrnumber (float)Hashrate
freqinteger (int32)Frecuencia
voltinteger (int32)Voltaje
tempnumber (float)Temperatura
errsinteger (int32)Cantidad de errores
gradestring (enum)Calificación del chip. Valores: grey, orange, red
throttledbooleanIndicador de throttling

Cancelación de la garantía del miner. Requiere autorización.

Respuesta 200 (OK): WarrantyStatus

ParámetroTipo de datosObligatorioDescripción
successbooleanIndicador de éxito de la operación
warrantystring (enum)NoEstado de la garantía. Valores: active, inactive, expired, cancelled, not_provided

Obtención de la información de fábrica de las Hashboards del miner. No requiere autorización.

Respuesta 200 (OK): FactoryInfoReply

ParámetroTipo de datosObligatorioDescripción
chainsarray (FactoryInfoBoard) | nullNoLista de Hashboards con datos de fábrica
has_picsboolean | nullNoPresencia de Controladores PIC
hr_stocknumber (double) | nullNoHashrate de stock
psu_modelstring | nullNoModelo de la PSU
psu_serialstring | nullNoNúmero de serie de la PSU

Objeto anidado: FactoryInfoBoard

ParámetroTipo de datosObligatorioDescripción
idinteger (int32)Identificador de la Hashboard
board_modelstringModelo de la Hashboard
serialstringNúmero de serie
chip_bininteger (int32)Bin de chips
freqinteger (int32)Frecuencia
voltinteger (int32)Voltaje
hashratenumber (double)Hashrate

Eliminación del Firmware y carga del Firmware de stock. Requiere autorización. Después de la operación, el sistema se reiniciará.

Respuesta 200 (OK): RebootAfter

ParámetroTipo de datosObligatorioDescripción
afterinteger (int64)En cuántos segundos se reiniciará el sistema (por defecto 3), no negativo

Cuerpo de la solicitud: FwRemoveParams

ParámetroTipo de datosObligatorioDescripción
remove_stock_logsboolean¿Eliminar los logs de stock?

Actualización del Firmware. Requiere autorización. Después de la actualización, el sistema se reiniciará.

Respuesta 200: RebootAfter

ParámetroTipo de datosObligatorioDescripción
afterinteger (int64)En cuántos segundos se reiniciará el sistema (por defecto 3)

Cuerpo de la solicitud: SchemaFirmwareUpdate (multipart/form-data)

ParámetroTipo de datosObligatorioDescripción
filestring (binary)Archivo de Firmware
keep_settingsstring (enum) | nullNoGuardar configuración. Valores: true, false

Obtención de información general del miner (datos de Firmware + modelo, algoritmo, sistema). No requiere autorización.

Respuesta 200 (OK): InfoJson

ParámetroTipo de datosObligatorioDescripción
fw_namestringNombre del Firmware
fw_versionstringVersión del Firmware
platformstring (enum)Plataforma. Valores: aml (Amlogic), bb (BeagleBone), cv (Cvitek), stm (STM), xil (Xilinx)
install_typestring (enum)Tipo de instalación. Valores: sd, nand
build_timestringTiempo de compilación
build_namestringNoNombre de la compilación
build_uuidstringNoUUID de la compilación
minerstringNombre visible del miner
modelstringCódigo del modelo del miner
algorithmstring (enum)Algoritmo de minería. Valores: sha256d, scrypt, unknown
hr_measurestring (enum)Unidad de medida del Hashrate. Valores: GH/s, MH/s, N/A
serialstringNúmero de serie
systemobject (SystemInfo)Información del sistema (memoria, SO, red, uptime, etc.) ver detalles abajo

Objeto anidado system ( SystemInfo ):

ParámetroTipo de datosObligatorioDescripción
mem_totalinteger (int32)Memoria total, no negativa
mem_freeinteger (int32)Memoria libre, no negativa
mem_free_percentinteger (int32)Porcentaje de memoria libre, no negativo
mem_bufinteger (int32)Memoria ocupada por búferes, no negativa
mem_buf_percentinteger (int32)Porcentaje de memoria para búferes, no negativo
osstringNombre del sistema operativo
miner_namestringNombre del miner en el sistema
file_system_versionstringVersión del sistema de archivos
uptimestringTiempo de actividad del sistema sin reiniciar
network_statusobject (NetworkStatus)Estado de red — ver detalles abajo

Objeto anidado network_status (NetworkStatus):

ParámetroTipo de datosObligatorioDescripción
macstringDirección MAC de la interfaz de red
ipstringDirección IP actual
netmaskstringMáscara de subred
gatewaystringDirección de la puerta de enlace
dnsarray of stringLista de servidores DNS
hostnamestringNombre de host del dispositivo
dhcpboolean | nullNo¿Se obtuvo la dirección por DHCP?

Localización (iluminación/búsqueda) del miner. Devuelve el estado actual de la función. No requiere autorización.

Respuesta 200 (OK): LocateMinerStatus

ParámetroTipo de datosObligatorioDescripción
is_enabledbooleanActivación/desactivación de la función de localización del miner

Bloqueo del miner (restablecimiento de la sesión actual). Requiere autorización (bearerAuth).

Respuesta 200 (OK): cuerpo ausente.

Bloqueo de otras sesiones del miner excepto la actual. Requiere autorización (bearerAuth).

Respuesta 200 (OK): cuerpo ausente.

Cuerpo de la solicitud: UnlockScreenBody

ParámetroTipo de datosObligatorioDescripción
pwstringContraseña del dispositivo (o dispositivos) de destino

Lectura de archivo de log por tipo. El tipo * (todos los logs) no está implementado para esta ruta. No requiere autorización.

Parámetro de ruta:

ParámetroTipo de datosObligatorioDescripción
log_typestring (enum)Tipo de log. Valores: status, miner, autotune, pool, hwscan, system, messages, api, * (todos — no implementado para esta ruta). Los valores se especifican en minúsculas

⚠️En la práctica, se utilizan realmente: status, miner, hwscan, autotune, system. Los valores se especifican en minúsculas.

Respuesta 200 (OK): archivo de log (cuerpo sin esquema descrito).

Limpieza de logs del tipo especificado. Requiere autorización.

Parámetro de ruta:

ParámetroTipo de datosObligatorioDescripción
log_typestring (enum)Tipo de log. Valores: status, miner, autotune, pool, hwscan, system, messages, api, *

⚠️ En la práctica, se utilizan realmente: status, miner, hwscan, autotune. Los valores se especifican en minúsculas.

Respuesta 200 (OK): cuerpo ausente (Logs was cleared successfully).

Obtención de métricas del miner para un intervalo de tiempo con promediado por paso.

Parámetros de consulta (query):

ParámetroTipo de datosObligatorioDescripción
time_sliceinteger (int32)NoCantidad de segundos hasta el momento actual. Máx. 3 días (259200), por defecto 1 día (86400)
stepinteger (int32)NoPaso de remuestreo (seg) para el promedio, por defecto 15 min (900)

Respuesta 200 (OK): MetricsReply

ParámetroTipo de datosObligatorioDescripción
timezonestring (enum)Zona horaria. Valores: GMT+1GMT+12, GMT, GMT-1GMT-11
metricsarray (TimeRecord_MetricsData)Registros de métricas con tiempo (ver abajo)
annotationsarray (TimeRecord_MetricAnnotation)Anotaciones de eventos con tiempo

Objeto anidado metrics[].data ( MetricsData ):

ParámetroTipo de datosObligatorioDescripción
timeinteger (int64)Tiempo UNIX del registro
hashratenumber (double)Hashrate
pcb_max_tempinteger (int32)Temperatura máxima de la PCB
chip_max_tempinteger (int32)Temperatura máxima del chip
fan_dutyinteger (int32)Velocidad de los ventiladores (duty)
power_consumptioninteger (int32)Consumo de energía

Objeto anidado annotations[].data ( MetricAnnotation ):

ParámetroTipo de datosObligatorioDescripción
timeinteger (int64)Tiempo UNIX del evento
typestring (enum)Tipo de evento. Valores: start, stop, restart, reboot, overheat, disable_board, enable_board, fw_update
board_idinteger (int32) | nullNoIdentificador de la Hashboard

Pausa de la minería. Requiere autorización.

Respuesta 200 (OK): cuerpo ausente (Mining paused).

Reinicio de la minería. Requiere autorización.

Respuesta 200 (OK): cuerpo ausente (Mining restart).

Reanudación de la minería. Requiere autorización.

Respuesta 200 (OK): cuerpo ausente (Mining resumed).

Inicio de la minería. Requiere autorización.

Respuesta 200 (OK): cuerpo ausente (Mining started).

Detención de la minería. Requiere autorización.

Respuesta 200 (OK): cuerpo ausente (Mining stopped).

Cambio del Pool activo. Requiere autorización.

Cuerpo de la solicitud: SwitchPoolQuery

ParámetroTipo de datosObligatorioDescripción
pool_idinteger (int32)Identificador del Pool, no negativo

Ejemplo de cuerpo de solicitud:

{
  "pool_id": 1
}

Respuesta 200 (OK): cuerpo ausente (Pool was switched successfully).

Actualización de la configuración de throttling. Requiere autorización.

Respuesta 200 (OK): SaveConfigResult

ParámetroTipo de datosObligatorioDescripción
restart_requiredbooleanSe requiere reiniciar el miner para aplicar la configuración
reboot_requiredbooleanSe requiere reiniciar el miner para aplicar

Cuerpo de la solicitud: ThrottleSettings

ParámetroTipo de datosObligatorioDescripción
percentinteger (int32)Porcentaje de throttling, de 20 a 100

Obtención de información sobre el modelo del miner (algoritmo, serie, plataforma, topología de Hashboards, refrigeración, Overclocking). No requiere autorización.

Respuesta 200 (OK): MinerModelInfo

ParámetroTipo de datosObligatorioDescripción
full_namestringNombre visible del miner
modelstringCódigo del modelo del miner
algorithmstring (enum)Algoritmo. Valores: sha256d, scrypt
seriesstring (enum)Serie. Valores: l7, l9, x19, x21
platformstring (enum)Plataforma. Valores: aml, bb, cv, stm, xil
install_typestring (enum)Tipo de instalación. Valores: sd, nand
hr_measurestring (enum)Unidad de Hashrate. Valores: GH/s, MH/s
serialstringNúmero de serie
chainobject (ModelInfoBoard)Parámetros de la Hashboard: chips_per_chain, chips_per_domain, num_chains, topology
coolingobject (CoolingConsts)Constantes de refrigeración: min_fan_pwm, min_target_temp, max_target_temp, fan_min_count
overclockobject (Overclock)Límites de Overclocking (voltaje, frecuencia, límite de potencia, etc.)

Objeto anidado chain (ModelInfoBoard):

ParámetroTipo de datosObligatorioDescripción
chips_per_chainintegerCantidad de chips en una Hashboard.
chips_per_domainintegerCantidad de chips en un dominio de alimentación.
num_chainsintegerCantidad de Hashboards.
topologyobject (Topology)Esquema de disposición de los chips en la Hashboard.

Objeto anidado en chain topology(Topology):

ParámetroTipo de datosObligatorioDescripción
chipsarrayArray bidimensional que describe el esquema de disposición de los chips en la Hashboard. Cada elemento contiene identificadores de chips de acuerdo con su ubicación física.
num_colsintegerCantidad de columnas en el esquema de disposición de los chips.
num_rowsintegerCantidad de filas en el esquema de disposición de los chips.

Objeto anidado cooling (CoolingConsts):

ParámetroTipo de datosObligatorioDescripción
min_fan_pwmintegerVelocidad mínima permitida de los ventiladores (PWM, %).
min_target_tempintegerTemperatura objetivo mínima permitida de los chips.
max_target_tempintegerTemperatura objetivo máxima permitida de los chips.
fan_min_countobject (MinerFanMinCount) | nullCantidad mínima de ventiladores necesaria para el funcionamiento del dispositivo. Para modelos sin ventiladores, el valor puede ser null.

Objeto anidado en cooling fan_min_count ( MinerFanMinCount ):

ParámetroTipo de datosObligatorioDescripción
mininteger (int32)Cantidad mínima de ventiladores, no negativa
maxinteger (int32)Cantidad máxima de ventiladores, no negativa
defaultinteger (int32)Valor por defecto, no negativo

Objeto anidado overclock (Overclock):

ParámetroTipo de datosObligatorioDescripción
min_voltageintegerVoltaje mínimo.
default_voltageintegerVoltaje por defecto.
max_voltageintegerVoltaje máximo.
max_voltage_stock_psuintegerVoltaje máximo al usar la PSU de stock.
min_freqintegerFrecuencia mínima.
default_freqintegerFrecuencia por defecto.
warn_freqintegerFrecuencia, al excederla se muestra una advertencia.
max_freqintegerFrecuencia máxima.
max_power_limitintegerLímite de potencia máximo permitido.
power_meteringbooleanSoporte para la medición del consumo de energía.

Lectura de todas las notas en forma de diccionario «clave — valor».

Respuesta 200 (OK): objeto (diccionario)

ParámetroTipo de datosObligatorioDescripción
(clave arbitraria)stringValor de la nota; las claves son cadenas arbitrarias

Cuerpo de la solicitud: NoteKeyValue

ParámetroTipo de datosObligatorioDescripción
keystringClave de la nota
valuestringValor de la nota

Ejemplo de cuerpo de solicitud:

{
  "key": "pool_reminder",
  "value": "string1"
}

Respuesta 200 (OK): cuerpo ausente (Note add successfully).

Obtención de una nota por clave.

Parámetro de ruta:

ParámetroTipo de datosObligatorioDescripción
notestringClave de la nota

Ejemplo de solicitud: GET {{baseUrl}}/notes/pool_reminder

Respuesta 200 (OK): NoteValue

ParámetroTipo de datosObligatorioDescripción
valuestringValor de la nota

Actualización de una nota por clave. Requiere autorización.

Parámetro de ruta:

ParámetroTipo de datosObligatorioDescripción
notestringClave de la nota

Cuerpo de la solicitud: NoteValue

ParámetroTipo de datosObligatorioDescripción
valuestringValor de la nota

Ejemplo de solicitud: PUT {{baseUrl}}/notes/pool_reminder con cuerpo:

{
  "value": "string1111"
}

Respuesta 200 (OK): cuerpo ausente (Notes add successfully).

Eliminación de una nota por clave. Requiere autorización.

Parámetro de ruta:

ParámetroTipo de datosObligatorioDescripción
notestringClave de la nota

Respuesta 200 (OK): cuerpo ausente (Note delete successfully).

Resumen de rendimiento: Preset actual y configuración del conmutador de Presets.

Respuesta 200 (OK): PerfSummary

ParámetroTipo de datosObligatorioDescripción
preset_switcherobject (PresetSwitcherRaw)Configuración del conmutador de Presets (ver abajo)
current_presetobject (CurrentPreset) | nullNoPreset actual (name, pretty, status, globals)

Objeto anidado PresetSwitcherRaw :

ParámetroTipo de datosObligatorioDescripción
enabledboolean | nullNo¿Está habilitado el conmutador?
autochange_top_presetboolean | nullNoCambio automático del Preset superior
check_timeinteger (int32) | nullNoPeríodo de verificación (seg), 60–600
decrease_tempinteger (int32) | nullNoTemperatura de disminución, 25–90
rise_tempinteger (int32) | nullNoTemperatura de aumento, máx. 85
ignore_fan_speedboolean | nullNoIgnorar velocidad de los ventiladores
min_presetstring | nullNoPreset mínimo
top_presetstring | nullNoPreset máximo al que puede cambiar

Objeto anidado current_preset ( CurrentPreset ):

ParámetroTipo de datosObligatorioDescripción
namestringIdentificador (id) del Preset
prettystringNombre legible del Preset
statusstring (enum)Estado del Preset. Valores: untuned, tuned
globalsobject (GlobalsRaw) | nullNoFrecuencia/voltaje globales (freq, volt) — presente solo cuando el conmutador de Presets está deshabilitado

Obtención de todas las configuraciones del miner. Requiere autorización (apikeyAuth).

Respuesta 200 (OK): ViewConfig

ParámetroTipo de datosObligatorioDescripción
minerobject (MinerConfigRaw)Configuración del miner: cooling, misc, overclock, pools
uiobject (UiSettings)Configuración de la interfaz (tema, idioma, zona horaria, etc.)
regionalobject (RegionalSettings)Configuración regional: timezone.current
networkobject (NetworkConfFile)Configuración de red: hostname, dhcp, ipaddress, netmask, gateway, dnsservers
passwordobject (PasswordChange) | nullNoCambio de contraseña: current, pw

Objeto anidado ui ( UiSettings ):

ParámetroTipo de datosObligatorioDescripción
themestring (enum) | nullNoTema. Valores: light, dark, auto
localestring (enum) | nullNoIdioma. Valores: ru, en, fa, ua, zh, pt, ka
timezonestring (enum) | nullNoZona horaria. Valores: GMT+1GMT+12, GMT, GMT-1GMT-11
dark_side_paneboolean | nullNoPanel lateral oscuro
disable_animationboolean | nullNoDesactivación de animación
constsobject (Consts) | nullNoConstantes para la interfaz — ver detalles abajo

Objeto anidado en ui.consts ( Consts ):

ParámetroTipo de datosObligatorioDescripción
coolingobject (CoolingConsts)Los mismos campos ya detallados en la sección 6.5.28 (GET /model): min_fan_pwm, min_target_temp, max_target_temp, fan_min_count
overclockobject (Overclock)Los mismos campos ya detallados en la sección 6.5.28 (GET /model)
timezonesarrayNoLista de zonas horarias disponibles para mostrar en la UI, pares «código → nombre»

Objeto anidado regional ( RegionalSettings ):

ParámetroTipo de datosObligatorioDescripción
timezoneobject (TimezoneSettings)Envoltura sobre la zona horaria — el único campo current (enum, los mismos valores GMT±N)

Objeto anidado network ( NetworkConfFile ):

ParámetroTipo de datosObligatorioDescripción
hostnamestringNombre de host del dispositivo
dhcpboolean¿Se obtuvo la dirección por DHCP?
ipaddressstringDirección IP
netmaskstringMáscara de subred
gatewaystringDirección de la puerta de enlace
dnsserversarray of stringLista de servidores DNS

Objeto anidado password ( PasswordChange ):

ParámetroTipo de datosObligatorioDescripción
currentstringContraseña actual
pwstringNueva contraseña

Objeto anidado en ViewConfig miner ( MinerConfigRaw ):

ParámetroTipo de datosObligatorioDescripción
coolingobject (CoolingSettingsRaw) | nullNoConfiguración de refrigeración — ver detalles abajo
miscobject (AdvancedSettingsRaw) | nullNoConfiguración avanzada — ver detalles abajo
overclockobject (OverclockSettingsRaw) | nullNoConfiguración de Overclocking — ver detalles abajo
poolsarray | nullNoLista de 3 Pools (trío fijo) — ver detalles abajo

Objeto anidado en miner cooling ( CoolingSettingsRaw ):

ParámetroTipo de datosObligatorioDescripción
fan_max_dutyinteger (int32) | nullNoVelocidad máxima de los ventiladores, 0–100
fan_min_dutyinteger (int32) | nullNoVelocidad mínima de los ventiladores, 0–100
fan_min_countinteger (int32) | nullNoCantidad mínima de ventiladores, no negativa
min_startup_water_tempinteger (int32) | nullNoTemperatura mínima del agua al inicio, 0–20
modeobject (ModeRaw) | nullNoModo de funcionamiento de los ventiladores — ver detalles abajo

Objeto anidado en cooling mode ( ModeRaw ) — una de tres opciones (por valor de name):

ParámetroTipo de datosObligatorioDescripción
namestring (enum)Opción de modo. Valores: auto, manual, immers
paraminteger (int32)Sí (solo para auto/manual)Parámetro del modo, no negativo. Ausente cuando name: "immers"

Objeto anidado en miner misc (AdvancedSettingsRaw) — todos los campos son opcionales (null, si no están definidos):

ParámetroTipo de datosDescripción
allow_disabling_chains_without_picsboolean | nullPermitir la desactivación de Hashboards sin Controladores PIC
auto_chip_throttlingboolean | nullRegulación automática de la frecuencia de los chips por temperatura
automatic_pause_on_bootboolean | nullAuto-pausa de la minería inmediatamente después del arranque
bitmain_disable_volt_compboolean | nullDesactivar compensación de voltaje
disable_chain_break_protectionboolean | nullDesactivar protección contra rotura de Hashboard
disable_restart_unbalancedboolean | nullDesactivar reinicio por desequilibrio
disable_volt_checksboolean | nullDesactivar verificaciones de voltaje
downscale_preset_on_failureboolean | nullAuto-reducción del Preset en caso de sobrecalentamiento/error de Hashboard
ignore_broken_sensorsboolean | nullIgnorar sensores defectuosos
ignore_chip_sensorsboolean | nullIgnorar sensores de chips
keep_hashing_when_offlineboolean | nullContinuar minando sin conexión a la red
max_restart_attemptsinteger (int32) | nullNúmero máximo de intentos de reinicio, no negativo
max_startup_delay_timeinteger (int32) | nullRetraso máximo de inicio de minería, 0–300 seg
min_startup_delay_timeinteger (int32) | nullRetraso mínimo de inicio de minería, 0–300 seg
min_operational_chainsinteger (int32) | nullNúmero mínimo de Hashboards operativas, no negativo
power_limitinteger (int32) | nullLímite de potencia, no negativo
power_limit_enabledboolean | null¿Está habilitado el límite de potencia?
quick_startboolean | nullInicio rápido
quiet_modeboolean | nullModo silencioso
restart_hashrateinteger (int32) | nullUmbral de Hashrate para reinicio, en porcentaje, 0–100 (0 — deshabilitado)
restart_tempinteger (int32) | nullTemperatura para reinicio, 50–120
restore_miner_state_on_rebootboolean | nullRestaurar el estado del miner después de reiniciar/apagar
retune_on_chain_breakboolean | nullAuto-tuning en caso de rotura de Hashboard
tuner_bad_chip_hr_thresholdinteger (int32) | nullUmbral de Hashrate para marcar un chip como «malo» en Auto-tune, 20–80

Objeto anidado en miner overclock ( OverclockSettingsRaw ):

ParámetroTipo de datosObligatorioDescripción
presetstring | nullNoNombre del perfil de Overclocking actual
globalsobject (GlobalsRaw) | nullNoFrecuencia/voltaje globales — ver detalles abajo
chainsarray (BoardRaw) | nullNoConfiguración de Overclocking por Hashboards — ver detalles abajo
preset_switcherobject (PresetSwitcherRaw) | nullNoConfiguración de cambio automático de Presets — los mismos campos que en la sección 6.5.35 (GET /perf-summary)

Objeto anidado en overclock globals ( GlobalsRaw ):

ParámetroTipo de datosObligatorioDescripción
freqinteger (int32) | nullNoFrecuencia global, no negativa
voltinteger (int32) | nullNoVoltaje global, no negativo

Objeto anidado en overclock chains[] ( BoardRaw ) — un elemento del array por cada Hashboard:

ParámetroTipo de datosObligatorioDescripción
freqinteger (int32) | nullNoFrecuencia de la Hashboard. 0 significa «usar el valor de globals»
chipsarray of integer (int32) | nullNoFrecuencias por cada chip de la Hashboard. 0 en el elemento — usar la frecuencia de la Hashboard
disabledboolean | nullNoHashboard deshabilitada

Guardar las configuraciones del miner. Requiere autorización.

Respuesta 200 (OK): SaveConfigResult

ParámetroTipo de datosObligatorioDescripción
restart_requiredbooleanSe requiere reiniciar el miner para aplicar la configuración
reboot_requiredbooleanSe requiere reiniciar el miner para aplicar

Cuerpo de la solicitud: InputConfig (todos los campos son opcionales, nullable)

ParámetroTipo de datosObligatorioDescripción
minerobject (MinerConfigRaw) | nullNoConfiguración del miner
networkobject (InputNetworkConfFile) | nullNoRed + enable_network_check
passwordobject (PasswordChange) | nullNoCambio de contraseña
regionalobject (RegionalSettings) | nullNoConfiguración regional
uiobject (UiSettings) | nullNoConfiguración de la interfaz

Objeto anidado network ( InputNetworkConfFile ) — es NetworkConfFile más un campo adicional:

ParámetroTipo de datosObligatorioDescripción
hostnamestringNombre de host del dispositivo
dhcpboolean¿Obtener la dirección por DHCP?
ipaddressstringDirección IP
netmaskstringMáscara de subred
gatewaystringDirección de la puerta de enlace
dnsserversarray of stringLista de servidores DNS
enable_network_checkbooleanNoHabilitar verificación de conexión de red (campo presente solo en InputNetworkConfFile, ausente en NetworkConfFile normal)

Objeto anidado password ( PasswordChange ):

ParámetroTipo de datosObligatorioDescripción
currentstringContraseña actual
pwstringNueva contraseña

Objeto anidado regional ( RegionalSettings ):

ParámetroTipo de datosObligatorioDescripción
timezoneobject (TimezoneSettings)Envoltura sobre la zona horaria

Objeto anidado en regional.timezone ( TimezoneSettings ):

ParámetroTipo de datosObligatorioDescripción
currentstring (enum)Zona horaria. Valores: GMT+1GMT+12, GMT, GMT-1GMT-11

Objeto anidado ui ( UiSettings ):

ParámetroTipo de datosObligatorioDescripción
themestring (enum) | nullNoTema. Valores: light, dark, auto
localestring (enum) | nullNoIdioma. Valores: ru, en, fa, ua, zh, pt, ka
timezonestring (enum) | nullNoZona horaria. Valores: GMT+1GMT+12, GMT, GMT-1GMT-11
dark_side_paneboolean | nullNoPanel lateral oscuro
disable_animationboolean | nullNoDesactivación de animación
constsobject (Consts) | nullNoConstantes para mostrar en la UI (solo lectura por significado, normalmente no se transmiten al guardar) — ver detalles abajo

Objeto anidado en ui.consts ( Consts ):

ParámetroTipo de datosObligatorioDescripción
coolingobject (CoolingConsts)Los mismos campos ya detallados en la sección 6.5.28 (GET /model): min_fan_pwm, min_target_temp, max_target_temp, fan_min_count
overclockobject (Overclock)Los mismos campos ya detallados en la sección 6.5.28 (GET /model)
timezonesarrayNoLista de zonas horarias disponibles para mostrar en la UI, pares «código → nombre». Relevante solo para solicitudes GET, para solicitudes UPDATE se puede ignorar

Copia de seguridad de las configuraciones. Requiere autorización. Devuelve un archivo binario.

Respuesta 200 (OK): datos binarios (application/octet-stream, array de bytes). El servidor devuelve un archivo ( .tar.gz ) que, al descomprimirse, contiene un conjunto de archivos de configuración del miner.

Contenido real del archivo (ejemplo):

ArchivoTipoContenido
system.confCONFConfiguración del sistema
passwordContraseña del dispositivo
network.confCONFConfiguración de red — corresponde a NetworkConfFile (hostname, dhcp, ipaddress, netmask, gateway, dnsservers)
dashd.confCONFConfiguración del servicio del demonio de minería/estado
cgminer.confCONFConfiguración principal de minería: Pools, Overclocking, configuraciones adicionales
autotune.jsonJSONPresets de Auto-tune guardados — corresponde a los datos de GET /autotune/presets
apikeys.jsonJSONLista de API-keys creadas — corresponde a ApiKeysJsonItem (sección 2–4). Array vacío [] si no hay claves

Restablecimiento de las configuraciones a valores de fábrica. Requiere autorización. Después de la operación, el sistema se reiniciará.

Respuesta 200 (OK): RebootAfter

ParámetroTipo de datosObligatorioDescripción
afterinteger (int64)En cuántos segundos se reiniciará el sistema (por defecto 3)

Restauración de configuraciones desde un archivo. Requiere autorización. Si la garantía está activa, se devolverá 403 (primero debe cancelar la garantía: /cancel-warranty). Después de la operación, el sistema se reiniciará.

Respuesta 200 (OK): RebootAfter

ParámetroTipo de datosObligatorioDescripción
afterinteger (int64)En cuántos segundos se reiniciará el sistema (por defecto 3)

Cuerpo de la solicitud: SchemaSettingsRestore (multipart/form-data)

ParámetroTipo de datosObligatorioDescripción
filestring (binary)Archivo de copia de seguridad de configuraciones

Obtención del estado del miner (condición, throttling, requisitos de reinicio, localización, garantía). Autorización no especificada.

Respuesta 200 (OK): StatusPane

ParámetroTipo de datosObligatorioDescripción
miner_statestring (enum)Estado del miner. Valores: mining, initializing, starting, auto-tuning, restarting, shutting-down, stopped, failure
throttledinteger (int32)Nivel de throttling, 20–100
miner_state_timeinteger (int64)Tiempo en el estado actual (actualmente implementado para mining)
descriptionstring | nullNoDescripción en estado de failure
failure_codeinteger (int32) | nullNoCódigo de error
restart_requiredbooleanReinicio requerido
reboot_requiredbooleanReboot requerido
find_minerbooleanBandera de la función de localización del miner (por defecto false)
unlockedbooleanEstado de bloqueo de pantalla (autorización pasada)
unlock_timeoutinteger (int64) | nullNoTiempo de espera de desbloqueo
warrantystring (enum)NoEstado de la garantía. Valores: active, inactive, expired, cancelled, not_provided

Resumen general del miner (estadísticas de Hashrate, temperaturas, potencia, Pools, Hashboards, refrigeración). Requiere autorización.

Respuesta 200 (OK): Summary

ParámetroTipo de datosObligatorioDescripción
minerobject (AntmMinerStats) | nullNoEstadísticas del miner (ver campos clave abajo)

Campos clave de AntmMinerStats :

ParámetroTipo de datosObligatorioDescripción
miner_statusobject (MinerStatus)Estado: miner_state, throttled, miner_state_time
miner_typestringTipo de miner
hr_stocknumber (float)Hashrate de stock
hr_realtimenumber (float)Hashrate en tiempo real
hr_nominalnumber (float)Hashrate nominal
hr_averagenumber (float)Hashrate promedio
average_hashratenumber (float)Obsoleto. Lo mismo que hr_average, pero en MH/s
instant_hashratenumber (float)Obsoleto. Lo mismo que hr_realtime, pero en MH/s
pcb_tempobject (TempRange)Rango de temperatura de la PCB: min, max
chip_tempobject (TempRange)Rango de temperatura de los chips: min, max
power_consumptioninteger (int32)Consumo de energía
power_efficiencynumber (float)Eficiencia energética
power_usageinteger (int32)Obsoleto. Lo mismo que power_efficiency
hw_errorsinteger (int32)Errores de hardware
hw_errors_percentnumber (float)Porcentaje de errores de hardware
hr_errornumber (float)Nivel de errores de Hashrate
devfeenumber (float)DevFee
devfee_percentnumber (float)Porcentaje de DevFee
poolsarray (PoolStats)Estadísticas de Pools (ver abajo)
coolingobject (Cooling)Refrigeración: fan_num, fans, settings, fan_duty
chainsarray (AntmBoard)Hashboards con estadísticas detalladas
found_blocksinteger (int32)Bloques encontrados
best_shareinteger (int64)Mejor share
restart_countintegerCantidad de reinicios
psuobject (AntmPsuInfo) | nullNoInformación de la PSU

Objeto anidado pools[] ( PoolStats ) — un elemento del array por cada Pool:

ParámetroTipo de datosObligatorioDescripción
idinteger (int32)Identificador del Pool, no negativo
urlstringDirección del Pool
userstringNombre de usuario/Worker
pool_typestring (enum)Tipo de Pool. Valores: UserPool, DevFee, Refund
statusstring (enum)Estado del Pool. Valores: offline, working, disabled, active, rejecting, unknown
diffstringDificultad actual (como cadena, según muestra cgminer)
diffanumber (double)Dificultad promedio aceptada
acceptedinteger (int32)Cantidad de shares aceptados
rejectedinteger (int32)Cantidad de shares rechazados
staleinteger (int32)Cantidad de shares obsoletos (stale)
ls_diffnumber (float)Dificultad del último share aceptado
ls_timestringHora del último share aceptado
pinginteger (int32)Ping al Pool, ms

Objeto anidado cooling ( Cooling ):

ParámetroTipo de datosObligatorioDescripción
fan_numintegerCantidad de ventiladores, no negativa
fan_dutyinteger (int32)Velocidad actual de los ventiladores (duty), total
fansarray (Fan)Lista de ventiladores — ver detalles abajo
settingsobject (FanSettings)Configuración del modo de ventiladores — ver detalles abajo

Objeto anidado en cooling fans[] ( Fan ) — un elemento del array por cada ventilador físico:

ParámetroTipo de datosObligatorioDescripción
idintegerIdentificador del ventilador, no negativo
rpminteger (int32)RPM actuales
max_rpminteger (int32)RPM máximas, no negativas
statusstring (enum)Estado del ventilador. Valores: ok, lost (conexión perdida con el ventilador)

Objeto anidado en cooling settings ( FanSettings ):

ParámetroTipo de datosObligatorioDescripción
modeobject (FanSettingsMode)Modo de funcionamiento de los ventiladores — una de tres opciones por valor de name, ver abajo

Objeto anidado en settings mode ( FanSettingsMode ):

ParámetroTipo de datosObligatorioDescripción
namestring (enum)Opción de modo. Valores: auto, manual, immersion
paraminteger (int32)Sí (solo para auto/manual)Parámetro del modo, no negativo. Ausente cuando name: "immersion"

Objeto anidado psu ( AntmPsuInfo ):

ParámetroTipo de datosObligatorioDescripción
psu_power_meteringboolean | nullNoSoporte para la medición de potencia por la PSU
tempsobject (AntmPsuTemps) | nullNoTemperaturas de la PSU — ver detalles abajo

Objeto anidado en psu temps ( AntmPsuTemps ):

ParámetroTipo de datosObligatorioDescripción
llc1_tempinteger (int32) | nullNoTemperatura de la etapa LLC 1
llc2_tempinteger (int32) | nullNoTemperatura de la etapa LLC 2
pfc_tempinteger (int32) | nullNoTemperatura de la etapa PFC

Objeto anidado chains[] ( AntmBoard ) — un elemento del array por cada Hashboard:

ParámetroTipo de datosObligatorioDescripción
idintegerIdentificador de la Hashboard, no negativo
frequencynumber (float)Frecuencia de la Hashboard
voltageinteger (int32)Voltaje de la Hashboard
power_consumptioninteger (int32)Consumo de energía de la Hashboard
hashrate_idealnumber (float)Hashrate nominal (ideal) de la Hashboard
hashrate_rtnumber (float)Hashrate de la Hashboard en tiempo real
hashrate_percentagenumber (float)Porcentaje del Hashrate nominal
hr_errornumber (float)Nivel de errores de Hashrate de la Hashboard
hw_errorsinteger (int32)Cantidad de errores de hardware de la Hashboard
pcb_tempobject (TempRange)Rango de temperatura de la PCB de la Hashboard: min, max
chip_tempobject (TempRange)Rango de temperatura de los chips de la Hashboard: min, max
chip_statusesobject (BoardChipStatuses)Resumen del estado de los chips de la Hashboard — ver detalles abajo
statusobject (BoardStatus)Estado de la Hashboard — ver detalles abajo
inlet_water_tempinteger (int32) | nullNoTemperatura del agua de entrada (para refrigeración líquida), no negativa
outlet_water_tempinteger (int32) | nullNoTemperatura del agua de salida (para refrigeración líquida), no negativa

Objeto anidado en chains[] chip_statuses ( BoardChipStatuses ) — cantidad de chips por categorías:

ParámetroTipo de datosObligatorioDescripción
redinteger (int32)Cantidad de chips en estado «rojo» (peor estado), no negativa
orangeinteger (int32)Cantidad de chips en estado «naranja» (estado intermedio), no negativa
greyinteger (int32)Cantidad de chips en estado «gris» (estado normal), no negativa

Objeto anidado en chains[] status ( BoardStatus ):

ParámetroTipo de datosObligatorioDescripción
statestring (enum)Estado de la Hashboard. Valores: initializing, mining, stopped, failure, disconnected, disabled, unknown
descriptionstring | nullNoDescripción textual del estado (normalmente se rellena en caso de failure)

Reinicio del sistema. Requiere autorización.

Respuesta 200 (OK): RebootAfter

ParámetroTipo de datosObligatorioDescripción
afterinteger (int64)En cuántos segundos se reiniciará el sistema (por defecto 3)

Obtención de la configuración de la interfaz (tema, idioma, zona horaria, constantes de refrigeración/Overclocking, zonas horarias).

Respuesta 200 (OK): UiSettings

ParámetroTipo de datosObligatorioDescripción
themestring (enum) | nullNoTema. Valores: light, dark, auto
localestring (enum) | nullNoIdioma. Valores: ru, en, fa, ua, zh, pt, ka
timezonestring (enum) | nullNoZona horaria. Valores: GMT+1GMT+12, GMT, GMT-1GMT-11
dark_side_paneboolean | nullNoPanel lateral oscuro
disable_animationboolean | nullNoDesactivación de animación
constsobject (Consts) | nullNoConstantes: cooling, overclock, timezones

Objeto anidado en UiSettings ( Consts ):

ParámetroTipo de datosObligatorioDescripción
coolingobject (CoolingConsts)Los mismos campos ya detallados en la sección 6.5.28 (GET /model): min_fan_pwm, min_target_temp, max_target_temp, fan_min_count
overclockobject (Overclock)Los mismos campos ya detallados en la sección 6.5.28 (GET /model)
timezonesarrayNoLista de zonas horarias disponibles para mostrar en la UI, pares «código → nombre»

Desbloqueo (autenticación por contraseña). Devuelve un token JWT.

Respuesta 200 (OK): UnlockSuccess

ParámetroTipo de datosObligatorioDescripción
tokenstringToken JWT de autorización

Cuerpo de la solicitud: UnlockScreenBody

ParámetroTipo de datosObligatorioDescripción
pwstringContraseña del dispositivo (o dispositivos) de destino

⚠️ El endpoint ya no se utiliza. Está marcado como deprecated en la especificación y se conserva solo por compatibilidad con clientes antiguos. Para nuevas integraciones, utilice el actual POST /locate-miner (sección 6.5.15).

ErrDescr (utilizado en respuestas 400, 409, 500, 507 y otros)

ParámetroTipo de datosObligatorioDescripción
errstringTexto del error