# web.feed

**stable** **3 credits**

Parse an RSS 2.0/RSS 1.0/Atom/JSON Feed URL into normalized items.

`GET /v1/web/feed`

## What you get

A list of Web results in Onekey's unified shape, in `data` (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free `404 not_found` instead.

## What it costs

- **3 credits** 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 |
| --- | --- | --- | --- | --- | --- |
| `url` | string | yes | (required) | Absolute http(s) URL of the page (ports 80/443 only; private/internal hosts are refused) | max 2048 chars; must match `https?://[A-Za-z0-9](?:[A-Za-z0-9.-]{0,251}[A-Za-z0-9])?(?::(?:80\|443))?(?:[/?][\x21-\x5b\x5d-\x7e]*)?`; trimmed |

## Request

```bash
curl "https://api.onekey.dev/v1/web/feed?url=https%3A%2F%2Fgithub.blog%2Ffeed%2F" \
  -H "x-api-key: YOUR_API_KEY"
```

```python
import requests

res = requests.get(
    "https://api.onekey.dev/v1/web/feed",
    params={"url": "https://github.blog/feed/"},
    headers={"x-api-key": "YOUR_API_KEY"},
)
body = res.json()

if body["success"]:
    print(body["data"])
else:
    print(body["error"]["code"], body["error"]["message"])
```

```javascript
const params = new URLSearchParams({ url: "https://github.blog/feed/" });
const res = await fetch(`https://api.onekey.dev/v1/web/feed?${params}`, {
  headers: { "x-api-key": "YOUR_API_KEY" },
});
const body = await res.json();

if (body.success) console.log(body.data);
else console.error(body.error.code, body.error.message);
```

## Recorded response

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

```json
{
  "success": true,
  "data": [
    {
      "content": {
        "title": "How we found 24 Android vulnerabilities using our open source AI security agent",
        "url": "https://github.blog/security/how-we-found-24-android-vulnerabilities-using-our-open-source-ai-security-agent/",
        "id": "https://github.blog/?p=98105",
        "createdAt": "2026-09-28T19:00:00Z",
        "text": "A look at the targeted AI taskflows behind these findings, the critical Android bugs they uncovered, and how to run the same open-source agent on your own app. The post How we found 24 Android vulnerabilities using our open source AI security agent appeared first on The GitHub Blog."
      },
      "author": {
        "displayName": "Kevin Stubbings"
      },
      "media": {
        "url": null
      },
      "entity": {
        "tags": [
          "Security",
          "GitHub Security Lab"
        ]
      },
      "ext": {
        "enclosureUrl": null
      }
    },
    {
      "content": {
        "title": "Highlights from Git 2.56",
        "url": "https://github.blog/open-source/git/highlights-from-git-2-56/",
        "id": "https://github.blog/?p=99087",
        "createdAt": "2026-09-28T17:23:33Z",
        "text": "The open source Git project just released Git 2.56. Here is GitHub's look at some of the most interesting features and changes introduced since last time. The post Highlights from Git 2.56 appeared first on The GitHub Blog."
      },
      "author": {
        "displayName": "Elijah Newren"
      },
      "media": {
        "url": null
      },
      "entity": {
        "tags": [
          "Git",
          "Open Source"
        ]
      },
      "ext": {
        "enclosureUrl": null
      }
    }
  ],
  "metadata": {
    "platform": "web",
    "endpoint": "feed",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 3,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}
```

## Field mapping

How this endpoint's source fields become Onekey's [unified schema](https://onekey.dev/docs/schema.md). Fields the source lacks come back as `null`.

| Source path | Onekey field | Transform |
| --- | --- | --- |
| `title` | `content.title` | - |
| `url` | `content.url` | `safeUrl` |
| `id` | `content.id` | - |
| `publishedAt` | `content.createdAt` | `toIsoDate` |
| `author` | `author.displayName` | - |
| `summary` | `content.text` | - |
| `imageUrl` | `media.url` | `safeUrl` |
| `categories` | `entity.tags` | - |
| `enclosureUrl` | `ext.enclosureUrl` | `safeUrl` |

## Caching and freshness

- Fresh for about 10 minutes. Repeat calls in that window are served from cache and are free.
- Between 10 minutes and 1 hour 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 hour more (marked stale).
- A "not found" is remembered for 2 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](https://onekey.dev/pricing); your balance must cover the price. |
| 404 | `not_found` | Unknown endpoint path. |
| 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](https://onekey.dev/docs/errors.md) for the full list and retry guidance.

Status: stable (verified against the live source).