btc-era.co

API documentation

The btc-era.co API follows the REST schema. Everything is a resource and can be modified by standard http methods GET, POST, PUT and DELETE. Information returned is always in json format.

To use the API you need to provide an API token in the HTTP header "Http-Authorization". You can get/create your API-Key in the Dashboard.

Agent resource

Manage your agents. You can list existing agents, update them, create new agents or delete an agent.

Note: The is a numeric value. It is displayed on your dashboard; alternatively you can obtain it from the "GET" response below.

method resource location description
GET https://btc-era.co/api/v1/agent/ Retrieve a list of all agents.
  curl example: curl -H "Authorization: " https://btc-era.co/api/v1/agent/
GET https://btc-era.co/api/v1/agent// Retrieve details of agent with id .
  curl example: curl -H "Authorization: " https://btc-era.co/api/v1/agent/17/
POST https://btc-era.co/api/v1/agent/ Create a new agent. You need to provide the following parameters:
name
Name of the agent.
watch_type
"1" -> Watch for withdrawals, "2" -> Watch for deposits, "3" -> Both.
addresses
Optional: Comma-separated list of bitcoin addresses.
  curl example: curl -H "Authorization: " https://btc-era.co/api/v1/agent/ -X POST -d "name=Bond&watch_type=2"
PUT https://btc-era.co/api/v1/agent// Change an existing agent. You can provide the following parameters:
name
Optional: Name of the agent.
watch_type
Optional: "1" -> Watch for withdrawals, "2" -> Watch for deposits, "3" -> Both.
addresses
Optional: Comma-separated list of bitcoin addresses.
Note that specifying the "addresses" parameter will replace all existing addresses configured to watch. If you just want to add/remove an address from an existing agent use the "address" resource.
  curl example: curl -H "Authorization: " https://btc-era.co/api/v1/agent/17/ -X PUT -d "name=James"
DELETE https://btc-era.co/api/v1/agent// Delete agent .
  curl example: curl -H "Authorization: " https://btc-era.co/api/v1/agent/17/ -X DELETE

Address resource

Manage the bitcoin addresses of your agents. You can list, add or remove the addresses an agent is watching.

method resource location description
GET https://btc-era.co/api/v1/agent//address/ Retrieve a list of all addresses agent is currently watching.
  curl example: curl -H "Authorization: " https://btc-era.co/api/v1/agent/17/address/
GET https://btc-era.co/api/v1/agent//address// Check if an address is on the agent's watchlist.
  curl example: curl -H "Authorization: " https://btc-era.co/api/v1/agent/17/address/1BTC1oo1J3MEt5SFj74ZBcF2Mk97Aah4ac/
POST https://btc-era.co/api/v1/agent//address/ Add a bitcoin address to the agent's watchlist.
  curl example: curl -H "Authorization: " https://btc-era.co/api/v1/agent/17/address/ -X POST -d"address=1BTC1oo1J3MEt5SFj74ZBcF2Mk97Aah4ac"
DELETE https://btc-era.co/api/v1/agent//address// Remove a bitcoin address from the agent's watchlist.
  curl example: curl -H "Authorization: " https://btc-era.co/api/v1/agent/17/address/1BTC1oo1J3MEt5SFj74ZBcF2Mk97Aah4ac/ -X DELETE"

Notification resources

Manage notification settings. You can create, list, update or delete notification settings of an agent.

There are three types of notifications, each having it's own resource URI:

email
manage email notifications
feed
manage rss/atom feed notifications
url
manage url callback notifications
xmpp
manage xmpp instant messaging notifications

method resource location description
GET https://btc-era.co/api/v1/agent//notification// Retrieve a list of all notifications configured for the agent.
  curl example: curl -H "Authorization: " https://btc-era.co/api/v1/agent/17/notification/email/
GET https://btc-era.co/api/v1/agent//notification/// Get a specific notification.
  curl example: curl -H "Authorization: " https://btc-era.co/api/v1/agent/17/notification/feed/17/
POST https://btc-era.co/api/v1/agent//notification// Create a new notification. You need to provide the following parameters:
req_confirmations
Required confirmations (0 to 10)
email
Only for type "email": Email address that should receive the notificaiton.
url
Only for type "url": Url that should be called.
jid
Only for type "xmpp": Jabber ID that should receive the notification.
  curl example (email): curl -H "Authorization: " https://btc-era.co/api/v1/agent/17/notification/email/ -X POST -d"[email protected]"
  curl example (url callback): curl -H "Authorization: " https://btc-era.co/api/v1/agent/17/notification/url/ -X POST -d"req_confirmations=3&url=http://my.shop.com/payment/"
  curl example (feed): curl -H "Authorization: " https://btc-era.co/api/v1/agent/17/notification/feed/ -X POST -d"req_confirmations=1"
  curl example (xmpp): curl -H "Authorization: " https://btc-era.co/api/v1/agent/17/notification/xmpp/ -X POST -d"[email protected]"
DELETE https://btc-era.co/api/v1/agent//notification// Delete a notification.
  curl example: curl -H "Authorization: " https://btc-era.co/api/v1/agent/17/notification/email/3/ -X DELETE"