Documentation

Coinos is free and open source software. You can run it on your own server and connect it to your own Bitcoin and Lightning nodes. The code is available for download at https://github.com/coinos

Coinos has a simple REST API that can be used to register accounts and make payments and queries. The following examples show how you can call the API with curl from your command line.

API Base URL

{api}

Auth Token

{#if user && token} This token authorizes you to use the API as {user.username}. {:else} Sign in to view your auth token here, or get one from the /login endpoint. {/if} Save it in a variable called $token to run the examples.

{tokenSample}

POST /register



  POST /login
  Login to an account to get its auth token
  

  POST /invoice
  Create an invoice.

  
    Request params
    
      type
      bitcoin or lightning
      amount
      amount in satoshis
      webhook
      
        (optional) endpoint to hit when the invoice is paid
      
      secret
      a secret for the webhook to check
    
  

  Get a lightning invoice to receive funds
  

  Get a bitcoin address to receive funds
  

  Sample response
  
  You can check the received field to see how much has been paid

  Specify a webhook to be called when an invoice is paid
  

  GET /invoice/:hash
  
    Fetch an invoice by passing a bitcoin address or lightning payment hash
  
  

  POST /payments
  Send a lightning payment
  

  Send an internal payment to another user
  

  POST /bitcoin/send
  Send a bitcoin payment
  

  GET /payments
  
    Get all payments sent or received by the current user
  

  
    Query params
    
      start
      only payments after this unix time
      end
      only payments before this unix time
      limit
      limit to this integer number of results
      offset
      start limiting from this integer offset