mySDRDocs

API reference

Get a signal type

One signal type from the catalog: what it finds, what a row costs, its limits and the JSON Schema of its signal object. event_posts answers as events.

GEThttps://mysdr.app/api/v1/signals/{signal_type}
View Markdown

Authentication

Send Authorization: Bearer gtk_…. Create the key under Connect assistant → API keys. A missing, invalid or revoked key is 401. A valid key while this API is not enabled for your organization answers 403 api_not_enabled, with what the key can do instead. Every response includes mySDR-Api-Version, mySDR-Request-Id and Cache-Control: no-store, and a response to an accepted key also X-RateLimit-* (so not a 401, a 405, an OPTIONS or a 404 for an unknown path).

Path parameters

  • signal_type string · required — A type from GET /signals. One of: linkedin_engagement, own_engagement, social_listening, funding_raised, new_in_role, events, tech_adoption.

Response

  • type string · required — The type key.
  • object string · required — Always signal_type. One of: signal_type.
  • title string · required — Its name.
  • description string · required — What it finds.
  • returns string · required — What one row is. One of: company, person.
  • max_rows integer · required — Most rows one search returns; more with cursor.
  • default_limit integer · required — The limit of a search that sends none.
  • cost object · required — Credits per delivered row: { row_key, credits_per_row }.
  • typical_duration_seconds integer · required — How long a search usually takes.
  • limits string[] · required — What this signal cannot see.
  • aliases string[] · required — Old names of the type that still work.
  • parameters object · required — JSON Schema of the signal object.

Credits

Free.

Errors

  • 404 not_found — No such signal type.
  • 401 authentication_error — The Authorization header is missing, or the key is unknown or revoked.
  • 403 permission_error — API access is not part of your plan, or your account is suspended.
  • 403 api_not_enabled — The key is valid, but the Signals API or the Company API is not enabled for your organization yet. The error says what this key can do.
  • 429 rate_limit_error — More than 60 requests per minute, or more than 3 at the same time, on one key. Wait for the Retry-After header.
  • 500 internal_error — Something went wrong on our side.

Example

cURL

curl "https://mysdr.app/api/v1/signals/tech_adoption" \
  -H "Authorization: Bearer $MYSDR_API_KEY"

JavaScript

const response = await fetch('https://mysdr.app/api/v1/signals/tech_adoption', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.MYSDR_API_KEY}`
  }
});
const body = await response.json();

Python

import json
import os
import urllib.request

request = urllib.request.Request(
    "https://mysdr.app/api/v1/signals/tech_adoption",
    headers={
    "Authorization": f"Bearer {os.environ['MYSDR_API_KEY']}"
    },
    method="GET",
)
with urllib.request.urlopen(request) as response:
    body = json.load(response)

Example response

{
  "type": "tech_adoption",
  "object": "signal_type",
  "title": "Companies using a technology",
  "returns": "company",
  "max_rows": 25,
  "default_limit": 10,
  "cost": {
    "row_key": "tech_company",
    "credits_per_row": 3
  },
  "typical_duration_seconds": 10,
  "limits": [
    "Evidence comes from job postings: a company that uses a tool without hiring for it is not seen."
  ],
  "aliases": []
}