Official API Documentation

Integrate Linkiw
into your own tools.

Connect your CRM, automate your list creation, or launch large-scale extractions with our powerful REST API.

Get my API key

High performance

Average response time under 200ms.

Secure authentication

Authentication via Bearer Token.

JSON Responses

All responses are in standardized JSON format.

Up-to-date data

Live scraping to bypass the database.

Basics

Understand how to connect to the server and authenticate your requests.

Base URL

All API requests are made to this secure base URL:

https://api.linkiw.app/v1

Authentication (Bearer)

Add your API key in the Authorization header of each request:

Authorization: Bearer lw_live_votre_cle_secrete

Available Endpoints

Quick reference of all paths of our public API.

EndpointMethodDescriptionCredits
/v1/meGETView profile, limits, and remaining credits balance.0
/v1/entreprisesGETSearch and filter companies in the existing Linkiw database.0
/v1/scraping/runPOSTLaunch a real-time web scraping.1 / company with contact
/v1/listsGETRetrieve your prospecting lists and their leads.0

1. GET /v1/entreprises

Searches companies in our existing database. This request is 100% free and consumes no credits.

Query parameters:

  • query (string): company name or keyword.
  • wilayas (array): IDs of the target wilayas (e.g. ?wilayas=16&wilayas=31).
  • secteurs (array): names of the target business sectors.
  • score_min (number): minimum quality score (0-100).
  • page (number): page number (default: 1).
  • per_page (number): results per page (default: 20).

Example response:

{
  "total": 1420,
  "page": 1,
  "pages": 71,
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "nom": "SARL Tech Algérie",
      "wilaya": "Alger",
      "activite": "Développement logiciel",
      "email": "contact@tech-algerie.dz",
      "telephone": "+213 550 00 00 00",
      "score_qualite": 85
    }
  ]
}

2. POST /v1/scraping/run

Runs a live extraction across the web and directories. Ideal for finding new data that is not in the database yet.

Warning (credits): 1 credit is deducted from your balance for every unique company found with at least one means of contact (email or phone).

Request body (JSON):

{
  "secteur": "Bâtiment et travaux publics",
  "wilaya": "Oran",
  "max_results": 50 // Optional, defaults to 20
}

Example response:

{
  "task_id": "scrap_987654321",
  "status": "completed",
  "results_found": 34,
  "credits_used": 28, // Only 28 had contact details
  "entreprises": [
    // Full list of companies found
  ]
}

Rate Limits

To ensure the stability of our infrastructure, the API is subject to limits depending on your plan.

Plan Sales Team
150 req / minute
Plan Enterprise
500 req / minute

Ready to connect your tools?

Create your account, get your secret API key, and access the B2B database.

Get my API Key