bitbucket.repo

stable Standard

Bitbucket Cloud repository metadata.

GET /v1/bitbucket/repo

What you get#

One Bitbucket record in Onekey's unified shape, in data. If the record does not exist you get a 404 not_found and are not charged.

What it costs#

Standard · 1 credit for a fresh fetch, charged only when it succeeds.
Free when served from cache (0.2 credit for a cached response over 100 KB).
Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

Name	Type	Required	Default	What it is	Constraints
`workspace`	string	yes	(required)	Bitbucket workspace slug	max 63 chars; must match `[a-z0-9][a-z0-9_-]{0,62}`; trimmed, lowercased
`repo`	string	yes	(required)	Repository slug	max 128 chars; must match `[a-z0-9][a-z0-9._-]{0,127}`; trimmed, lowercased

Request#

curl "https://api.onekey.dev/v1/bitbucket/repo?workspace=atlassian&repo=aui" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real Bitbucket response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json

{
  "success": true,
  "data": {
    "entity": {
      "id": "{585074de-7b60-4fd1-81ed-e0bc7fafbda5}",
      "name": "atlassian/aui",
      "description": "AUI - Atlassian User Interface library.",
      "url": "https://bitbucket.org/atlassian/aui",
      "language": "javascript",
      "createdAt": "2011-10-20T03:33:16Z",
      "updatedAt": "2026-09-28T18:21:09Z"
    },
    "ext": {
      "size": 141064612,
      "private": false
    },
    "author": {
      "displayName": "Atlassian",
      "username": null
    },
    "package": {
      "defaultBranch": "master"
    }
  },
  "metadata": {
    "platform": "bitbucket",
    "endpoint": "repo",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 1,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source path	Onekey field	Transform
`uuid`	`entity.id`	-
`full_name`	`entity.name`	-
`description`	`entity.description`	-
`links.html.href`	`entity.url`	`safeUrl`
`language`	`entity.language`	-
`size`	`ext.size`	`toNumber`
`created_on`	`entity.createdAt`	`toIsoDate`
`updated_on`	`entity.updatedAt`	`toIsoDate`
`owner.display_name`	`author.displayName`	-
`owner.nickname`	`author.username`	-
`is_private`	`ext.private`	`toBoolean`
`mainbranch.name`	`package.defaultBranch`	-

Caching and freshness#

Fresh for about 30 minutes. Repeat calls in that window are served from cache and are free.
Between 30 minutes and 6 hours the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
If the source is down when a refresh is needed, the last copy can be served for up to 1 day more (marked stale).
A "not found" is remembered for 5 minutes and is free.
The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

Status	Code	What to do
401	`unauthorized`	Check the `x-api-key` header.
402	`insufficient_credits`	Add credits; your balance must cover the price.
404	`not_found`	That record does not exist. Free; do not retry.
422	`invalid_params`	Fix the parameters using the table above. Free.
429	`rate_limited`	Wait `Retry-After` seconds, then retry.
502	`upstream_error`	The source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).