bing-webmaster-cli

CLI for Bing Webmaster API using API-key authentication.

Features

• API key auth from BING_WEBMASTER_API_KEY or local stored credentials
• List sites available to your Bing Webmaster account
• Site and URL traffic stats with CLI-side date range filtering
• URL index check with crawl-issue reason hints when URL is not indexed
• Submit one URL or a batch of URLs for indexing
• Output formats: table, json, csv

Install (Recommended)

python3 -m pip install --user pipx
python3 -m pipx ensurepath
pipx install bing-webmaster-cli

Verify:

bwm --version

Install From Source

python3 -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"

Authentication

The CLI reads API key from:

1. BING_WEBMASTER_API_KEY environment variable
2. local credentials file (~/.config/bing-webmaster-cli/credentials.json)

Store key locally:

bwm auth login --api-key "<your-api-key>"

Or interactive prompt:

bwm auth login

Check auth source:

bwm auth whoami

Clear local key:

bwm auth clear

Optional Default Site

bwm config set default-site https://example.com
bwm config get default-site

Usage

Sites

bwm site list
bwm site list --output json

Stats

Site-level stats:

bwm stats site --site https://example.com --start-date 2026-02-01 --end-date 2026-02-26

For stats site and stats url, Bing's API ignores date range parameters on these endpoints. The CLI still accepts --start-date and --end-date, but applies that filtering locally to the returned rows.

URL-level stats:

bwm stats url --site https://example.com --url https://example.com/page --start-date 2026-02-01 --end-date 2026-02-26

Save as CSV:

bwm stats site --site https://example.com --output csv --csv-path ./site-stats.csv

URL Indexing

Check if a URL is indexed by Bing:

bwm url check-index --site https://example.com --url https://example.com/page

If not indexed, CLI attempts to map crawl issue flags from GetCrawlIssues and prints the likely reason.

URL Submission

Submit one URL:

bwm url submit --site https://example.com --url https://example.com/new-page

Submit many URLs:

bwm url submit --site https://example.com \
  --url https://example.com/a \
  --url https://example.com/b

Submit URLs from file (one URL per line):

bwm url submit --site https://example.com --file ./urls.txt

Config Paths

Defaults:

• credentials: ~/.config/bing-webmaster-cli/credentials.json
• app config: ~/.config/bing-webmaster-cli/config.json

Overrides:

• BWM_CONFIG_DIR
• BWM_CREDENTIALS_FILE
• BWM_APP_CONFIG_FILE
• BWM_API_BASE_URL

API References

This CLI is based on Microsoft Bing Webmaster API docs:

• Getting access: https://learn.microsoft.com/en-us/bingwebmaster/getting-access
• API interfaces: https://learn.microsoft.com/en-us/dotnet/api/microsoft.bing.webmaster.api.interfaces?view=bing-webmaster-dotnet

Publishing

Trusted Publishing via GitHub Actions (Recommended)

This repo includes .github/workflows/publish.yml.

Release flow:

1. Bump version in pyproject.toml and bingwm_cli/__init__.py.
2. Commit and push.
3. Tag and push:

git tag v0.1.3
git push origin v0.1.3

Manual publishing

python -m pip install --upgrade build twine
python -m build
python -m twine upload dist/*