> For the complete documentation index, see [llms.txt](https://documentation.scrapin.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.scrapin.io/api/readme.md).

# Quickstart

{% hint style="warning" %}
**Important Notice**

This documentation is only a **preview** of our API. It provides a high-level overview of what the API can do and which types of data objects you can expect.\
\
The **official API Reference** — including full technical specifications, JSON schemas, sample results, error codes, and authentication details — is only available after signing up to our platform.\
\ <a href="https://app.scrapin.io/auth/register" class="button primary">Sign up to access the full API Reference</a>
{% endhint %}

***

This QuickStart is designed to help you quickly understand:

* **What our API does**: the main endpoints available and the kind of data they deliver.
* **How to use it**: what inputs are required and what objects are returned.
* **Where it fits**: common use cases such as sales enrichment, recruiting workflows, CRM integration, or analytics pipelines.

It’s **not a technical deep dive**, but a way to educate you and your team on the possibilities of the API before accessing the full reference.

***

### How It Works

1. **Explore endpoints in this preview**\
   Each endpoint page explains at a high level:
   * What the endpoint does.
   * The inputs it accepts (e.g., Social URL, name, domain).
   * The outputs it returns (structured person, company, or activity objects).
   * Typical use cases and benefits.
2. **Understand delivery & integration**\
   Data can be delivered via simple API calls or bulk delivery formats (CSV, JSON, Parquet, etc.), depending on your needs.\
   Our team can also help with **cloud integrations** (Amazon S3, Google Cloud, Azure).
3. **Get full access**\
   To access the **full API Reference** (with technical specifications, JSON examples, error codes, and complete object schemas), you need to **sign up for the platform** and get credentials.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://documentation.scrapin.io/api/readme.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `build a script that syncs our docs to a CMS` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.