List Actors

GET

actors

List Actors

curl --request GET \
  --url https://api.corpus.intrace.ai/v1/actors \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.corpus.intrace.ai/v1/actors', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.corpus.intrace.ai/v1/actors",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.corpus.intrace.ai/v1/actors"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.corpus.intrace.ai/v1/actors")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "canonicalName": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "aliases": [
        "<string>"
      ],
      "description": "<string>",
      "articleCount": 0,
      "eventCount": 0,
      "sourceDomains": [
        "<string>"
      ],
      "firstMentionDate": "2023-12-25",
      "lastMentionDate": "2023-12-25"
    }
  ],
  "total": 123,
  "page": 123,
  "pageSize": 123,
  "totalPages": 123
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

X-API-Key

string

header

required

Headers

x-api-key

string | null

Corpus API key

Query Parameters

page

integer

default:1

Required range: x >= 1

page_size

integer

default:50

Required range: 1 <= x <= 500

all_results

boolean

default:false

Return all results without pagination

actor_type

string[]

Filter by actor type (repeatable)

country

string[]

Filter by country (repeatable)

string | null

Search in canonical name

event_count_min

integer | null

Minimum event count

Required range: x >= 0

event_count_max

integer | null

Maximum event count

Required range: x >= 0

article_count_min

integer | null

Minimum article count

Required range: x >= 0

article_count_max

integer | null

Maximum article count

Required range: x >= 0

sort_by

string

default:canonical_name

Sort column

sort_order

enum<string>

default:asc

Sort direction

Available options:

asc,

desc

api_key

string | null

Corpus API key

Response

Successful Response

Paginated list of actors.

items

ActorResponse · object[]

required

Show child attributes

total

integer

required

page

integer

required

pageSize

integer

required

totalPages

integer

required

List Actors

curl --request GET \
  --url https://api.corpus.intrace.ai/v1/actors \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.corpus.intrace.ai/v1/actors', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.corpus.intrace.ai/v1/actors",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.corpus.intrace.ai/v1/actors"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.corpus.intrace.ai/v1/actors")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "canonicalName": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "aliases": [
        "<string>"
      ],
      "description": "<string>",
      "articleCount": 0,
      "eventCount": 0,
      "sourceDomains": [
        "<string>"
      ],
      "firstMentionDate": "2023-12-25",
      "lastMentionDate": "2023-12-25"
    }
  ],
  "total": 123,
  "page": 123,
  "pageSize": 123,
  "totalPages": 123
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Events

Actors

Locations

Metadata

Authorizations

Headers

Query Parameters

Response