Market Radar API
API referenceGroups

The groups

A group is a label on the account's companies, or on its custom sources; a company or a custom source can be in several. A radar's query names a company group as one chip ({"group_id": 12}), and its source_group_ids name website groups: it follows them, searching their members as they are at each sweep. Company groups first, each kind by name. Not paged.

GET
/groups

Authorization

key
AuthorizationBearer <token>

A key created in the app under Settings, API and MCP. Read keys read; Read and write keys also add, edit and delete companies, custom sources, groups and radars, and create, rename and delete folders.

In: header

Query Parameters

kind?string

One kind only; both when left out

Value in

  • "companies"
  • "websites"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/groups"
{  "data": [    {      "id": 1,      "name": "string",      "kind": "companies",      "member_ids": [        1      ],      "radar_ids": [        1      ],      "created_at": "2019-08-24T14:15:22Z"    }  ]}

Delete a folder and its radars DELETE

As in the app, its radars are deleted with it, each as DELETE /radars/{id} would: their sweeps, signals and sources, or a tender radar's calls, go too, and each radar leaves the newsletters that used it. Companies, custom sources, groups and filters stay. To keep a radar, move it to another folder first with PATCH /radars/{id} and folder_id.

Create a group POST

A group of companies (kind companies) or of custom sources (kind websites), with its members when member_ids names them. No radar follows it yet: name it in a radar's query ({"group_id": 12}) or source_group_ids. A member that is not one of the account's fails on member_ids and leaves no group behind.