API reference / Connected account

Connect an account with a session

Written and maintained by The ProspectAPIs team

POST/v1/accounts/session

POST /v1/accounts/session is the ProspectAPIs operation connectAccountSession, in the Connected account group of the REST API. Connect your own account with its signed-in session string. The session is checked live once, then stored encrypted in our database, used only to perform the actions you request, never shown to another customer, and deleted when you disconnect. It replaces any account connected before. Free. Rate limit: 10 connect or sign-in attempts a minute per account. Cost: free; connect your own account with its session string, 10 attempts a minute. Send your API key as a Bearer token in the Authorization header.

How this fits with the rest of the connected account API, with worked examples, is in the connected accounts guide.

Parameters

Request body

JSON (ConnectSessionRequest). The signed-in session string of the account you connect. It is checked live once, stored encrypted and never returned.

{
  "session": "your-session-string"
}

Responses

Every error answers with the same JSON body, an error string and sometimes a code; the errors page lists each status and when it happens. A per-key 429 carries Retry-After; see rate limits.

201 response fields

Connected. What is connected, never the session. The body is a ConnectedAccount.

Code samples

Each sample sends the same request. Set PROSPECTAPIS_KEY in your environment first. Values come from the spec's examples; replace them with your own.

curl -X POST https://api.prospectapis.com/v1/accounts/session \
  -H "Authorization: Bearer $PROSPECTAPIS_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "session": "your-session-string" }'

const res = await fetch("https://api.prospectapis.com/v1/accounts/session", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.PROSPECTAPIS_KEY}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "session": "your-session-string"
  }),
});
if (!res.ok) throw new Error(`${res.status}: ${(await res.json().catch(() => ({}))).error ?? res.statusText}`);
const data = await res.json();
console.log(data);

import os, requests

res = requests.post(
    "https://api.prospectapis.com/v1/accounts/session",
    headers={"Authorization": f"Bearer {os.environ['PROSPECTAPIS_KEY']}"},
    json={
        "session": "your-session-string",
    },
    timeout=30,
)
res.raise_for_status()
data = res.json()
print(data)

Billing

The call itself is free, and what it sets up is billed as it runs: connect your own account with its session string, 10 attempts a minute. Metered spend on the same key is reported after each response in X-Credits-Remaining, and GET /v1/account shows the balance at any time.

Related

The connected accounts guide covers this area end to end. Previous operation: Check the connected account. Next operation: Disconnect the account. Every operation, grouped by area, is on the API reference index.

Create a free account to get a key, then run the samples above with your own values (this call acts for real, so use real inputs).