API - Get Account Summary (HMAC signed)

Index Management

The plan behind one index and how much of it is used: disk, traffic and documents of the index, indexes left on the account, crawl limits, AI requests and API rate limits.

Endpointhttps://opensolr.com/solr_manager/api/get_account_summary
MethodGET or POST
Authemail and api_key of your account, as GET or POST parameters: Authentication. Plus a signature: see below.

01 · Parameters

core_nameRequired

The name of your index.

signatureRequired

Hex HMAC-SHA256 of core_name followed by email, keyed with your API key.

02 · Example

SIG=$(printf '%s' "my_indexYOUR_EMAIL" | openssl dgst -sha256 -hmac "YOUR_API_KEY" | sed 's/^.* //')
curl -s "https://opensolr.com/solr_manager/api/get_account_summary?email=YOUR_EMAIL&api_key=YOUR_API_KEY&core_name=my_index&signature=$SIG"

03 · Answer

plan, plan_id, price, recurrence

The plan: Free, Corporate, Pre-Paid Plan or Inactive.

is_trial, trial_days_remaining

Always false and 0: the free plan does not expire. Kept for older integrations.

disk_used_mb, disk_limit_mb

Disk used by this index, and its limit.

bandwidth_used_mb, bandwidth_limit_mb

Traffic of this index this month, and its limit.

indexed_docs

Documents in this index.

index_limit, indexes_used, indexes_available

Indexes your plan allows, have, and can still create.

crawl_max_pages, crawl_max_threads, crawl_max_filesize_mb, crawl_max_traffic_mb

The crawl limits of the plan.

has_webcrawler, has_analytics, has_backup, vector_allowed

What the plan includes.

max_ai_requests, ai_requests_used, ai_over_quota, ai_available

The monthly AI allowance, what is used, and whether AI works right now: API Quota.

max_per_minute, max_per_hour

Your API rate limits.

photos_per_request

How many photos of an Opensolr Photos index count as one AI request.

solr_version, index_name, crawler_ip

The index, and the address of its server.

04 · Errors

ERROR_MISSING_PARAMSHTTP 200

No core_name or no signature.

ERROR_INVALID_SIGNATUREHTTP 200

The signature does not match.

ERROR_NOT_CORE_OWNERHTTP 200

The index is not yours.

ERROR_AUTHENTICATION_FAILEDHTTP 403

The email and API key do not match.

ERROR_RATE_LIMIT_PER_MINUTEHTTP 429

Too many calls. Wait for the Retry-After seconds: Rate limits.

05 · Related

The same summary with crawl stats and regions: get_settings_dashboard.

How to sign: Authentication.

Every error code and HTTP status of the API: API errors. Calls per minute and per hour: Rate limits.