Skip to main content

Official IBLead CLI — search, export and watch Google Maps leads from your terminal.

Project description

IBLead CLI

Official command-line client for the IBLead API — search, export and watch Google Maps leads directly from your terminal.

pip install iblead-cli
iblead login
iblead export run --country FR --category Restaurant --no-reviews -o out.csv

Why a CLI

  • One-liner exports. iblead export run launches an async export, polls the job, downloads the CSV — three API calls collapsed into one command.
  • Composable. Pipe CSV/JSON output into jq, csvkit, Airflow, cron, GitHub Actions. Scriptable from day one.
  • Zone search. Draw a rectangle or free polygon, save it as a WKT file, pass --bbox @zone.wkt to any search or export.
  • No web UI needed. All 25+ public API endpoints wrapped: search, lookup, export, watches, credits, categories, cities.

Install

pip install iblead-cli

Requires Python 3.9+.

Authenticate

Grab an API key from app.iblead.com/dashboard/api, then:

iblead login

The key is stored in ~/.config/iblead/credentials (chmod 600). You can also set IBLEAD_API_KEY as an env var — it takes precedence over the file.

Common commands

Search

iblead search --country FR --category Restaurant --has-email -n 50 -f csv > leads.csv
iblead search --bbox @paris.wkt --min-rating 4.5 -f table

Export (async, with polling + download)

# Simple export — blocks until the file lands on disk
iblead export run --country FR --category Restaurant --limit 5000 -o restos.csv

# Zone-based, no reviews (~50x smaller file)
iblead export run --country FR --bbox @idf.wkt --no-reviews -o idf.csv

# Fire and forget — print the job_id and exit
iblead export run --country FR --category Hotel --no-wait

# Check job status later
iblead export status <job_id> --watch
iblead export download <job_id> -o hotels.csv

Lookup

iblead lookup one "0x47e66e1f06e2b70d:0x40b82c3688c9460"
iblead lookup bulk --file ids.txt
cat ids.txt | iblead lookup bulk

Watches (saved searches)

iblead watch create --country FR --category Restaurant --has-email --auto-notify
iblead watch list
iblead watch new <watch_id>
iblead watch unlock <watch_id> --limit 100

Zone / polygon helpers (offline)

# Build a WKT rectangle
iblead zone rectangle --min-lat 48.85 --min-lon 2.33 --max-lat 48.87 --max-lon 2.36 > paris.wkt

# Validate a WKT polygon (4-1000 points, closed ring, coord bounds)
iblead zone validate paris.wkt

Account

iblead credits      # balance + daily export usage
iblead whoami       # account info

Metadata

iblead categories
iblead subcategories --category Restaurant
iblead countries
iblead cities --country FR --search paris

Output formats

  • --format json (default for most commands) — machine-readable
  • --format csv — flat CSV, nested fields JSON-encoded
  • --format table — terminal-friendly

Exit codes

Code Meaning
0 Success
1 Usage / client error
2 Auth failed (401)
3 Forbidden (403)
4 Insufficient credits
5 Rate limited (429)
6 Server error (5xx)
7 Other HTTP error

Handy for shell scripts:

iblead export run --country FR -o out.csv && echo "done" || echo "failed with $?"

Environment variables

Variable Purpose
IBLEAD_API_KEY API key (overrides the credentials file)
IBLEAD_API_URL Override API base URL (default: https://app.iblead.com/api/v1)

Configuration

File Purpose
~/.config/iblead/credentials Stored API key (chmod 600)

Links

License

MIT. See LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

iblead_cli-1.1.0.tar.gz (15.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

iblead_cli-1.1.0-py3-none-any.whl (18.5 kB view details)

Uploaded Python 3

File details

Details for the file iblead_cli-1.1.0.tar.gz.

File metadata

  • Download URL: iblead_cli-1.1.0.tar.gz
  • Upload date:
  • Size: 15.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for iblead_cli-1.1.0.tar.gz
Algorithm Hash digest
SHA256 59ce50770b1fcd5cab432ded9a514cb368df396efeced2f396d9312bd4a5ac50
MD5 4ee221467d53ad5fae7426cfeb5d2575
BLAKE2b-256 1fd9e191c0d03501113dfaf17d62caa6b2a17b7551e5f3d85e9afc035aa74483

See more details on using hashes here.

File details

Details for the file iblead_cli-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: iblead_cli-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 18.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for iblead_cli-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fba8c8f5bc6c9b03939ff4a6aacf5c4d4ebec1ee223de08e1b6520398d5c1666
MD5 d54d475007c3739810f238acc1fe2c00
BLAKE2b-256 c8f0751eeb33d1c626ac120baf2bb174fdecd240c470e293775dec581d50240f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page