false, 'isAbsolute' => false]) ?>

Quickstart

This step-by-step guide will have running LBRY and interacting with the API in just a few minutes.

This guide is for programmers and other technical users. For consumer usage of LBRY, please go here.

What's Covered

  1. Installation
  2. Running LBRY
  3. API Basics
  4. Credits
  5. Start Building
  6. Community & Issues

1. Installation

The easiest way to install LBRY is to use a pre-packaged binary. We provide binaries for Windows, macOS, and Debian-based Linux.

macOS Linux Windows
Download DMG Download DEB Download MSI

If you prefer to compile from source or are not on one of the above operating systems, follow this guide.

2. Running LBRY

Launch the deamon to run as a background process:

lbrynet-daemon --no-launch

The first time you run the daemon, it must catch-up with most recent blockheaders. This can take several minutes.

3. API Basics

When running, the LBRY daemon provides a JSON-RPC server running at https://localhost:5279/lbryapi.

It can be accessed via cURL or any other utility capable of making HTTPS GET and POST requests.

To verify the LBRY daemon is running correctly and responding to requests, run:

curl --data "{ method: 'status' }" http://localhost:5279/lbryapi

You should receive a response like:

(will copy/paste once it works)

This makes it easy to interact with the LBRY API in the programming language of your choice.

4. Getting Credits

Many actions, such as publishing or purchasing paid content, require credits.

To receive credits, first generate a wallet address:

curl --data "{ method: 'wallet_new_address' }" http://localhost:5279/lbryapi
I am a response

Use this address to get credits in one of two ways:

4a) Get Credits For Free

All developers are eligible to receive free credits. Go here to claim them.

4b) Purchase Credits

Credits can be bought on a variety of exchanges. Go here to see a full list. After purchasing them, send them to the address generated above.

6. Community & Issues

Join our Slack Channel to interact with LBRY developers and other community members. Please visit the #dev room (this is not a default channel).

Visit our GitHub to view the source code or report issues.