List signal types

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).

Response

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

Credits

Free. Costs in data[].cost are what a later search charges per delivered row.

Errors

• 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" \
  -H "Authorization: Bearer $MYSDR_API_KEY"

JavaScript

const response = await fetch('https://mysdr.app/api/v1/signals', {
  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",
    headers={
    "Authorization": f"Bearer {os.environ['MYSDR_API_KEY']}"
    },
    method="GET",
)
with urllib.request.urlopen(request) as response:
    body = json.load(response)

Example response

{
  "object": "list",
  "data": [
    {
      "type": "funding_raised",
      "object": "signal_type",
      "title": "Leads that raised funding",
      "returns": "company",
      "max_rows": 100,
      "default_limit": 25,
      "cost": {
        "row_key": "funding_company",
        "credits_per_row": 1
      },
      "typical_duration_seconds": 15
    }
  ]
}