v0.1.2
OAS 3.1.0

Numeraire SwissKnife REST API

This API is available to anyone with a Numeraire account. The User Wallet (/me) endpoints are the main access point for users.

Server: https://api.numeraire.tech
:
Client Libraries
Curl Shell

Authentication

​

Some endpoints are public, but some require authentication. We provide all the required endpoints to create an account and authorize yourself.

Authentication Operations

Sign In

​

Returns a JWT token to be used for authentication. The JWT token contains authentication and permissions. Sign in is only available for JWT Auth provider.

Body
application/json
  • password
    Type:string
    required

    User password

Responses
  • application/json
  • application/json
  • application/json
  • application/json
Request Example forPOST/v1/auth/sign-in
curl https://api.numeraire.tech/v1/auth/sign-in \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "password": "password_from_config_file"
}'

{
  "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJ..."
}

Token Created

User Wallet (Collapsed)

​

User Wallet endpoints. Available to any authenticated user.

User Wallet Operations

Wallets (Collapsed)

​

Wallet management endpoints. Require read:wallet or write:wallet permissions.

Wallets Operations

Invoices (Collapsed)

​

Invoice management endpoints. Require read:transaction or write:transaction permissions.

Invoices Operations

Payments (Collapsed)

​

Payment management endpoints. Require read:transaction or write:transaction permissions.

Payments Operations

Lightning Addresses (Collapsed)

​

LN Address management endpoints as defined in the protocol specification. Require read:ln_address or write:ln_address permissions.

Lightning Addresses Operations

Models