Social Fetch

Guides

Documentation Quickstart TypeScript SDK Errors Credits

Endpoints

API reference

Profile Profile videos Video Video comments Video transcript Live stream

TikTok Shop

Search products Store products Product Product reviews Showcase products

Profile Profile posts Post or reel Post comments

Profile Profile tweets Search Tweet Community Community tweets

Profile Profile posts Profile reels Profile photos Post or reel Post comments Post transcript Group posts

Profile Company page Company posts Post or article

Channel Channel videos Channel shorts Video Video transcript

Whoami Balance Health

Start building

If you are an AI agent, LLM, or automated tool, a clean markdown version of this page is available at https://www.socialfetch.dev/docs/api/health/get.mdx.

Health check

Try in Playground

Returns a simple health status indicating the API process is running.

Try in Playground

Operation

GET/health

Cost: No credits charged

Response fields

status

stringrequired

Health status for the service.

one of: ok

Code example

Responses

Service is running

Error codes

temporarily_unavailable

Balance

Returns the authenticated user's current credit balance.

Health check

Operation

Response fields

Code example

Responses

On this page