ForceX

Chain

Get Output

Single output lookup using canonical outpoint syntax.

Page Sections

GET

/chain/output/{txid}:{vout}

Full URL: https://forcex.com/xtract/v1/litecoin/chain/output/{txid}:{vout}

Credit cost: 1 credit by default. Include expansions add cost.

curl -H "Authorization: Bearer fx_test_************" \
  "https://forcex.com/xtract/v1/litecoin/chain/output/cb0e3dcc12a2e1c43a5a08f6a1aadf3b92041dfa433cd39547fd209f0117fc7b:0?include=spend"

Parameters

NameLocationRequiredTypeDescription
txidpathyesstring matching `^[0-9a-f]{64}$`Transaction ID, lowercase hex, 64 chars.
voutpathyesinteger (min 0)Output index within the transaction.
includequerynostring | null

Request Body

No request body.

Example Response

Representative trimmed response. Use the OpenAPI schema for the exhaustive field contract.

{
  "data": {
    "txid": "cb0e3dcc12a2e1c43a5a08f6a1aadf3b92041dfa433cd39547fd209f0117fc7b",
    "vout": 0,
    "value_atomic_units": 2500000,
    "script_pubkey_hex": "76a914..."
  },
  "included": {
    "spend": {
      "spent": true,
      "spent_height": 3118768
    }
  },
  "meta": {
    "served_from": "indexed_store",
    "credit_cost": 2
  }
}

Documented Responses

StatusDescription
200Successful Response
400Bad request. The `error.code` field identifies the specific cause: `bad_request` (general validation failure, including malformed dates, out-of-order ranges, and request-body validation), `range_too_large` (date range exceeds the per-grain cap), `ambiguous_time_range` (legacy `from`/`to` and new `start`/`end` supplied with differing values), or `invalid_include` (unsupported expansion in `?include=`).
401Authentication required, or the supplied Bearer token is invalid or revoked. `error.code` = `auth_required`.
402Payment-tier gate. `error.code` identifies which gate fired: `subscription_required` (no active subscription on the account), `subscription_inactive` (subscription exists but is not active), `include_all_requires_paid_tier` (sandbox keys cannot request `?include=all`), `include_set_requires_paid_tier` (the requested include set exceeds the per-request cost cap for sandbox keys), `historical_scan_requires_paid_tier` (sandbox keys cannot scan outside the recent window), or `deep_pagination_requires_paid_tier` (sandbox keys cannot page beyond the depth cap).
403Authenticated but the key lacks the required scope. `error.code` = `scope_insufficient`.
404Entity not found. `error.code` = `not_found`. Returned on direct entity GETs only — the `/chain/search` endpoint returns 200 with an empty/`not_found`-shaped body instead.
422Defense-in-depth: the runtime maps standard request-shape validation errors to 400, so partners normally see 400 instead of 422. This status is declared so any edge-case validation path that bypasses the override is still typed.
429Rate limit or credit budget exceeded. `error.code` identifies the window: `rate_limit_exceeded` (per-second or per-minute), `quota_exceeded_daily` (sandbox per-day budget), or `quota_exceeded` (per-subscription-period). The body carries a `window` field (`second`, `minute`, `day`, or `month`) naming the failing limit. Responses include the standard `Retry-After` header.
500Internal server error. `error.code` = `internal_error`. Reference `meta.request_id` when contacting support.
503Service or downstream data store is temporarily unavailable, or the endpoint is not implemented in this API version. `error.code` identifies the cause: `data_unavailable` (chain tip not yet populated), `audit_unavailable` (request completed but audit could not be acknowledged — safe to retry), `plan_misconfigured` (operational issue on the API side; not a tier problem), or `endpoint_not_available` (the route is reserved and not yet served in this version).

Integration Notes

  • Outpoints use the colon form: `{txid}:{vout}`.
  • `include=spend` adds spend status when available.