# devto.article

**stable** **Standard**

A DEV article by id.

`GET /v1/devto/article`

## What you get

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

**Also works with:** [Computed block](https://onekey.dev/docs/computed.md) (`engagement_rate`, `language`). Any [batch](https://onekey.dev/docs/batch.md) can include it.

## 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 |
| --- | --- | --- | --- | --- | --- |
| `id` | string | yes | (required) | Article id | max 10 chars; must match `[0-9]{1,10}`; trimmed |

## Request

```bash
curl "https://api.onekey.dev/v1/devto/article?id=270180" \
  -H "x-api-key: YOUR_API_KEY"
```

```python
import requests

res = requests.get(
    "https://api.onekey.dev/v1/devto/article",
    params={"id": "270180"},
    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({ id: "270180" });
const res = await fetch(`https://api.onekey.dev/v1/devto/article?${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 DEV Community response, recorded and returned in Onekey's shape. Fields the platform does not provide are `null`.

```json
{
  "success": true,
  "data": {
    "content": {
      "id": "270180",
      "title": "Changelog: Query the DEV API from a JavaScript Frontend!",
      "url": "https://dev.to/devteam/changelog-query-the-dev-api-from-a-javascript-frontend-329j",
      "text": "We recently updated the DEV API to allow it to be queried directly from JavaScript frontends....",
      "createdAt": "2020-02-27T16:12:29Z",
      "language": null
    },
    "author": {
      "username": "rhymes",
      "displayName": "rhymes",
      "id": "2693",
      "avatarUrl": "https://media2.dev.to/dynamic/image/width=640,height=640,fit=cover,gravity=auto,format=auto/https%3A%2F%2Fdev-to-uploads.s3.us-east-2.amazonaws.com%2Fuploads%2Fuser%2Fprofile_image%2F2693%2Fbfd9a4a5-92b3-4ac3-a276-3ccb68d78203.jpg"
    },
    "engagement": {
      "likes": 84,
      "comments": 5,
      "views": null
    },
    "media": {
      "thumbnailUrl": null
    },
    "ext": {
      "contentBody": "We recently updated the [DEV API](https://docs.dev.to/api) to allow it to be queried directly from JavaScript frontends.\n\n{% github https://github.com/thepracticaldev/dev.to/pull/6116 %}\n\nA persistent problem with querying the DEV API is the [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) restriction. `CORS` (Cross-Origin Resource Sharing) is a built-in mechanism that enables browsers to access resources belonging to another origin when initialized by scripts. This mechanism means that a page at `http://example.com` can only access data at its *own* resources (for example, `example.com/hello`) but it cannot access a resource at another domain (for example, `anotherdomain.com/hello`). If the HTTP server on `anotherdomain.com` wants to let a script running on `http://example.com` (or any other website) access its own resources, it has to do it through `CORS`.\n\nFor DEV community members, this restriction meant that having to create [some workarounds](https://dev.to/jrsofty/cors-problem-workaround-for-consuming-dev-to-api-on-your-website-44jb) for this issue. But with this change, everyone can now retrieve publicly-available endpoints directly from their own browsers. The one caveat here is that the endpoints that can be queried are limited to the ones that require no authorization (ie. no `api-key` header).\n\nHere's an example of a query to the `/api/articles` endpoint from the JavaScript console:\n\n![Alt Text](https://dev-to-uploads.s3.amazonaws.com/i/ftm5s1l4nqpmx",
      "readingTimeMinutes": 1
    }
  },
  "metadata": {
    "platform": "devto",
    "endpoint": "article",
    "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](https://onekey.dev/docs/schema.md). Fields the source lacks come back as `null`.

| Source path | Onekey field | Transform |
| --- | --- | --- |
| `id` | `content.id` | `toString` |
| `title` | `content.title` | - |
| `url` | `content.url` | `safeUrl` |
| `description` | `content.text` | - |
| `published_at` | `content.createdAt` | `toIsoDate` |
| `language` | `content.language` | - |
| `user.username` | `author.username` | - |
| `user.name` | `author.displayName` | - |
| `user.user_id` | `author.id` | `toString` |
| `user.profile_image` | `author.avatarUrl` | `safeUrl` |
| `public_reactions_count` | `engagement.likes` | `toNumber` |
| `comments_count` | `engagement.comments` | `toNumber` |
| `cover_image` | `media.thumbnailUrl` | `safeUrl` |
| `body_markdown` | `ext.contentBody` | - |
| `page_views_count` | `engagement.views` | `toNumber` |
| `reading_time_minutes` | `ext.readingTimeMinutes` | `toNumber` |

## 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](https://onekey.dev/pricing); 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](https://onekey.dev/docs/errors.md) for the full list and retry guidance.

Status: stable (verified against the live source).