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 (engagement_rate, language). Any batch 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#
curl "https://api.onekey.dev/v1/devto/article?id=270180" \
-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 DEV Community response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.
{
"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.
- 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).