> **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):** <https://www.socialfetch.dev/docs/api/v1/hugging-face/accounts/name/get>
- **Markdown (.mdx) URL:** <https://www.socialfetch.dev/docs/api/v1/hugging-face/accounts/name/get.mdx>

## 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:** <https://www.socialfetch.dev/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 Hugging Face account (https://www.socialfetch.dev/docs/api/v1/hugging-face/accounts/name/get)

## Summary

Get a Hugging Face user or organization with its counts, organizations and profile text.

**Tags:** `Hugging Face`

## HTTP

- **Method:** GET
- **Path:** `/v1/hugging-face/accounts/{name}`
- **Base URL:** `https://api.socialfetch.dev`

## Capability summary

- **SDK mapping:** `client.huggingFace.getAccount({ name: "huggingface" })`
- **Accepted identifiers:** `name` (path)
- **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

### `name` (path)

- **Required:** yes
- **Constraints:** type `string`; pattern: `^[A-Za-z0-9][A-Za-z0-9._-]{0,95}$`
- **Description:** Hugging Face user or organization name, e.g. `clem`.

### `include` (query)

- **Required:** no
- **Constraints:** type `string`
- **Description:** Extra blocks, comma-separated. `socials` adds the social handles.

## Responses (status codes)

- **200**: Account details.
- **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)

Account details.

### Field outline

- **data** (required) — type `object`. Endpoint-specific response payload.
  - **lookupStatus** (required) — type `string`; enum: found, not_found. Whether the item was found.
  - **account** (required) — type `object`; nullable. The account when lookupStatus is `found`; otherwise null.
    - **type** (required) — type `string`; enum: user, org. Whether the account is a user or an organization.
    - **username** (required) — type `string`. Account name.
    - **uid** (required) — type `string`; nullable. Stable account id.
    - **displayName** (required) — type `string`; nullable. Display name.
    - **url** (required) — type `string`. Profile page URL.
    - **avatarUrl** (required) — type `string`; nullable. Avatar image URL.
    - **bio** (required) — type `string`; nullable. Profile text.
    - **joinedAt** (required) — type `string`; nullable. When the account was created (ISO-8601). Users only.
    - **isPro** (required) — type `boolean`; nullable. Whether the account has a Pro subscription (users).
    - **isVerified** (required) — type `boolean`; nullable. Whether the organization is verified.
    - **plan** (required) — type `string`; nullable. Organization plan, e.g. `team` or `enterprise`.
    - **counts** (required) — type `object`. Public counts. A count that does not apply to the account is null.
      - **models** (required) — type `integer`; nullable. Public models.
      - **datasets** (required) — type `integer`; nullable. Public datasets.
      - **spaces** (required) — type `integer`; nullable. Public Spaces.
      - **papers** (required) — type `integer`; nullable. Papers.
      - **kernels** (required) — type `integer`; nullable. Kernels.
      - **buckets** (required) — type `integer`; nullable. Storage buckets.
      - **discussions** (required) — type `integer`; nullable. Discussions the account took part in (users).
      - **upvotes** (required) — type `integer`; nullable. Upvotes the account received (users).
      - **likes** (required) — type `integer`; nullable. Repositories the account liked (users).
      - **followers** (required) — type `integer`; nullable. Followers.
      - **following** (required) — type `integer`; nullable. Accounts followed (users).
      - **followingOrganizations** (required) — type `integer`; nullable. Organizations followed (users).
      - **members** (required) — type `integer`; nullable. Members (organizations).
    - **organizations** (required) — type `array`. Organizations a user belongs to.
      - _items:_
    - **primaryOrganizationAvatarUrl** (required) — type `string`; nullable. Avatar of the organization a user shows on their profile.
    - **hardware** (required) — type `array`. Hardware a user lists on their profile.
      - _items:_
    - **socials** (required) — type `object`; nullable. Social handles. Only with `include=socials`; otherwise null.
      - **twitter** (required) — type `string`; nullable. X (Twitter) handle.
      - **github** (required) — type `string`; nullable. GitHub handle.
      - **linkedin** (required) — type `string`; nullable. LinkedIn handle.
      - **bluesky** (required) — type `string`; nullable. Bluesky handle.
- **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",
    "account": {
      "type": "org",
      "username": "huggingface",
      "uid": "5e67bd5b1009063689407478",
      "displayName": "Hugging Face",
      "url": "https://huggingface.co/huggingface",
      "avatarUrl": "https://cdn-avatars.huggingface.co/v1/production/uploads/1583856921041-5dd96eb166059660ed1ee413.png",
      "bio": "The AI community building the future.",
      "joinedAt": null,
      "isPro": null,
      "isVerified": true,
      "plan": "team",
      "counts": {
        "models": 18,
        "datasets": 50,
        "spaces": 48,
        "papers": 10,
        "kernels": 0,
        "buckets": 12,
        "discussions": null,
        "upvotes": null,
        "likes": null,
        "followers": 109753,
        "following": null,
        "followingOrganizations": null,
        "members": 188
      },
      "organizations": [],
      "primaryOrganizationAvatarUrl": null,
      "hardware": [],
      "socials": null
    }
  },
  "meta": {
    "requestId": "req_69eb3528-3ac2-45a7-ac1f-899dc9175ac5",
    "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.huggingFace.getAccount({
  name: "huggingface",
});

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/hugging-face/accounts/huggingface",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

const data = await response.json();
console.log(data);
```

### cURL

```bash
curl "https://api.socialfetch.dev/v1/hugging-face/accounts/huggingface" \
  -H "x-api-key: YOUR_API_KEY"
```

### Python

```python
import requests

response = requests.get(
    "https://api.socialfetch.dev/v1/hugging-face/accounts/huggingface",
    headers={"x-api-key": "YOUR_API_KEY"},
)
data = response.json()
print(data)
```