Introduction
Data Routes
/api/connections
This route can be used to find connections. This is the primary data route of the API.
Usage
Examples:
GET Basic Name Search:
http://96.241.186.201:5173/api/connections?api_key=your-api-key&source_name=Facebook
GET Deals and Sanctions:
http://96.241.186.201:5173/api/connections?api_key=your-api-key&connection_type=Deal,Sanction
GET Connections between two entities:
http://96.241.186.201:5173/api/connections?api_key=your-api-key&source_name=AMD&target_name=AI
GET More data:
http://96.241.186.201:5173/api/connections?api_key=your-api-key&connection_limit=100
Query Parameters:
Param | Required? | Example Value | Description |
---|---|---|---|
api_key | Required | Gp41Z-GgyZQ9fyIa3uWy0N-HRKD1b9ouui2qhAs26Qk | Your API Key, found on your account page. This can also be provided under the X-API-KEY header. |
connection_limit | Optional | 100 (Defaults to 10 ) | Number of connections to return. |
source_name OR source_uuid | Optional | Raytheon | Name of the start node. |
9aba98c5-d74f-4311-b22d-91a3404c44b6 | UUID of the start node. | ||
target_name OR target_uuid | Optional | Lockheed Martin | Name of the end node. |
7a780507-d8f4-41d8-ab6a-a67475d1c56a | UUID of the end node. | ||
connection_type | Optional | Coop, Oppo, Legal, Deal, GoodsTran, Sanction, Merger, Acquisition, IsPartOf, IsA, HasTitle, Competitors, EquivalentTo, BetterThan, IsSubclassOf, WorksFor, Owns, OperatesIn, IsFrom, Uses, Produces, Affects, Prevents, ParticipatesIn, KnownAssociates | Connection type filter. Multiple values can be comma-delimited or entered as separate query params. |
source_node_type | Optional | ORG, PRODUCT, GPE, PERSON, TITLE, FAC, TECHNOLOGY, LAW, LOC, NORP, THREAT, EVENT | Entity type filter for start node. Multiple values can be comma-delimited or entered as separate query params. |
target_node_type | Optional | ORG, PRODUCT, GPE, PERSON, TITLE, FAC, TECHNOLOGY, LAW, LOC, NORP, THREAT, EVENT | Entity type filter for end node. Multiple values can be comma-delimited or entered as separate query params. |
min_date | Optional | 2024-05-30 | Filter only connections from articles after this date. Can be a very strict filter, as many articles do not publish parseable dates. |
max_date | Optional | 2025-01-26 | Filter only connections from articles before this date. Can be a very strict filter, as many articles do not publish parseable dates. |
Result Format
Below is an example output of this route.
- "
rows_returned
" is how many rows were billed in the completion of the request. - Note that Raytheon is returned several times here, but is only billed as one row.
- "
context
" is the snippet from the article that the connection was drawn from.
{
"rows_returned": 8,
"connections": [
{
"source_entity": {
"ent_name": "Raytheon",
"ent_type": "ORG",
"ent_uuid": "9aba98c5-d74f-4311-b22d-91a3404c44b6",
"ent_aliases": []
},
"connection_data": {
"type": "Sanction",
"article_title": "Space Force drops Raytheon from MEO missile-warning satellite effort",
"article_url": "https://defensescoop.com/2024/06/14/space-force-drops-raytheon-meo-missile-tracking-satellites/",
"article_site": "https://defensescoop.com/",
"article_date": "2024-06-14",
"context": "Space Systems Command notified Raytheon of the discontinuation in May and held"
},
"target_entity": {
"ent_name": "Space Systems Command",
"ent_type": "ORG",
"ent_uuid": "9523e078-d718-4c7a-9f69-f9908d8dcc9d",
"ent_aliases": [
"SSC"
]
}
},
{
"source_entity": {
"ent_name": "Raytheon",
"ent_type": "ORG",
"ent_uuid": "9aba98c5-d74f-4311-b22d-91a3404c44b6",
"ent_aliases": []
},
"connection_data": {
"type": "Produces",
"article_title": "Space Force drops Raytheon from MEO missile-warning satellite effort",
"article_url": "https://defensescoop.com/2024/06/14/space-force-drops-raytheon-meo-missile-tracking-satellites/",
"article_site": "https://defensescoop.com/",
"article_date": "2024-06-14",
"context": "Raytheon received an other transaction agreement in 2021 to design digital models of three space vehicles for Epoch 1"
},
"target_entity": {
"ent_name": "Epoch 1",
"ent_type": "PRODUCT",
"ent_uuid": "2394f85a-a5f4-4133-90fb-470e3793f344",
"ent_aliases": []
}
},
{
"source_entity": {
"ent_name": "Raytheon",
"ent_type": "ORG",
"ent_uuid": "9aba98c5-d74f-4311-b22d-91a3404c44b6",
"ent_aliases": []
},
"connection_data": {
"type": "Produces",
"article_title": "Space Force drops Raytheon from MEO missile-warning satellite effort",
"article_url": "https://defensescoop.com/2024/06/14/space-force-drops-raytheon-meo-missile-tracking-satellites/",
"article_site": "https://defensescoop.com/",
"article_date": "2024-06-14",
"context": "discontinued its contract with Raytheon (RTX) to build three missile warning and tracking satellites for Epoch 1 of the"
},
"target_entity": {
"ent_name": "Epoch 1",
"ent_type": "PRODUCT",
"ent_uuid": "2394f85a-a5f4-4133-90fb-470e3793f344",
"ent_aliases": []
}
},
{
"source_entity": {
"ent_name": "Raytheon",
"ent_type": "ORG",
"ent_uuid": "9aba98c5-d74f-4311-b22d-91a3404c44b6",
"ent_aliases": []
},
"connection_data": {
"type": "Produces",
"article_title": "Space Force drops Raytheon from MEO missile-warning satellite effort",
"article_url": "https://defensescoop.com/2024/06/14/space-force-drops-raytheon-meo-missile-tracking-satellites/",
"article_site": "https://defensescoop.com/",
"article_date": "2024-06-14",
"context": "drops Raytheon from MEO missile-warning satellite"
},
"target_entity": {
"ent_name": "MEO",
"ent_type": "PRODUCT",
"ent_uuid": "5492a64c-23f5-430f-8a6d-97b9c73f77c9",
"ent_aliases": []
}
}
]
}
On This Page