Skip to content

Latest commit

 

History

History
40 lines (28 loc) · 3.19 KB

README.md

File metadata and controls

40 lines (28 loc) · 3.19 KB

Paymint-API-v2

NOTE: This is no longer maintained and the docs are incomplete. if you need this, just read the code and figure it out lmao

A Quick Overview

  • Firebase cloud functions for data retrieval and processing
  • Firestore to store price quotes on user transactions
  • Fully self-deployable
  • Supports custom Esplora-Electrs servers
  • Open source, minimal and privacy preserving wallet analytics
  • Documentation available

Endpoint Overview

Main Endpoints

All endpoints accept POST methods.

Endpoint Name Description
/txData Fetches transaction data associated with the wallet. Grouped and organised by date. Allows custom Electrs-Esplora endpoint to be specified
/voutLookup Returns the address specified at the index of the output, both of which are passed onto the endpoint. Allows custom Electrs-Esplora endpoint to be specified.
/pushtx Broadcasts the transaction hex passed to the function to main network. Allows custom Esplora-Electrs endpoint to be specified.
/outputData Fetches balance and output information for the wallet. It takes in an array of the addresses the wallet controls and the currency that the user would like pricing information in. Allows custom Esplora-Electrs endpoint to be specified.

Miscellaneous Endpoints

Endpoint Name Description
/currentBitcoinPrice Fetches the current price of Bitcoin in the specified currency
/historicalBitcoinPrice Fetches the price of Bitcoin from Firestore at the timestamp specified, in the currency specified.
/fees Returns the fee density for transaction confirmation in 1,3,5,7 or 9 blocks. Allows custom Esplora-Electrs endpoint to be specified.
/txCount Returns the number of transactions for the specified address. Tx count lookups stop by default at 25. Allows custom Esplora-Electrs endpoint to be specified.