A simple P/L parser for bitcoin ordinals
BTCelParse is a program designed to help calculate profit/loss for bitcoin ordinals.
This program was created for research purposes only, and data parsed/presented by this
program is not guaranteed to be 100% accurate.
This software may be run as a stand-alone CLI tool or integrated into other programs.
This program was created on WSL2 and is intended for use with Linux/Unix compatible systems. Windows OS functionality has not yet been tested prior to release, and additional configuration may be necessary.
- Python [3.11+]:
- See docs and install instructions -> here
- This program may work with older versions of python, but this has not been explicitly tested.
- Type annotations may break backwards compatibility - modify the program by using the built-in
Typing
module or by removing annotations if using older versions of python.
- Type annotations may break backwards compatibility - modify the program by using the built-in
- requests: Installable via
pip install requests
->PYPI docs<-
No additional configuration is needed to run the program as a stand-alone CLI tool; however, it is highly recommended that you use an Ordinal API key from MagicEden.
Simply run the program, and [when prompted] input the ordinal wallet address that you wish to parse.
You may also provide an [optional] Ordinal API key from MagicEden if you wish to do so.
If you do not provide an [optional] Ordinal API key from MagicEden, the program may terminate early due to rate-limits
To call the program, simply navigate to the program's root directory, and call the program.
i.e.
python src/ord_parser.py
CLI output has several categories:
Total confirmed flips
: Fully verified purchase/sale- Includes mints/purchase/sale via officially recognized marketplaces using the SAME wallet (Xverse support via ME)
Total confirmed buys
: Verified buys- Does NOT currently include xfers/airdrops/OTC from another source, as these cannot be fully verified at this time
- Multi-wallet support will help address some of this (future release) - namely 3rd party mints
- Does NOT currently include xfers/airdrops/OTC from another source, as these cannot be fully verified at this time
Total confirmed sales
: Verified salesTotal confirmed P/L
: Aggregated P/L from confirmed buys/sellsTotal unconfirmed P/L
: Aggregated P/L from confirmed sells and unconfirmed buysTotal potential P/L
: Aggregated P/L from all sources
Providing an [optional] Ordinal API key from MagicEden will bypass their rate-limitations; however, you may try to run the program without one. The author of original software [Celshade] is not liable for any blocked IP addresses or negative reprecutions resulting from abusing rate-limits.
Some data sources (i.e. marketplaces, mempool, etc) may specify their own rate-limits.
The user is responsible for researching and understanding these rate-limits and the consequences for abusing them.
ME Ordinal API Rate Limiting: -> ME Rate limit docs <-