What you get#
Onekey exposes Terraform Registry as 4 endpoints behind one API key: 2 endpoints return one record (data is an object) and 2 endpoints return a list (data is an array). Every answer uses the same envelope (success, data, metadata, error), the cost is reported in metadata.credits_charged, and fields are mapped onto the unified schema so the code you write for Terraform Registry also works for the rest of the developer platforms category.
Endpoints#
| Endpoint | What it does | Parameters | Credits | Status |
|---|---|---|---|---|
module | Terraform registry module metadata. | namespace*, name*, provider* | 1 | stable |
module_search | Search Terraform registry modules. | q* | 5 | stable |
module_versions | Published versions of a Terraform module. | namespace*, name*, provider* | 5 | stable |
provider | Terraform registry provider metadata. | namespace*, type* | 1 | stable |
A * marks a required parameter. Each endpoint name links to its reference page with the full parameter table, caching window and a recorded response.
Make a request#
This calls terraform.module (1 credit, stable). Replace YOUR_API_KEY with your key; sign up, no card. 1,000 free credits cover the open-platform endpoints. Hard-to-reach platforms (X, TikTok, Instagram, Reddit, and others marked on their page) need a verified email and a purchased pack.
curl "https://api.onekey.dev/v1/terraform/module?namespace=terraform-aws-modules&name=vpc&provider=aws" \
-H "x-api-key: YOUR_API_KEY"Fields you get back#
These unified fields come back from Terraform Registry, with the same names as on every other platform. The count is how many of its 4 mapped endpoints return the field; a field the source lacks is null, never missing. 4 platform-specific fields (ext.<name>) come on top, documented on each endpoint page.
| Field | Type | Endpoints |
|---|---|---|
package.version | string | 4 |
entity.description | string | 3 |
entity.id | string | 3 |
entity.name | string | 3 |
entity.stats.downloads | integer | 3 |
entity.updatedAt | ISO 8601 date | 3 |
package.namespace | string | 3 |
package.repositoryUrl | URL | 3 |
package.dependencies | list of strings | 1 |
The full schema is in Unified schema.
Pricing#
Terraform Registry calls cost 1 to 5 credits, flat per endpoint. Free when served from cache (0.2 credit for a cached response over 100 KB). Invalid, failed or not-found calls are not charged. See pricing for credit packs.