What you get#
Onekey exposes Hex as 3 endpoints behind one API key: 1 endpoint 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 Hex also works for the rest of the developer platforms category.
Endpoints#
| Endpoint | What it does | Parameters | Credits | Status |
|---|---|---|---|---|
package | Metadata of a Hex (Elixir/Erlang) package. | name* | 1 | stable |
search | Search Hex packages. | q* | 5 | stable |
versions | Releases of a Hex package. | name* | 5 | 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 hex.package (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/hex/package?name=phoenix" \
-H "x-api-key: YOUR_API_KEY"Fields you get back#
These unified fields come back from Hex, with the same names as on every other platform. The count is how many of its 3 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 | 3 |
entity.createdAt | ISO 8601 date | 2 |
entity.description | string | 2 |
entity.name | string | 2 |
entity.stats.downloads | integer | 2 |
entity.updatedAt | ISO 8601 date | 2 |
entity.url | URL | 2 |
package.documentationUrl | URL | 1 |
The full schema is in Unified schema.
Pricing#
Hex 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.