# URL Unshorten API

> Follows a shortened or tracking URL to its real destination and returns every hop it went through.

- Endpoint: `POST https://grist.tools/v1/url-unshorten`
- Price: $0.002 per successful call, paid via x402 in USDC on Base
- Timeout: 10 s; max_timeout_seconds in the 402: 31 (the timeout plus payment verification and settlement)
- Response cap: 64 KB (65,536 bytes)
- Family: [Fetch & extract](https://grist.tools/tools/fetch)
- Input schema, free: https://grist.tools/v1/url-unshorten/schema
- Updated: 2026-11-13

## When to use it

Resolving a short link needs the network, and doing it safely needs a hardened client: an agent that follows the redirects itself will happily walk into a private address or a redirect loop.

## When not to use it

- The destination needs more than 10 s to answer: the call ends with upstream_timeout (424).
- The destination is on a private or local network: the network guard refuses it with blocked_target (403).

## Parameters

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `url` | string | yes | The short or tracking URL to follow, up to 2048 characters; every hop, the first included, goes through the SSRF guard. |
| `max_hops` | integer | no | Most redirects to follow, 1 to 10, default 10; a chain that has not ended by then fails as unprocessable, and a meta refresh at the limit stops with stopped_reason hop_limit. Default: 10. |
| `method` | string | no | auto sends HEAD and retries the same hop with GET on a 400, 403, 405 or 501; head and get force one method for every hop. One of: "auto", "head", "get". Default: "auto". |
| `follow_meta_refresh` | boolean | no | Whether to also follow an HTML meta refresh with a delay of 30 seconds or less, found in the first 64 KiB of a 2xx HTML or untyped page; method head turns it off, and JavaScript redirects are never followed. Default: false. |

## Limits

| Limit | Value |
| --- | --- |
| Size cap | 64 KB (65,536 bytes) |
| Timeout | 10 s |

## Example

Request:

```http
POST /v1/url-unshorten
content-type: application/json
payment-signature: <base64 x402 payload>

{
  "url": "https://grist.tools/samples/web/unshorten-start.html",
  "max_hops": 10,
  "follow_meta_refresh": true
}
```

Response (200 OK, with a payment-response settlement receipt header):

```json
{
  "requested_url": "https://grist.tools/samples/web/unshorten-start.html",
  "source_url": "https://grist.tools/samples/web/unshorten-start.html",
  "final_url": "https://grist.tools/samples/web/unshorten-landing.html",
  "final_status": 200,
  "final_host": "grist.tools",
  "final_content_type": "text/html; charset=utf-8",
  "hop_count": 1,
  "reached_final": true,
  "stopped_reason": null,
  "cross_host": false,
  "hops": [
    {
      "url": "https://grist.tools/samples/web/unshorten-start.html",
      "method": "GET",
      "status": 200,
      "location": "unshorten-landing.html",
      "resolved_location": "https://grist.tools/samples/web/unshorten-landing.html",
      "kind": "meta_refresh",
      "host": "grist.tools"
    },
    {
      "url": "https://grist.tools/samples/web/unshorten-landing.html",
      "method": "GET",
      "status": 200,
      "location": null,
      "resolved_location": null,
      "kind": "final",
      "host": "grist.tools"
    }
  ],
  "initial_host_is_known_shortener": false,
  "shortener_list_version": "2026-08-26",
  "checked_at": "2026-09-01T12:00:00.000Z",
  "fetched_at": "2026-09-01T12:00:00.000Z"
}
```

Sample file: web/unshorten-start.html. Tiny HTML page whose only job is a zero-delay meta refresh to unshorten-landing.html, standing in for a short link served as a static file. Sample file: web/unshorten-landing.html. Tiny HTML landing page with a heading and one sentence and no redirect, the end of the unshorten-start.html chain.

Response fields:

| Field | Type | In the example |
| --- | --- | --- |
| `requested_url` | string | "https://grist.tools/samples/web/unshorten-start.html" |
| `source_url` | string | "https://grist.tools/samples/web/unshorten-start.html" |
| `final_url` | string | "https://grist.tools/samples/web/unshorten-landing.html" |
| `final_status` | number | 200 |
| `final_host` | string | "grist.tools" |
| `final_content_type` | string | "text/html; charset=utf-8" |
| `hop_count` | number | 1 |
| `reached_final` | boolean | true |
| `stopped_reason` | null | null |
| `cross_host` | boolean | false |
| `hops` | array | 2 items, each with url, method, status, location, resolved_location, kind and host |
| `initial_host_is_known_shortener` | boolean | false |
| `shortener_list_version` | string | "2026-08-26" |
| `checked_at` | string | "2026-09-01T12:00:00.000Z" |
| `fetched_at` | string | "2026-09-01T12:00:00.000Z" |

## Call it from code

```js
// url-unshorten: $0.002 per call, paid in USD Coin on eip155:8453 via x402
// Install: npm install @x402/fetch@2 @x402/evm@2 viem@2
// Save as client.mjs (ES module, Node 18+), export EVM_PRIVATE_KEY with the paying wallet's key in your shell, then run: node client.mjs
// The wrapper reads the 402 (payment-required), signs and retries with payment-signature.
import { wrapFetchWithPayment, x402Client, decodePaymentResponseHeader } from '@x402/fetch'
import { ExactEvmScheme } from '@x402/evm/exact/client'
import { privateKeyToAccount } from 'viem/accounts'

const account = privateKeyToAccount(process.env.EVM_PRIVATE_KEY)
const client = new x402Client().register('eip155:8453', new ExactEvmScheme(account))
const fetchWithPayment = wrapFetchWithPayment(fetch, client)

const body = {
  "url": "https://grist.tools/samples/web/unshorten-start.html",
  "max_hops": 10,
  "follow_meta_refresh": true
}

const res = await fetchWithPayment('https://grist.tools/v1/url-unshorten', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify(body),
})
console.log(res.status, await res.json())
const settle = res.headers.get('payment-response')
if (settle) console.log(decodePaymentResponseHeader(settle).transaction)
```

```python
# url-unshorten: $0.002 per call, paid in USD Coin on eip155:8453 via x402
# Install: pip install "x402[requests,evm]>=2.24,<3"
# The session reads the 402 (payment-required), signs and retries with payment-signature.
import os
from eth_account import Account
from x402 import x402ClientSync
from x402.http import decode_payment_response_header
from x402.http.clients.requests import x402_requests
from x402.mechanisms.evm.exact import register_exact_evm_client
from x402.mechanisms.evm.signers import EthAccountSigner

account = Account.from_key(os.environ["EVM_PRIVATE_KEY"])
client = x402ClientSync()
register_exact_evm_client(client, EthAccountSigner(account), networks="eip155:8453")
session = x402_requests(client)

payload = {
    "url": "https://grist.tools/samples/web/unshorten-start.html",
    "max_hops": 10,
    "follow_meta_refresh": True
}

res = session.post("https://grist.tools/v1/url-unshorten", json=payload)
print(res.status_code, res.json())
settle = res.headers.get("payment-response")
if settle:
    print(decode_payment_response_header(settle).transaction)
```

```sh
# url-unshorten: $0.002 per call, paid in USD Coin on eip155:8453 via x402
# 1. Unpaid call: HTTP 402, the requirements in the payment-required header (base64 JSON) and in the body.
curl -i -X POST 'https://grist.tools/v1/url-unshorten' -H 'content-type: application/json' -d '{"url":"https://grist.tools/samples/web/unshorten-start.html","max_hops":10,"follow_meta_refresh":true}'

# 2. Same call with the signed payment (an EIP-3009 authorization, EIP-712 signed: it cannot be
#    typed by hand). x-payment is accepted as the v1 alternative. HTTP 200 carries payment-response.
curl -i -X POST 'https://grist.tools/v1/url-unshorten' -H 'content-type: application/json' -H 'payment-signature: <base64 x402 payload>' -d '{"url":"https://grist.tools/samples/web/unshorten-start.html","max_hops":10,"follow_meta_refresh":true}'
```

## Errors

Every error is typed JSON. Only a successful call is settled.

| Code | HTTP | When |
| --- | --- | --- |
| `invalid_input` | 400 | The body does not match the schema on this page. Nothing is charged. |
| `blocked_target` | 403 | The destination is refused by the network guard: a disallowed address, or, for HTTP requests, a scheme other than http/https, a port other than 80/443, or credentials in the URL. |
| `unreachable_target` | 424 | The destination you named did not resolve or refused the connection. |
| `upstream_timeout` | 424 | The destination you named did not answer before the declared timeout for this endpoint expired. |
| `unprocessable` | 422 | The bytes arrived but could not be processed, for instance a malformed document. |
| `internal` | 500 | Our fault, and in almost every case nothing is charged. The exceptions come after the call has run and the settlement call was made: the message "The work was done but settlement could not be completed", and the messages starting with "Payment settlement returned". There, whether the payment moved is unknown to us as well. The payment moves at most once: its nonce is single-use and settlement is idempotent, so a retry with it is never charged twice. A retry is normally refused with a 402: replay_consumed, an expiry reason, or a reason saying the nonce was already used once the transfer is on-chain. Only if our server restarted before the transfer was final can a retry run the call again. Even then, the payment moves at most once. To see whether it was settled, read the EIP-3009 authorizationState of its nonce on-chain; to call again, sign a new payment. |
| `rate_limited` | 429 | Too many calls from the same payer, or too many calls towards the same destination domain. Nothing is charged. |
| `concurrency_limit`, `registry_at_capacity`, `upstream_unavailable` | 503 | We could not serve the call right now. Retryable: wait the number of seconds in the retry-after header, then repeat the call. concurrency_limit and registry_at_capacity mean we were at capacity: the call did not run. You can send the same payment again if its validBefore is still far enough away to cover another call. If it is not, the retry gets a 402 authorization_validity_too_short: sign a new payment. upstream_unavailable means our internal service failed or did not answer in time: the call may already have run and the payment may have been settled. A retry with the same payment can get a 402 whose error field says why. authorization_validity_too_short: too little time is left before validBefore to cover another call. This check comes before the replay check, so it does not tell whether the first payment was settled. replay_consumed (the payment was used and may have been settled) or replay_exhausted (too many attempts): sign a new payment. replay_in_flight: the first call is still running, so wait and do not pay again. invalid_exact_evm_nonce_already_used: the transfer is already on-chain, so this payment cannot move again. Sign a new payment. An authorization can be settled only once, since its nonce is single-use. To see whether it was settled, read the EIP-3009 authorizationState of its nonce on-chain. |
| `misconfigured` | 503 | The service is not configured to serve calls. The call did not run and nothing is charged. It needs a fix on our side, so there is no retry delay to wait for. |

## Questions

### How much does a call to the URL Unshorten API cost?

$0.002 per call, paid in USD Coin on Base via x402. There is no account and no API key: the price is in the 402 answer, before anything is paid.

### What is the timeout of url-unshorten?

The endpoint itself runs for at most 10 s. max_timeout_seconds in the 402 answer is 31: that covers the whole call, including payment verification and settlement around it.

### How large can a response from url-unshorten be?

The response-size cap is 64 KB (65,536 bytes).

### Is the url-unshorten input schema free to read?

Yes. GET https://grist.tools/v1/url-unshorten/schema returns the input schema for free, paid endpoints included.

### What happens if a call to url-unshorten fails?

The payment is verified before the handler runs and settled only after it succeeds, so a call refused by the gate, or one that fails inside the handler, is never settled. The single case that cannot be stated in advance is a settlement call that fails without answering: the error message says so when that is what happened.

### What does url-unshorten return?

A JSON object with 15 top-level fields: requested_url, source_url, final_url, final_status, final_host, final_content_type, hop_count, reached_final, stopped_reason, cross_host, hops, initial_host_is_known_shortener, shortener_list_version, checked_at and fetched_at. The example on this page is a real call over web/unshorten-start.html and web/unshorten-landing.html.

## Related

- [Fetch & extract APIs](https://grist.tools/tools/fetch)
- [How AI agents pay for APIs with x402](https://grist.tools/guides/x402-payments-for-ai-agents)
- [All APIs](https://grist.tools/docs)

This page as HTML: https://grist.tools/docs/url-unshorten. Every page of grist.tools has a Markdown version at its address plus .md.
