youtube

Get a YouTube channel's contact email and country. Try the 1-credit youtube/channel first: it already carries the email for some channels, and you are charged here only when an address is returned. A first read of an address behind the View email address button can take up to 5 minutes, so set your HTTP timeout to at least 300s; on a 503, retry after the Retry-After seconds

Returns the contact email a YouTube channel publishes, including the address behind its View email address control (author.ext.public_email), and the country listed on the channel (author.ext.country), together with the channel's id, handle, name, subscriber count and video count. CHECK THE CHEAP LANE FIRST: GET /v1/youtube/channel costs 1 credit and already returns author.ext.public_email when the channel writes an address into its public description, which covered 17% of a 12-channel sample. Call this endpoint only when that field came back null; it reads the About tab directly and found an address on a further 58% of the same sample. You are charged ONLY when an address is returned: a channel that publishes none costs 0 credits, and so does a channel that does not exist (404). An address behind the View email address button that has not been read before takes a few minutes to retrieve, and the call waits for it: allow up to 5 minutes before your HTTP client times out. If it is still not ready, the call answers 503 SERVICE_UNAVAILABLE with Retry-After: 300 and is not charged, and the same call made after that interval normally returns the address. Do not store public_email as empty on a 503.

get/youtube/channel/about

Request

Base URL: https://www.socialcrawl.dev/v1
URL: https://www.socialcrawl.dev/v1/youtube/channel/about
Auth: API key in header x-api-key

Query parameters

channelIdstring

YouTube channel ID. Can pass a channelId, handle or url (one of: channelId, handle, url; at least one required)

handlestring

YouTube channel handle without the @ symbol (one of: channelId, handle, url; at least one required)

urlstring

YouTube channel URL. Can pass a channelId, handle or url (one of: channelId, handle, url; at least one required)

contact_email'1'

Optional. When 1, also returns author.ext.contact_email: when the bio lists two or more email addresses, the one the creator gives for contacting them personally, copied verbatim from the bio. Null when there is one address or none, when every address belongs to a manager, agency or brand, or when the choice was not confident. author.ext.public_email is unchanged. No extra credits.

Headers

Cache-Controlstring

Send no-cache to bypass the response cache and force a live fetch. Billed at the normal endpoint cost; the fresh result is written back to cache for the next caller. Only the no-cache directive triggers this. See the Response Schema guide for details.

Idempotency-Keystring

Optional UUID that makes the request safely retriable. The key is reserved atomically per account before billing. A concurrent retry receives 409 IDEMPOTENCY_IN_PROGRESS with a Retry-After of 1 second while the original is young, growing to a quarter of the time it has been running (at most 30); a crashed reservation expires after 5 minutes. A replay keeps the cached payload immutable except for billing metadata: credits_used becomes 0, idempotent_replay becomes true, and credits_remaining is refreshed to the current balance. A known current balance appears in both the body and X-Credits-Remaining header; no balance row resolves to 0. On a transient lookup failure, body credits_remaining is null and X-Credits-Remaining is omitted. Completed outcomes expire after 24 hours. If the claim store is unavailable, the request fails closed before billing. GET endpoints do not combine idempotent replay with Server-Sent Events: use Accept: application/json when sending this header. The unsupported key-plus-SSE combination is rejected before billing.

Response

Successful response

successboolean required

Whether the request succeeded

platformstring required

Platform name

endpointstring required

API endpoint path

credits_usedinteger required

Number of credits consumed

credits_remaininginteger nullable required

Current account balance, or null when this response could not establish one. Free cache hits always return null because they do not establish an authoritative post-request balance. An idempotency replay also returns null when its current-balance lookup fails. It is never a fabricated zero, so a zero here means the account really is empty. The authoritative reading is the one on a billed response, which comes straight from the deduction.

request_idstring required

Unique request identifier for support

cachedboolean required

Whether the response was served from cache

idempotent_replayboolean

True only when this response is an idempotency replay

Example response

{
  "success": true,
  "platform": "youtube",
  "endpoint": "/v1/youtube/channel/about",
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "req-abc123",
  "idempotent_replay": true,
  "meta": {
    "hint": {
      "code": "search_multi",
      "message": "You searched \"matcha\" on 3 platforms one call at a time; /v1/search/multi returns each platform's own search rows in one call at the same price per platform, and a platform with no rows is not charged.",
      "method": "GET",
      "path": "/v1/search/multi?query=matcha&platforms=instagram,tiktok,youtube"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.