General API information

  • We are happy to improve our API for you. If you need more data, please contact support at ltcrabbit.com
  • Data returned is JSON
  • Units are given in brackets []
  • Please be polite to our API and avoid hammering. Limit requests to max. 1 request each 30 seconds. Shoutbox poll to 6 seconds.
  • We recommend to integrate a QR code scanner into your app and tell users to scan their API key from "Account settings" -> "Mobile app"

Download LTCRabbit image pack to enhance your app with high quality LTCRabbit logo and background:

Overview

1. Public API: general pool information
2. Private user API "getappdata": get information about user earning, worker, hashrate
3. Private user API "setappdata": create and delete worker / post message to shoutbox
4. Public shoutbox API: get shoutbox messages

Public Api

General public pool information.

https://www.ltcrabbit.com/index.php?page=api&action=public
Group Values
-
  • hashrate_scrypt: total pool scrypt hashrate [KH/s] (not available anymore)
  • hashrate_x11: total pool x11 hashrate [KH/s] (not available anymore)
  • workers: total workers connected to pool [worker] (not available anymore)
  • ltc_mh_scrypt: LTC/day per MH/s scrypt [LTC] (don't use anymore!)
  • ltc_mh_x11: LTC/day per MH/s x11 [LTC] (don't use anymore!)
  • hashrate: total pool hashrate [KH/s] (don't use anymore!)
profitability [array]
  • current (last payout 1h ago):
    • scrypt: ltc_mh [LTC], btc_mh [BTC], vs_ltc [%]
    • x11: ltc_mh [LTC], btc_mh [BTC], vs_ltc [%]
  • history (last 7 days):
    • scrypt [array]: date, ltc_mh [LTC], btc_mh [BTC], vs_ltc [%]
    • x11 [array]: date, ltc_mh [LTC], btc_mh [BTC], vs_ltc [%]

Private user Api (getappdata)

New LTCRabbit API provides you with all data you need for your app in only one request. Feel free to modify api URL below with an individual appname (a-z, 0-9), so we can attribute requests to your specific app and can determine how popular it is.

https://www.ltcrabbit.com/index.php?page=api&action=getappdata&appname=general&appversion=1&api_key=<user_api_key>
Group Values
general
  • message: general maintenance message from pool. Display message if value is not empty [text]
pool
  • hashrate_scrypt: total pool scrypt hashrate [KH/s] (not available anymore)
  • hashrate_x11: total pool x11 hashrate [KH/s] (not available anymore)
  • workers: total workers connected to pool [worker] (not available anymore)
  • ltc_mh_scrypt: LTC/day per MH/s scrypt [LTC] (don't use anymore!)
  • ltc_mh_x11: LTC/day per MH/s x11 [LTC] (don't use anymore!)
  • hashrate: total pool hashrate [KH/s] (don't use anymore!)
profitability [array]
  • current (last payout 1h ago):
    • scrypt: ltc_mh [LTC], btc_mh [BTC], vs_ltc [%]
    • x11: ltc_mh [LTC], btc_mh [BTC], vs_ltc [%]
  • history (last 7 days):
    • scrypt [array]: date, ltc_mh [LTC], btc_mh [BTC], vs_ltc [%]
    • x11 [array]: date, ltc_mh [LTC], btc_mh [BTC], vs_ltc [%]
ltc_exchange_rates
  • USD: LTC exchange rate [USD]
  • EUR: LTC exchange rate [EUR]
btc_exchange_rates
  • USD: BTC exchange rate [USD]
  • EUR: BTC exchange rate [EUR]
user
  • username: LTCRabbit username
  • balance: account balance [LTC]
  • balance_btc: LTC balance calculated to BTC [BTC]
  • hashrate_scrypt: user scrypt hashrate [KH/s]
  • hashrate_x11: user x11 hashrate [KH/s]
  • invalid_shares_scrypt: invalid scrypt sharerate [%]
  • invalid_shares_x11: invalid x11 sharerate [%]
  • sharerate: user scrypt sharerate [shares/s] (don't use anymore!)
  • invalid_share_rate: invalid scrypt sharerate [%] (don't use anymore!)
  • hashrate: user hashrate [KH/s] (don't use anymore!)
worker [array]
  • name: worker name
  • hashrate: worker hashrate [KH/s]
  • active: system recognizes worker as inactive/active [0/1]
  • monitoring: worker down monitoring disabled/enabled [0/1]
  • algo: mining algorithm [scrypt/x11]
earnings
  • basis: list of hourly basis earnings to create a graph [array]
  • alt: list of hourly altcoin PPS earnings to create a graph [array]
  • 24h_total: last 24h earnings [LTC]
  • 24h_basis: last 24h basis earnings [LTC]
  • 24h_alt: last 24h altcoin earnings [LTC] (don't use anymore!)
  • 24h_affiliate: last 24h affiliate earnings [LTC]
  • 48h_total
  • 48h_basis
  • 48h_alt (don't use anymore!)
  • 48h_affiliate

Private user Api (setappdata)

You can add and remove workers using the setappdata api

https://www.ltcrabbit.com/index.php?page=api&action=setappdata&appname=general&appversion=1&api_key=<user_api_key>&do=<do_parameter>
do parameter further parameter response
add_worker workerlist = workername1.workerpassword.scrypt ...

Comma separated list of workers (workername.workerpassword.workeralgo). Workername is NOT your account username. Algo can be scrypt or x11. Parameter can be POST (large amount of worker) or GET.
  • do
  • status [ok, error]
  • processed: list of workers that have been correctly added [array]
  • error: list of workers, that could not be added. In most cases already exist. [array]
delete_worker workerlist = workername1 ...

Comma separated list of workernames. Parameter can be POST (large amount of worker) or GET.
  • do
  • status [ok, error]
  • processed: list of workers that have been correctly deleted [array]
  • error: list of workers, that could not be deleted. In most cased, worker does not exist anymore. [array]
shout message (256 chars)
lastid (last shoutbox message id your app has displayed).

Parameter can be POST or GET.
  • do
  • status [ok, error]
  • shouts: list of shout messages [array]
  • errormsg: human readable error message [text]

Example: add two workers
https://www.ltcrabbit.com/index.php?page=api&action=setappdata&appname=general&appversion=1&api_key=<user_api_key>&do=add_worker&workerlist=worker1.mypassword.scrypt,worker2.mypassword.x11

Public shoutbox API

Implement LTCRabbit shoutbox to your app to benefit from interesting cryptocurrency related live chat!

You can pull current shoutbox messages using this URL:

https://www.ltcrabbit.com/shouts/<lastid>
parameter get started response [array]
lastid 1. set lastid=0 on your first data pull to get 50 lastest message
2. display all messages from the JSON array in your app and save the "id" of the last message you displayed
3. use the saved "id" as "lastid" for subsequent requests, to pull only messages you did not have displayed already
4. poll for new messages every 6 seconds
5. post new messages to shoutbox using setappdata (shout) API
  • id: unique message id [integer]
  • username: LTCRabbit username
  • userstatus: status of the user [normal/admin]
  • message: shout message [max. 255 chars, utf8]
  • date_utc: UTC timestamp [datetime, 0000-00-00 00:00:00]

Example (setappdata): post new message to shoutbox
https://www.ltcrabbit.com/index.php?page=api&action=setappdata&appname=general&appversion=1&api_key=<user_api_key>&do=shout&lastid=0&message=test

Contact support at miningcentral.freshdesk.com if you need help with our API!