LedgerApi.md

ledger.LedgerApi

All URIs are relative to http://localhost

Method	HTTP request	Description
getLedgerInfo	GET /{ledger}/_info	Get information about a ledger

getLedgerInfo

LedgerInfoResponse getLedgerInfo()

Example

import { ledger } from '@numaryhq/ledger-nodejs';
import * as fs from 'fs';

const configuration = ledger.createConfiguration();
const apiInstance = new ledger.LedgerApi(configuration);

let body:ledger.LedgerApiGetLedgerInfoRequest = {
  // string | Name of the ledger.
  ledger: "ledger001",
};

apiInstance.getLedgerInfo(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
ledger	[string]	Name of the ledger.	defaults to undefined

Return type

LedgerInfoResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json; charset=utf-8

HTTP response details

Status code	Description	Response headers
200	OK	-
0	Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]