Skip to content

jonlepage/Numista-eval

Repository files navigation

numista-eval

Evaluate the fairness of a coin swap on Numista.

🇫🇷 Version française

What it does

You export a swap file from Numista, run the tool, and get an Excel report with estimated prices, rarity scores and a fairness verdict. The report is fully editable — adjust grades, exclude coins, share it with your swap partner.

Setup

  1. Install Node.js (version 20+)
  2. Get a free Numista API key → numista.com/api

How to use

Step 1 — Export your swap from Numista:

  • Open your swap page (e.g. https://en.numista.com/echanges/echange.php?id=926052)
  • Click Export → save the .xls file

Step 2 — Open a terminal and run:

npx numista-eval "C:\Users\me\Downloads\swap_file.xls" YOUR_API_KEY CAD --lang fr

Step 3 — Open the Excel file from the reports/ folder created next to your XLS.

Examples

# French report in Canadian dollars
npx numista-eval "C:\Users\me\Downloads\swap_file.xls" YOUR_API_KEY CAD --lang fr

# English report in US dollars
npx numista-eval "C:\Users\me\Downloads\swap_file.xls" YOUR_API_KEY USD --lang en

# German report in euros
npx numista-eval "C:\Users\me\Downloads\swap_file.xls" YOUR_API_KEY EUR --lang de

# Chinese report in yuan
npx numista-eval "C:\Users\me\Downloads\swap_file.xls" YOUR_API_KEY CNY --lang zh

# Spanish report in Mexican pesos
npx numista-eval "C:\Users\me\Downloads\swap_file.xls" YOUR_API_KEY MXN --lang es

Languages (ISO 639-1): fr en de es pt it nl el ru zh ja

Currencies: any ISO 4217 code — CAD, EUR, USD, GBP, CNY, JPY…

Tip: create a .env file with NUMISTA_API_KEY=YOUR_API_KEY to avoid typing your key each time. On Windows, see evaluate.example.bat for a ready-to-use template.

The Excel report

  • Price adjusts automatically when you change the QA grade (1–7 dropdown)
  • ✔ column lets you include (✓) or exclude (✗) each coin — totals recalculate instantly
  • Default ✓/✗ values are read from the Numista exchange file (your proposals vs. theirs)
  • Conversion rates are fetched live and shown with Google verification links
  • Verdict at the bottom: FAIR, ACCEPTABLE or UNBALANCED (colored)

Limitations

  • Grades (QA) are approximate. Numista does not provide coin condition information in swap files. The tool defaults to the lowest known grade for each coin. You should manually verify and adjust the QA column based on the actual condition of each coin — this directly affects the estimated price.
  • Not all languages are fully supported. The Excel report is available in 11 languages (see list above). If an unsupported language code is provided, the report falls back to English.

Tips

  • Prices are estimates. They reflect dealer market value, not collector or sentimental value.
  • Commemorative coins are usually harder to find than their price suggests — adjust accordingly.
  • Check conversion rates for unusual currencies using the links in the Excel file.

One-click evaluation (Windows)

To avoid repeating the full command, create a reusable batch file with your settings.

  1. Create a new text file and rename it to evaluate.bat
  2. Copy the contents of evaluate.example.bat into it
  3. Replace the three values with your own: API key, currency, language
  4. Save — you're done. From now on, just double-click evaluate.bat
@echo off
set API_KEY=YOUR_API_KEY_HERE
set CURRENCY=CAD
set LANG=fr

set /p FILE=Path to XLS file:
set FILE=%FILE:"=%
call npx numista-eval@latest "%FILE%" %API_KEY% %CURRENCY% --lang %LANG%
pause

How to copy a file path on Windows: hold Shift and right-click the XLS file to reveal the hidden menu, then select Copy as path.

This is optional — the npx command in the terminal works exactly the same way.

API quota

2,000 requests/month (free key). Each evaluation ≈ 60 requests → ~30 evaluations/month.

License

MIT

Releases

No releases published

Packages

 
 
 

Contributors