# Web Scraping Parse Document API (https://www.socialcrawl.dev/platforms/web/parse)

> Uploads a document through multipart/form-data and returns parsed web-style content.

TL;DR: `POST /v1/web/parse` costs 1 credit per call and returns SocialCrawl's unified JSON schema. Single x-api-key auth, 100 free credits on signup.

## Parameters

| Parameter | Required | Description |
| --- | --- | --- |
| `file` | yes | Multipart file field. |
| `filename` | no | Name to record for the uploaded file, e.g. 'report.pdf'. Used for the parsed document's title when the file carries none. |
| `mime_type` | no | Optional MIME type override. |
| `url` | no | Public URL to fetch and parse instead of uploading a file. Send either this or the file field. |

## Code example

```bash
curl -X POST "https://www.socialcrawl.dev/v1/web/parse" \
  -H "x-api-key: sc_YOUR_API_KEY" \
  -F "file=@document.pdf"
```

## FAQ

### What does the Web Parse API return?

Returns the text of a document you upload, such as a PDF, as clean markdown along with its page count. The response uses the same JSON envelope as every SocialCrawl endpoint, with the data, credits_used and request_id fields.

### When should I use the Web Parse endpoint?

Use it when you have the file itself; to read a normal web page use scrape instead.

### How much does the Web Parse API cost?

Each call costs 1 credit, so the 100 free credits every new account gets cover 100 calls. Credits for failed or empty calls are refunded automatically, and there is no subscription.

### What parameters does the Web Parse API need?

The one required parameter is file (multipart file field). It also accepts 3 optional parameters, all listed on this page.

### How do I call the Web Parse API?

Send a POST request to https://www.socialcrawl.dev/v1/web/parse with a JSON body and your API key in the x-api-key header. An Authorization: Bearer header works too.

See the full Web Scraping API: https://www.socialcrawl.dev/platforms/web

## Pricing

- Standard endpoints: 1 credit per call
- Advanced endpoints: 5 credits per call
- Premium endpoints: 10 credits per call
- 100 free credits on signup, no credit card required. Cached responses cost 0 credits. Credit packs never expire.
- Full pricing: https://www.socialcrawl.dev/pricing

## Explore with AI

Questions this API answers, phrased for an AI assistant:

- What does the SocialCrawl Web Parse API return?
- How do I get Web Parse data with the SocialCrawl API?