Ferry
Start 14-day trial
Documentation

Ship deep links that keep their context.

Start with an SDK, raw HTTP, or one prompt for your coding agent. Ferry handles routing, deferred matching, and link-level revenue attribution.

Start the quickstart First working link in about 10 minutes
01 / QUICKSTART

From project to first attributed link.

Create a project, connect the app, and open one test link. Ferry keeps the same payload through redirect, install, and first open.

  1. 1

    Create a project

    Add your bundle ID or package name, store destination, and web fallback.

  2. 2

    Choose your integration

    Install an SDK or use the public HTTP endpoints directly.

  3. 3

    Open a test link

    Confirm routing, inspect the returned data, and report your first event.

Resolve a link with HTTP 
curl https://api.ferrylink.io/v1/resolve \
  -X POST \
  -H "Content-Type: application/json" \
  -H "X-Ferry-Key: pk_your_project_key" \
  -d '{
    "url": "https://summer.feryl.io/welcome"
  }'
02 / API KEYS

Use the right key in the right place.

pk_

Public project key

Safe to include in your app. It is scoped to one project and authorizes resolve, match, restricted events, and optional client link creation.

sk_

Secret workspace key

Server-side only. Use it for full link management, analytics, domains, and agent-driven workflows. Never ship it in a client app.

03 / AGENT SETUP

Give your coding agent one clear task.

Ferry’s API is designed so an agent can inspect the project, pick the right SDK, and wire up the complete attribution path.

Suggested prompt 
Add Ferry deep linking to this app.

Use the platform SDK and the Ferry public key from
the environment. Handle the incoming data payload,
then report signup and purchase events.

Never place an sk_ key in the client app.
04 / SDKs

Use the stack you already ship.

iOS Swift SDK Android Kotlin SDK React Native JavaScript SDK Flutter Dart SDK
05 / DEFERRED MATCHING

Prefer certainty. Return confidence.

Ferry tries deterministic methods first and only uses fingerprint matching when stronger signals are unavailable. Ambiguous candidates return no match.

Install referrer → Click ID → Code → Fingerprint
06 / HTTP API

A small public surface with clear jobs.

POST /v1/resolve

Resolve a Ferry URL and return its link payload.

POST /v1/match

Match the first app open to the click that led to install.

POST /v1/events

Report supported product events for attribution.

POST /v1/links

Create a short-lived data-only link when enabled for the project.

READY TO TEST?

Create a project and send your first link.

Start 14-day trial