Dev · PyPI Stats
pypi.downloads
- Operation
- POST /v1/capabilities/pypi.downloads/execute
- operationId
- executePypiDownloads
- Typical credits
- 0
- Search deadline
- 15 s server-side
- Paging
- single result
- Availability
- Not checked
GET /v1/catalog (available). The timestamped snapshot describes configuration, not provider uptime or your account's enabled choices. Check the catalog with your own key before a call. Credits are explained under credits and limits.Request
Body of POST /v1/capabilities/pypi.downloads/execute, JSON, validated against the PypiDownloadsRequest component of the public OpenAPI document. Defaults are applied server-side, so an omitted optional field behaves exactly as its default.
| Field | Type | Required | Default | Constraints and description |
|---|---|---|---|---|
| package | string | yes | min length 1, max length 214, pattern ^[A-Za-z0-9](?:[A-Za-z0-9._-]*[A-Za-z0-9])?$ PyPI project name. Case and runs of hyphens, underscores and dots are normalized. | |
| kind | "recent" | "overall" | no | "recent" | recent: last day/week/month totals. overall: daily history (up to 180 days), excluding known mirrors. Source: PyPI Stats, not the PyPI metadata API. |
- Unknown keys are rejected with
400 invalid_request.
Examples
Recent totals
curl -s -X POST https://ai-powerups.smalltree.cloud/v1/capabilities/pypi.downloads/execute \
-H "Authorization: Bearer $AIPA_API_KEY" -H "Content-Type: application/json" \
-d '{"package":"requests","kind":"recent"}'Daily history without mirrors
curl -s -X POST https://ai-powerups.smalltree.cloud/v1/capabilities/pypi.downloads/execute \
-H "Authorization: Bearer $AIPA_API_KEY" -H "Content-Type: application/json" \
-d '{"package":"requests","kind":"overall"}'ExecuteResponse component (see sessions and records); the record keys below are what the adapter emits. A first call with the example above returns search_id, the records and the charge.Result record
Every item in results[] carries record_id and title (contract, always present) and usually url and snippet. The keys below are the documented tier: produced deterministically by this capability, omitted when the source has no value, checked against recorded source fixtures in our test suite, and published as the PypiDownloadsRecord component (all optional, extra keys allowed) so generated clients type them. The wire schema itself still validates only the base keys. See stability tiers.
| Key | Type | Presence | Note |
|---|---|---|---|
| package | string | always | |
| kind | "recent" | "overall" | always | |
| source | string | always | |
| data | object | object[] | always | |
| fetched_at | string | always | |
| cache_hit | boolean | always | |
| mirrors | boolean | always |
Caveats
- PyPI Stats is a separate provider. Data updates daily; daily history covers up to 180 days. Known mirrors are excluded.
- Results are cached for 24 hours per API process; restarts clear the cache and replicas have separate caches. 256 package/endpoint entries maximum; fresh entries are not evicted. Requests for new entries fail when full.
- An upstream 429 pauses new cache misses for Retry-After, or one hour when absent; existing cached results remain available. fetched_at is retrieval time, not a claim about the latest data date.
Follow-ups
- Paging: Single result;
moreis refused with400 invalid_request. - Update: not offered.
- Record actions: none.
- Detail behaviour: No record actions.
Record detail objects of this capability are provider-shaped: documented by observation, not by schema. Full follow-up semantics: follow-up.
Typed client
With types generated from the public document (see types, client and samples) the call is path-keyed and the body is checked at compile time:
const { data, error } = await client.POST("/v1/capabilities/pypi.downloads/execute", {
body: {
"package": "requests",
"kind": "recent"
},
});
if (error) throw new Error(`${error.error.code}: ${error.error.message}`);
for (const record of data.results) console.log(record.record_id, record.title);