Pipixia profile API
Pipixia profile data in one REST call — normalized to the stable JSON schema shared across every FetchPI platform.
- 1 documented endpoints
- GET /v1/pipixia/users/{username}
Contract summary (English): Get a normalized Pipixia profile (capability pipixia.profile)
- Normalized response entity
- pipixia/profile
- capability
- pipixia.profile
Every response also carries freshness (cache / default / live) and billing metadata.
Use cases
- Enrich CRM and outreach tooling with up-to-date {{platform}} profile data — follower counts, verification status and bios as structured JSON.
- Screen creator and partner accounts before a campaign with consistent, queryable profile metrics.
- Re-query the same handle and diff the normalized fields to track profile changes over time.
Response fields
Pipixia Profile (normalized)
Normalized Pipixia profile — the ONLY upper-layer format; provider-private fields are dropped by the Normalizer. Serves pipixia.profile and the user lists of /v1/pipixia.
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | Required | Platform-stable user id (numeric user_id / cell_id / hashtag_id). |
| platform | "pipixia" | Required | — |
| type | "profile" | Required | — |
| username | string | Required | The platform addressing/display key without leading @. |
| display_name | string | null | Optional | The profile display name. |
| description | string | null | Optional | The profile bio. |
| url | string | null | Optional | The profile/bio link. |
| profile_image_url | string | null | Optional | Avatar media URL. |
| verified | boolean | Required | Platform verification flag. |
| created_at | string | null | Optional | Account creation time, UTC RFC3339; null when the provider does not expose it. |
| metrics.followers | integer | Required | Follower count. |
| metrics.following | integer | Required | Following count. |
| metrics.posts | integer | Required | Published post/message/work count. |
| fetched_at | string | Required | Normalization time of the stored snapshot (UTC). |
Field notes are shown in the contract's original English.
Response meta
| Field | Type | Required | Description |
|---|---|---|---|
| mode | cache | default | live | Required | Effective mode after merging param > max_age > source policy (D-004). |
| age_seconds | integer | null | Optional | Age of served data; null when unknown. |
| source_layer | cache | db | upstream | Required | Which layer served the response (PRD §10). |
| stale | boolean | Optional | True when stale data was served under stale_if_error / SWR (D-004). |
| billing.amount_credits | integer | Required | Micro-USD (1e-6 USD) actually charged for this request. |
| billing.cache_hit | boolean | Required | — |
Field notes are shown in the contract's original English.
Example request & response
/v1/pipixia/users/{username}curl -H "Authorization: Bearer $MESHDATA_API_KEY" \
"https://api.fetchpi.com/v1/pipixia/users/newdev"{
"data": {
"id": "9255000122",
"platform": "pipixia",
"type": "profile",
"username": "皮皮虾数据站",
"display_name": "皮皮虾数据站",
"description": "皮皮虾数据开放。",
"profile_image_url": "https://cdn.example.com/avatar/pipixia-meshdata.jpg",
"verified": false,
"created_at": "2021-06-30T17:33:20Z",
"metrics": {
"followers": 456000,
"following": 64,
"posts": 1320
},
"fetched_at": "2026-09-21T09:00:00Z"
},
"meta": {
"request_id": "req_01HTXQ8Z9HTQ",
"freshness": {
"mode": "default",
"age_seconds": 0,
"source_layer": "upstream",
"stale": false
},
"billing": {
"amount_credits": 100,
"cache_hit": false
}
}
}Free demo
Create a free account, grab an API key and call this endpoint from the browser-based Playground.
Try it in the PlaygroundParameter tables, error codes and response semantics for this endpoint live in the API documentation.
Open the endpoint referenceFrequently asked questions
What does the Pipixia profile API return?
A normalized profile object — identity, bio and audience fields as defined in the field table below — plus freshness and billing metadata.
Can I try this endpoint for free?
Yes — register an account, grab an API key and call it from the Playground in the console.
How is the profile capability billed?
Data API calls are billed per request in credits, with different cache/live freshness multipliers. Current per-capability prices live on the pricing page.
Pricing
Per-request credit billing with cache/live freshness options — current prices live on the pricing page.