> **For coding agents and LLMs:** This is one page from the Social Fetch docs (markdown export). For curated orientation and workflow guidance, start with [`/llms.txt`](https://www.socialfetch.dev/llms.txt); for agent onboarding and crawl rules, use [`/agents.txt`](https://www.socialfetch.dev/agents.txt); for the full endpoint list with links to pages like this one, use [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt); for one platform's parameters and curls, use [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt); use [`/llms.json`](https://www.socialfetch.dev/llms.json) when you need structured JSON for tool registration. ## This page - **On-site (HTML):** - **Markdown (.mdx) URL:** ## API base URL and authentication - **API origin (from OpenAPI `servers`):** `https://api.socialfetch.dev` - **Authentication:** send `x-api-key: sfk_...` on `/v1/**` and `/v2/**` routes unless the operation is explicitly anonymous (check OpenAPI `security`, the [API reference hub](https://www.socialfetch.dev/docs/api.mdx), [`/llms.txt`](https://www.socialfetch.dev/llms.txt), or [`/llms.json`](https://www.socialfetch.dev/llms.json) for each route). - **OpenAPI JSON:** ## Recommended docs entrypoints (this site) - [Documentation overview](https://www.socialfetch.dev/docs.mdx) — top-level orientation (markdown). - [Quickstart](https://www.socialfetch.dev/docs/quickstart.mdx) — authenticate with `x-api-key`, validate auth with `whoami`, and understand the JSON envelope. - [SDK](https://www.socialfetch.dev/docs/sdk.mdx) — official TypeScript SDK guide, including `SocialFetchClient`, `Result`, and `unwrap()`. - [Capability matrix](https://www.socialfetch.dev/docs/capability-matrix.mdx) — every operation with identifiers, pagination, outcomes, media download, credits, and its SDK method. Generated from OpenAPI, so use it for route selection instead of scanning individual pages. - [Recipes](https://www.socialfetch.dev/docs/recipes.mdx) — copyable workflows (brand monitoring, transcripts, Ad Library, creator scoring, Reddit research) with credit callouts and SDK examples. - [Integrations](https://www.socialfetch.dev/docs/integrations.mdx) — MCP for AI clients, n8n verified node, Apify Store Actors, Make custom app, SDK, and REST API connection paths. - [MCP product page](https://www.socialfetch.dev/mcp) — hosted MCP overview, OAuth, Skills install. - [MCP integration](https://www.socialfetch.dev/docs/integrations/mcp.mdx) — hosted `/mcp` server, OAuth, Cursor/VS Code/Claude install snippets, 910 endpoint tools, plus docs_search/docs_read for implementation help. - [n8n integration](https://www.socialfetch.dev/docs/integrations/n8n.mdx) — install `n8n-nodes-socialfetch`, credentials, and workflow examples. - [Apify integration](https://www.socialfetch.dev/docs/integrations/apify.mdx) — Store Actors under @social-fetch, PPE billing, dataset export, and quick start. - [Make integration](https://www.socialfetch.dev/docs/integrations/make.mdx) — custom app modules for Make scenarios, API key credentials, and module catalog. - [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt) — every documented operation with a direct link to that route's agent-readable markdown page (prefer this over parsing OpenAPI). - [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt) — per-platform endpoint files generated from OpenAPI (parameters, credits, curls). - [`/agents.txt`](https://www.socialfetch.dev/agents.txt) — agent crawl/onboarding file with capabilities, auth rules, and allowlist. - [`/llms.json`](https://www.socialfetch.dev/llms.json) — structured machine-readable operation inventory with parameter names, pagination, outcomes, credits, and SDK mapping. - [API reference hub](https://www.socialfetch.dev/docs/api.mdx) — human-friendly index of operations with links into generated pages. - [Errors](https://www.socialfetch.dev/docs/errors.mdx) — shared error envelope and HTTP status guidance. - [Credits](https://www.socialfetch.dev/docs/credits.mdx) — metering, `402`, and planning batch jobs. - Outcome semantics such as `found`, `not_found`, and `private` are documented in [Errors](https://www.socialfetch.dev/docs/errors.mdx) and on operation pages when present in the OpenAPI contract. ## Markdown docs convention - Every docs page has a markdown twin: append **`.mdx`** to the docs pathname (for example `/docs/quickstart` → `/docs/quickstart.mdx`). - Agents that send `Accept: text/markdown` on `/docs/**` HTML URLs may receive markdown directly (same URL, `Vary: Accept`). - Published blog posts use the same convention: `/blog/{slug}` → `/blog/{slug}.mdx`, or `Accept: text/markdown` on the HTML URL (`Vary: Accept`). --- # Get Dev.to profile (https://www.socialfetch.dev/docs/api/v1/dev-to/user/profile/get) ## Summary Get a Dev.to profile page: post, comment and tag counts, badges, work, skills and GitHub repositories. **Tags:** `Dev.to` ## HTTP - **Method:** GET - **Path:** `/v1/dev-to/user/profile` - **Base URL:** `https://api.socialfetch.dev` ## Capability summary - **SDK mapping:** `client.devTo.getUserProfile({ username: "ben" })` - **Accepted identifiers:** `username` (query) - **Pagination:** none - **Business outcome field:** `data.lookupStatus` with values `found`, `not_found` ## Credits - **Base:** 1 credit per successful lookup. - **Maximum on success (200):** 1 credit. - **Failed requests (`lookup_failed`, `503`):** not charged. - **Authoritative field:** `meta.creditsCharged`. ## Authentication - **`x-api-key`**: API key (`sfk_...`) ## Parameters ### `username` (query) - **Required:** yes - **Constraints:** type `string`; minLength: 1; maxLength: 40; pattern: `^[a-z0-9_][a-z0-9_-]{0,39}$` - **Description:** Dev.to username, e.g. `ben`. A profile URL such as https://dev.to/ben is also accepted. ## Responses (status codes) - **200**: Dev.to profile. - **400**: Invalid request - **401**: Missing or invalid API key - **402**: Insufficient credits - **500**: Unexpected or billing error - **502**: Lookup could not be completed. - **503**: Service temporarily unavailable; safe to retry with backoff. ## Response body (200) Dev.to profile. ### Field outline - **data** (required) — type `object`. Endpoint-specific response payload. - **lookupStatus** (required) — type `string`; enum: found, not_found. Whether the item was found. - **listedOnSite** (required) — type `boolean`; nullable. False when the user exists but Dev.to does not list the profile publicly. Only the basic fields are filled then. Null when not found. - **profile** (required) — type `object`; nullable. The profile when found; otherwise null. - **id** (required) — type `integer`; nullable. Numeric user id. - **username** (required) — type `string`. Username. - **name** (required) — type `string`; nullable. Display name. - **bio** (required) — type `string`; nullable. Short bio. - **location** (required) — type `string`; nullable. Location the user lists. - **avatarUrl** (required) — type `string`; nullable. Profile picture URL. - **joinedAt** (required) — type `string`; nullable. When the user joined (ISO-8601). - **pronouns** (required) — type `string`; nullable. Pronouns, if listed. - **work** (required) — type `string`; nullable. Work, if listed. - **education** (required) — type `string`; nullable. Education, if listed. - **skills** (required) — type `string`; nullable. Skills and languages, if listed. - **currentlyLearning** (required) — type `string`; nullable. What the user is currently learning. - **currentlyHackingOn** (required) — type `string`; nullable. What the user is currently hacking on. - **availableFor** (required) — type `string`; nullable. What the user is available for. - **postsPublished** (required) — type `integer`; nullable. Posts the user has published. - **commentsWritten** (required) — type `integer`; nullable. Comments the user has written. - **tagsFollowed** (required) — type `integer`; nullable. Tags the user follows. - **isSubscriber** (required) — type `boolean`. Whether the user has the subscriber badge. - **isCommunityCurator** (required) — type `boolean`. Whether the user is a community curator. - **links** (required) — type `array`. Social links listed. - _items:_ - **organizations** (required) — type `array`. Organizations the user belongs to. - _items:_ - **githubRepositories** (required) — type `array`. Public GitHub repositories the user chose to show. - _items:_ - **badges** (required) — type `array`. Badges the user has earned. - _items:_ - **pinnedPosts** (required) — type `array`. Posts the user pinned to the top of the profile, in the order shown. Empty when none are pinned. - _items:_ - **meta** (required) — type `object`. Metadata describing the request and billing outcome. - **requestId** (required) — type `string`; minLength: 1. Unique request identifier for tracing this API call. - **creditsCharged** (required) — type `integer`; minimum: 0. Credits charged for this request. - **version** (required) — type `string`; enum: v1. Public API version that served the response. ### Example JSON (found) ```json { "data": { "lookupStatus": "found", "listedOnSite": true, "profile": { "id": 1, "username": "ben", "name": "Ben Halpern", "bio": "A Canadian software developer who thinks he’s funny.", "location": "NY", "avatarUrl": "https://media2.dev.to/dynamic/image/width=320,height=320,fit=cover,gravity=auto,format=auto/https%3A%2F%2Fdev-to-uploads.s3.us-east-2.amazonaws.com%2Fuploads%2Fuser%2Fprofile_image%2F1%2Fbabb96d0-9cd2-49bc-a412-2dc4caf94c2a.png", "joinedAt": "2015-12-27T04:02:17.000Z", "pronouns": "He/him", "work": "Co-founder of DEV", "education": "Mount Allison University", "skills": "I mostly do web development in Ruby and JavaScript, but I'm curious about a lot of other languages and tools. Experiment with lots.", "currentlyLearning": "Dabbling in all the technology needed to scale our site, on the human side and the computer side.", "currentlyHackingOn": "I'm working on this website that you're reading. It's fun.", "availableFor": null, "postsPublished": 2014, "commentsWritten": 11070, "tagsFollowed": 86, "isSubscriber": true, "isCommunityCurator": true, "links": [ { "label": "Personal website", "url": "http://benhalpern.com/" } ], "organizations": [ { "username": "devteam", "name": "The DEV Team" } ], "githubRepositories": [ { "name": "benhalpern.github.io", "url": "https://github.com/benhalpern/benhalpern.github.io", "description": "Ben Halpern's personal page", "language": "HTML", "stars": 30 } ], "badges": [ { "title": "Community Favorite 8", "timesAwarded": 1, "description": "Community curators have picked eight of your posts as their favorite gems!", "imageUrl": "https://media2.dev.to/dynamic/image/width=192,height=,fit=scale-down,gravity=auto/https%3A%2F%2Fdev-to-uploads.s3.us-east-2.amazonaws.com%2Fuploads%2Fbadge%2Fbadge_image%2F482%2FNew_Project__6_.webp" } ], "pinnedPosts": [ { "id": 616024, "title": "My Public Inbox", "url": "https://dev.to/ben/my-public-inbox-4bj8", "publishedAt": "2021-02-23T19:25:47.000Z", "tags": [ "ama" ], "reactionsCount": 193, "commentsCount": 149, "readingTimeMinutes": 1 } ] } }, "meta": { "requestId": "req_4f3c873c-328e-4bae-8160-440bdfcc8e27", "creditsCharged": 1, "version": "v1" } } ``` ### Machine-readable error codes When an error JSON body is returned, it may include one of these `error.code` values (derived from the OpenAPI schemas for this operation; additional codes may exist at runtime): - `bad_request` ## Error handling & retries Interpret HTTP status codes using the descriptions below. Do not assume a JSON body unless the OpenAPI schema defines one for that status. - **400**: Invalid request **Retry:** Fix the request; retrying the same invalid payload will not help. - **401**: Missing or invalid API key **Retry:** Fix the API key first; retrying without changes will not help. - **402**: Insufficient credits **Retry:** Do not retry without resolving billing/credits (retrying the same request will not help). - **500**: Unexpected or billing error - **502**: Lookup could not be completed. **Retry:** May be transient; a few retries with backoff are reasonable. - **503**: Service temporarily unavailable; safe to retry with backoff. **Retry:** Usually safe to retry with exponential backoff and jitter. ### Suggested client defaults - Send the API key using the `x-api-key` header on every request. - On `503` (and sometimes `502`), retry with backoff; cap retries and surface a clear error to the user. - On `402`, surface an actionable billing message rather than blind retries. ## Examples ### TypeScript SDK ```typescript import { SocialFetchClient } from "@socialfetch/sdk"; const client = new SocialFetchClient({ apiKey: process.env.SOCIALFETCH_API_KEY!, }); const result = await client.devTo.getUserProfile({ username: "ben", }); if (!result.ok) { console.error(result.error); } else { console.log(result.value.data); } ``` ### Node.js ```javascript const response = await fetch( "https://api.socialfetch.dev/v1/dev-to/user/profile?username=ben", { headers: { "x-api-key": "YOUR_API_KEY" } } ); const data = await response.json(); console.log(data); ``` ### cURL ```bash curl "https://api.socialfetch.dev/v1/dev-to/user/profile?username=ben" \ -H "x-api-key: YOUR_API_KEY" ``` ### Python ```python import requests response = requests.get( "https://api.socialfetch.dev/v1/dev-to/user/profile?username=ben", headers={"x-api-key": "YOUR_API_KEY"}, ) data = response.json() print(data) ```