Skip to content

Data API

The Data API resolves a handle to a real public account on X, Instagram, TikTok, YouTube, Telegram, Bluesky and LinkedIn, with follower history, engagement figures, bulk enrichment and ownership checks. It is a product of its own: it has its own keys, its own plans and its own bill, separate from your CRM subscription, and it is open on every CRM plan, with a free Data API plan to start on.

  • Base URL: https://pinlyx.com/data-api/v2.
  • Keys: created in the panel under Data API › Keys. A key is sent as Authorization: Bearer psk_live_....
  • Allowance: every plan includes a number of requests per 30-day period. A live fetch from the source costs more budget units than a catalogue read; the Plans tab shows the exact figures for each plan.
  • Response envelope: every endpoint answers with the data and how old it is, under data and meta.
  1. Open Data API in the Pinlyx app (sidebar group Tools).

  2. On Overview, click Start on the free plan. No card is needed. To pick a paid plan instead, open Plans.

  3. Open Keys and click New key. Give it a Name, choose under What this key may do which scopes it gets, and optionally add an IP allowlist.

  4. Copy the key from Copy your key now. It is shown once; only a hash is stored. If you lose it, Rotate the key to get a new secret.

  5. Make your first call:

    Terminal window
    curl https://pinlyx.com/data-api/v2/accounts/x/nasa \
    -H "Authorization: Bearer psk_live_..."
    {
    "data": {
    "platform": "x",
    "handle": "nasa",
    "display_name": "NASA",
    "followers": 96412338,
    "verified": true,
    "growth": { "d7": 18422, "d30": 71903 }
    },
    "meta": { "cache_age_s": 3120, "cost": 1 }
    }

A key only reaches the endpoints its scopes allow. Scopes your plan does not include are shown as Not in your plan and cannot be ticked.

ScopeLabel in the appWhat it allows
directory:readDirectoryRead the account and channel catalogue across all seven platforms. The default for a new key.
insights:readInsightsEngagement rates, top posts, viral patterns and cohort benchmarks.
scrape:liveLive fetchFetch a profile or channel from the source at request time, bypassing the catalogue. Marked Sensitive.
tools:useToolsRun the analysis tools: valuation, follower audit, scoring and others. Marked Sensitive.
research:readResearchFindings and runs from the research engine.
leads:readLeadsLinkedIn company and contact data, and X follower-graph exports. Marked Sensitive.
  • Plans run for 30 days. Each one sets the request allowance, how many keys you may hold and what a live call costs. Pay by card, or from your API credit, which switches the plan on at once. Prices are on the Plans tab and at pinlyx.com/pricing.
  • API credit is a balance you top up with Buy credit on Overview. It pays plan renewals and settles overage, and can only be spent on the Data API.
  • Overage is off by default. Under Plan settings, Allow overage keeps serving requests past the allowance, at a per-1,000 rate, up to an Overage cap you must set. Some plans stop at their allowance and cannot go over.
  • Renew automatically charges your API credit when the period ends.
  • Cancelling a plan does not revoke your keys; they keep working until the period ends.

The Usage tab shows requests per day, by endpoint and by key, so you can find the job that is spending the allowance.

  • Data API keys and CRM API keys are not interchangeable. A csk_ key does not open the Data API, and a psk_ key does not open /v1.
  • Rotating a key stops the old secret immediately. Revoking a key stops everything that uses it immediately.
  • If you signed up for the Data API only, the rest of the panel (contacts, inbox, pipelines) is part of the CRM subscription, which you can add at any time without touching your keys or usage.