# Go-Fetch.io

> Developer docs for the Go-Fetch.io API: public posts, comments, profiles and search results from Instagram, TikTok, YouTube, Facebook and Google as JSON.

- [Introduction](https://docs.go-fetch.io/index.md): Public social data as JSON, through a REST API or the Python SDK.
- [Quickstart](https://docs.go-fetch.io/quickstart.md): Run your first job and read its results in five minutes.
- [Authentication](https://docs.go-fetch.io/authentication.md): API keys, their scopes, environments and expiry.
- [Jobs and results](https://docs.go-fetch.io/jobs-and-results.md): How a job runs, the statuses it moves through, and how to read its results.
- [Webhooks](https://docs.go-fetch.io/webhooks.md): Get told when a job finishes, with its final cost, and verify that the request came from us.
- [Errors](https://docs.go-fetch.io/errors.md): The error format, every status code the API answers, and what to do about each.
- [Rate limits](https://docs.go-fetch.io/rate-limits.md): How many requests an API key can make, and how to stay under it.
- [Billing](https://docs.go-fetch.io/billing.md): Pay as you go, billed per 1,000 results: how a job's cost is worked out, capped and reported.
- [Instagram](https://docs.go-fetch.io/scrapers/instagram.md): Posts and reels from public Instagram profiles, plus profile details. scraper_type instagram and instagram_profile.
- [Instagram comments](https://docs.go-fetch.io/scrapers/instagram-comments.md): Comments and replies from Instagram posts and reels. scraper_type instagram_comments.
- [TikTok](https://docs.go-fetch.io/scrapers/tiktok.md): Videos from public TikTok profiles, with their stats. scraper_type tiktok.
- [TikTok comments](https://docs.go-fetch.io/scrapers/tiktok-comments.md): Comments and full reply threads from TikTok videos. scraper_type tiktok_comments.
- [TikTok search](https://docs.go-fetch.io/scrapers/tiktok-search.md): Search TikTok by keyword: one row per video, with author fields on every row. scraper_type tiktok_search.
- [TikTok profile](https://docs.go-fetch.io/scrapers/tiktok-profile.md): TikTok profiles in bulk, plus their latest posts if you ask. scraper_type tiktok_profile.
- [YouTube](https://docs.go-fetch.io/scrapers/youtube.md): Videos, Shorts and streams from YouTube channels and playlists. scraper_type youtube.
- [Facebook](https://docs.go-fetch.io/scrapers/facebook.md): Posts from public Facebook pages with their reactions, plus page details. scraper_type facebook and facebook_profile.
- [Google search results](https://docs.go-fetch.io/scrapers/google-serp.md): First-page organic Google results for each query. scraper_type google_serp.
- [Python SDK](https://docs.go-fetch.io/sdk.md): gofetch-client: install it, run jobs, read results, handle errors.
- [Migrate from Apify](https://docs.go-fetch.io/migrate-from-apify.md): gofetch-client keeps apify-client's interface. Change the import and the key; your calls stay as they are.
- [API reference](https://docs.go-fetch.io/api-reference/introduction.md): Every public endpoint of the Go-Fetch API, generated from its OpenAPI schema.
- [List API keys](https://docs.go-fetch.io/api-reference/api-keys/list-api-keys.md): Your organization's keys, newest first: name, prefix, scopes and rate limit, never the key.
- [Get an API key](https://docs.go-fetch.io/api-reference/api-keys/get-an-api-key.md): Get, update or delete an API key.
- [Replace an API key](https://docs.go-fetch.io/api-reference/api-keys/replace-an-api-key.md): Needs a key with the `admin` scope.
- [Revoke an API key](https://docs.go-fetch.io/api-reference/api-keys/revoke-an-api-key.md): It stops authenticating at once and stays listed with `is_active: false`. Needs the `admin` scope.
- [Update an API key](https://docs.go-fetch.io/api-reference/api-keys/update-an-api-key.md): Rename it, change its scopes, rate limit or expiry. Needs the `admin` scope.
- [Rotate an API key](https://docs.go-fetch.io/api-reference/api-keys/rotate-an-api-key.md): Revokes the key and issues a new one with the same name, scopes, rate limit and environment. `raw_key` is the new key, shown this once. Needs the `admin` scope.
- [Create an API key](https://docs.go-fetch.io/api-reference/api-keys/create-an-api-key.md): Needs a key with the `admin` scope. `raw_key` in the response is the new key, shown this once.
- [List jobs](https://docs.go-fetch.io/api-reference/jobs/list-jobs.md): Your organization's jobs, newest first.
- [Get a job](https://docs.go-fetch.io/api-reference/jobs/get-a-job.md): Status, progress, cost and completeness of one job. Poll until `is_terminal` is true: completed or cancelled, or failed or timed_out with no automatic retry coming (`will_auto_retry` false).
- [Cancel a job](https://docs.go-fetch.io/api-reference/jobs/cancel-a-job.md): Stops a pending or running job. A job that already finished is returned as it is.
- [List a job's log lines](https://docs.go-fetch.io/api-reference/jobs/list-a-jobs-log-lines.md): Progress messages the scraper reported, oldest first.
- [Download a stored file](https://docs.go-fetch.io/api-reference/jobs/download-a-stored-file.md): Redirects to a download link for one file the job stored, such as a video or a photo its results name by this path. Row links carry a token, need no API key, and are valid for 5 days. The redirect target is valid for 10 minutes.
- [Get a job's results](https://docs.go-fetch.io/api-reference/jobs/get-a-jobs-results.md): The scraped items, a page at a time. Each item is the scraper type's own record; a running job already returns what it has delivered so far.
- [Retry a job](https://docs.go-fetch.io/api-reference/jobs/retry-a-job.md): Runs a failed, timed-out or cancelled job, or one that completed with no items, again while its `can_retry` is true.
- [Create a job](https://docs.go-fetch.io/api-reference/jobs/create-a-job.md): Starts a scrape: `scraper_type` picks the scraper and `config` (or its alias `input`) holds its input. The job is billed when it completes, at the price locked here. Follow it with `GET /api/v1/jobs/{id}/` or a webhook until it reaches a terminal status.
- [List organizations](https://docs.go-fetch.io/api-reference/organizations/list-organizations.md): With an API key, the one organization the key belongs to.
- [Get an organization](https://docs.go-fetch.io/api-reference/organizations/get-an-organization.md): Its credit balance, status and member count.
- [Replace an organization](https://docs.go-fetch.io/api-reference/organizations/replace-an-organization.md): Needs a key with the `admin` scope.
- [Update an organization](https://docs.go-fetch.io/api-reference/organizations/update-an-organization.md): Its name or description. Needs a key with the `admin` scope.
- [List audit log entries](https://docs.go-fetch.io/api-reference/organizations/list-audit-log-entries.md): Who changed what in the organization, newest first, over a window of at most 90 days. Needs a key with the `admin` scope.
- [List environments](https://docs.go-fetch.io/api-reference/organizations/list-environments.md): Each API key, job and usage record belongs to one environment.
- [Create an environment](https://docs.go-fetch.io/api-reference/organizations/create-an-environment.md): Needs a key with the `admin` scope.
- [Get an environment](https://docs.go-fetch.io/api-reference/organizations/get-an-environment.md): Retrieve, update, or delete an environment.
- [Rename an environment](https://docs.go-fetch.io/api-reference/organizations/rename-an-environment.md): Needs a key with the `admin` scope.
- [Delete an environment](https://docs.go-fetch.io/api-reference/organizations/delete-an-environment.md): Its API keys, jobs and usage move to the default environment, which itself cannot be deleted. Needs a key with the `admin` scope.
- [Rename an environment (partial)](https://docs.go-fetch.io/api-reference/organizations/rename-an-environment-partial.md): Needs a key with the `admin` scope.
- [List members](https://docs.go-fetch.io/api-reference/organizations/list-members.md): List organization members or add a new member.
- [Add a member](https://docs.go-fetch.io/api-reference/organizations/add-a-member.md): Adds an existing account by its user id, with any role but `owner`. Needs a key with the `admin` scope.
- [Get a member](https://docs.go-fetch.io/api-reference/organizations/get-a-member.md): Get, update or remove an organization member.
- [Replace a member's role](https://docs.go-fetch.io/api-reference/organizations/replace-a-members-role.md): Needs a key with the `admin` scope.
- [Remove a member](https://docs.go-fetch.io/api-reference/organizations/remove-a-member.md): Anyone but the owner. Needs a key with the `admin` scope.
- [Change a member's role](https://docs.go-fetch.io/api-reference/organizations/change-a-members-role.md): The owner's role cannot change, and no one becomes `owner` here. Needs a key with the `admin` scope.
- [Get this month's usage](https://docs.go-fetch.io/api-reference/organizations/get-this-months-usage.md): Items scraped, credits spent and job counts since the 1st of the month (UTC).
- [List prices](https://docs.go-fetch.io/api-reference/pricing/list-prices.md): The list price per 1,000 items of each platform. Your organization's own rates, if it has any, apply at job creation and show on the job.
- [Get a platform's price](https://docs.go-fetch.io/api-reference/pricing/get-a-platforms-price.md): API endpoint for viewing platform pricing.
- [Estimate a cost](https://docs.go-fetch.io/api-reference/pricing/estimate-a-cost.md): List price for a number of items on one platform.
- [List usage records](https://docs.go-fetch.io/api-reference/usage/list-usage-records.md): One record per charge, newest first: items, unit price and total cost. Every filter is optional.
- [List webhooks](https://docs.go-fetch.io/api-reference/webhooks/list-webhooks.md): Your organization's webhooks, newest first.
- [Create a webhook](https://docs.go-fetch.io/api-reference/webhooks/create-a-webhook.md): Registers a URL for job events. The response carries `signing_secret` in full, the only time it is shown: every delivery is signed with it as `sha256=<hex HMAC-SHA256 of the body>` in the `X-Webhook-Signature` header.
- [Get a webhook](https://docs.go-fetch.io/api-reference/webhooks/get-a-webhook.md): Shared helper to resolve organization IDs from the authenticated request.
- [Replace a webhook](https://docs.go-fetch.io/api-reference/webhooks/replace-a-webhook.md): Shared helper to resolve organization IDs from the authenticated request.
- [Delete a webhook](https://docs.go-fetch.io/api-reference/webhooks/delete-a-webhook.md): Shared helper to resolve organization IDs from the authenticated request.
- [Update a webhook](https://docs.go-fetch.io/api-reference/webhooks/update-a-webhook.md): Change its URL or events, or pause it with `is_active: false`.
- [Send a test delivery](https://docs.go-fetch.io/api-reference/webhooks/send-a-test-delivery.md): Queues a `test` event to the webhook, signed like a real one.
- [List a webhook's deliveries](https://docs.go-fetch.io/api-reference/webhooks/list-a-webhooks-deliveries.md): Every attempt to deliver an event to the webhook, newest first.
- [Get a delivery](https://docs.go-fetch.io/api-reference/webhooks/get-a-delivery.md): Get details of a specific webhook delivery.
- [Redeliver an event](https://docs.go-fetch.io/api-reference/webhooks/redeliver-an-event.md): Sends a failed delivery, or a successful one from the last 7 days, again.

## OpenAPI Specs

- [openapi](/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.