Skip to main content

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

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)

License

MIT. See LICENSE.

Metadata

Release files for iblead-cli 1.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for iblead-cli 1.1.0
File Size Uploaded Provenance
iblead_cli-1.1.0.tar.gz 15.9 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for iblead-cli 1.1.0
File Interpreter ABI Platform
iblead_cli-1.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 34.4 kB

Release files / iblead_cli-1.1.0.tar.gz

Download URL iblead_cli-1.1.0.tar.gz
Size 15.9 kB
Tags Source
SHA-256 checksum
How to use checksums
59ce50770b1fcd5cab432ded9a514cb368df396efeced2f396d9312bd4a5ac50
BLAKE2b-256 checksum
How to use checksums
1fd9e191c0d03501113dfaf17d62caa6b2a17b7551e5f3d85e9afc035aa74483
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.3

Release files / iblead_cli-1.1.0-py3-none-any.whl

Download URL iblead_cli-1.1.0-py3-none-any.whl
Size 18.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
fba8c8f5bc6c9b03939ff4a6aacf5c4d4ebec1ee223de08e1b6520398d5c1666
BLAKE2b-256 checksum
How to use checksums
c8f0751eeb33d1c626ac120baf2bb174fdecd240c470e293775dec581d50240f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.3

Security for iblead-cli 1.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Release history Release notifications | RSS feed

This release

1.1.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page