Skip to content

Quickstart

DannylydST edited this page Aug 6, 2026 · 3 revisions

Quickstart

Get from zero to your first data pull in 5 minutes.

1. Install

npm install -g sorftime-cli

Requires Node.js 16+. Verify: node --version.

2. Configure your profile

No account yet? Register at open-intl.sorftime.com — sign up with Google, free trial credits included.

sorftime add myprofile <your-account-sk>
sorftime use myprofile

The Account-SK is available in your Sorftime dashboard (open-intl.sorftime.com). Check it worked:

sorftime whoami
bash scripts/doctor.sh --connect    # full environment self-check

3. First queries

# Category Best Seller Top 100 (nodeId from the category tree)
sorftime api CategoryRequest '{"nodeId": "3743561"}' --domain 1

# Single product details
sorftime api ProductRequest '{"asin": "B0CVM8TXHP"}' --domain 1

# Keyword research
sorftime api KeywordRequest '{"keyword": "power bank"}' --domain 1

# One-line status query (title/price/sales/rating in 11 key fields)
bash scripts/one.sh ProductRequest B0CVM8TXHP

4. Next steps

  • Field naming traps — Sorftime field names are non-standard (SalesPrice = price, ListingSalesVolumeOfMonth = monthly sales). See Home → Field Alias table in resources/_field_aliases.md.
  • Batch automation — see Scriptsbatch.sh.
  • Domain table--domain 1 = US, 2 = UK, 3 = DE, 4 = FR, 6 = CA, 7 = JP, 8 = ES, 9 = IT, 10 = MX (full table in resources/_common.md).

Troubleshooting

Symptom Fix
sorftime: command not found npm install -g sorftime-cli
code=10 parameter error Wrap JSON in single quotes, use PascalCase endpoint names (see Parameter Traps in SKILL.md)
Rate-limit errors 500/501/694 Add sleep 1 between requests, or use batch.sh
Can't find a field Check resources/_field_aliases.md before concluding the API lacks it

Sorftime Data CLI Skill

Clone this wiki locally