
hledger-api(1)               hledger User Manuals               hledger-api(1)



NNAAMMEE
       hledger-api - web API server for the hledger accounting tool

SSYYNNOOPPSSIISS
       hledger-api [OPTIONS]
       hledger-api --swagger
       hledger api -- [OPTIONS]

DDEESSCCRRIIPPTTIIOONN
       hledger  is  a  cross-platform program for tracking money, time, or any
       other commodity, using double-entry accounting and a  simple,  editable
       file  format.   hledger  is  inspired  by  and  largely compatible with
       ledger(1).

       hledger-api is a simple web API server, intended to support client-side
       web  apps  operating on hledger data.  It comes with a series of simple
       client-side app examples, which drive it's evolution.

       Data is served from the usual hledger journal file: ~/.hledger.journal,
       $LEDGER_FILE,  or  another  file specified with -f.  For more about the
       format, see hledger(1) or hledger_journal(5).

       The server listens on port 8001, or  another  specified  with  -p PORT.
       Note  there  is  no  built-in  access control, so you will need to hide
       hledger-api behind an authenticating proxy  if  you  want  to  restrict
       access.

       If  invoked  as hledger-api --swagger, instead of starting a server the
       API docs will be printed in Swagger 2.0 format.

OOPPTTIIOONNSS
       Note: if invoking hledger-api as a hledger subcommand, write --  before
       options as shown above.

       --ff ----ffiillee FFIILLEE
              use   a   different   input   file   (default:  $LEDGER_FILE  or
              ~/.hledger.journal)

       --dd ----ssttaattiicc--ddiirr==DDIIRR
              serve files from a different directory (default: .)

       --pp ----ppoorrtt==PPOORRTT
              use a different TCP port (default: 8001)

       ----sswwaaggggeerr
              print API docs in Swagger 2.0 format, and exit

       --hh     show usage

       ----hheellpp show manual

       ----mmaann  show manual with man

       ----iinnffoo show manual with info

       ----vveerrssiioonn
              show version

EENNVVIIRROONNMMEENNTT
       LLEEDDGGEERR__FFIILLEE sets the default journal file path.   If  not  set,  it  is
       ~/.hledger.journal.

FFIILLEESS
       Reads   data   from   a   hledger   journal   file   ($LEDGER_FILE   or
       ~/.hledger.journal by default), or a CSV file plus associated CSV rules
       file.

BBUUGGSS
       The  need  to precede options with -- when invoked from hledger is awk-
       ward.



RREEPPOORRTTIINNGG BBUUGGSS
       Report bugs at http://bugs.hledger.org (or on the #hledger IRC  channel
       or hledger mail list)


AAUUTTHHOORRSS
       Simon Michael <simon@joyful.com> and contributors


CCOOPPYYRRIIGGHHTT
       Copyright (C) 2007-2016 Simon Michael.
       Released under GNU GPL v3 or later.


SSEEEE AALLSSOO
       hledger(1),      hledger-ui(1),     hledger-web(1),     hledger-api(1),
       hledger_csv(5), hledger_journal(5), hledger_timeclock(5), hledger_time-
       dot(5), ledger(1)

       http://hledger.org



                                 January 2016                   hledger-api(1)
