Entity Details

This API endpoint provides detailed information about a specific threat intelligence entity, including its attributes, metadata, geolocations, and latest associations.

Endpoint: https://apis.threatwinds.com/api/analytics/v1/entity/{id}/details

Parameters

Headers

Header Type Required Description
Authorization string Optional Bearer token from an active session. Authentication is optional but improves rate limits.
api-key string Optional API key. Authentication is optional but improves rate limits.
api-secret string Optional API secret. Authentication is optional but improves rate limits.
Parameter Type Required Description
id string Yes The unique identifier of the entity you want to retrieve details for

Request

To get details for a specific entity, use a GET request, for example:

curl -X 'GET' \
  'https://apis.threatwinds.com/api/analytics/v1/entity/ip-abc123/details' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <YOUR_BEARER_TOKEN>'

Or using API key and secret:

curl -X 'GET' \
  'https://apis.threatwinds.com/api/analytics/v1/entity/ip-abc123/details' \
  -H 'accept: application/json' \
  -H 'api-key: <YOUR_API_KEY>' \
  -H 'api-secret: <YOUR_API_SECRET>'

Response

A successful response returns a JSON object containing detailed information about the entity, including:

Field Description
attributes Core attributes of the entity (type, value, reputation, accuracy, label, description, etc.). The value field can be any valid JSON type (string, number, boolean, object, or array)
metadata Contains all entity attributes EXCEPT the primary attribute (key matching entity type). For an IP entity, the ip field goes to attributes.value but subnet, text, etc. appear in metadata. Keys are dynamic and type-specific
geolocations Geolocation information; included for IP entities and for non-threat entities that have IP associations
latest_associations Recent entities associated with this entity
extended_metadata Cross-referenced entities: other entities whose primary attribute matches a non-primary attribute value of the queried entity (e.g., ASN entity matching metadata.asn)

Key attributes fields:

Field Type Description
label string Human-readable label for the entity type (from the type definition table, not the entity itself)
description string Description of the entity type (from the type definition table, not the entity itself)

Reputation & Accuracy Scales

Reputation Scale

Score Label
-3 Alarming
-2 Worrying
-1 Concerning
0 Indefinable
1 Adequate
2 Good
3 Exceptional

Accuracy Scale

Score Label
≤0 Inaccurate
1 Imprecise
2 Fairly precise
3 Precise

Example response:

{
  "attributes": {
    "id": "ip-abc123",
    "type": "ip",
    "value": "8.8.8.8",
"label": "IP Address",
"description": "An IP address entity",
    "reputation": "Exceptional",
    "reputation_score": 3,
    "best_reputation": "Exceptional",
    "best_reputation_score": 3,
    "worst_reputation": "Exceptional",
    "worst_reputation_score": 3,
    "accuracy": "Precise",
    "accuracy_score": 3,
    "first_seen": "2021-01-01T00:00:00Z",
    "last_seen": "2023-06-15T14:30:00Z",
    "tags": ["dns", "google", "public"]
  },
  "metadata": {
    "asn": 15169,
    "aso": "Google LLC",
    "country": "United States"
  },
  "geolocations": [
    {
      "city": "Mountain View",
      "country": "United States",
      "latitude": 37.4056,
      "longitude": -122.0775,
      "accuracy_radius": 1000,
      "asn": 15169,
      "aso": "Google LLC",
      "object": "8.8.8.0/24"
    }
  ],
  "latest_associations": [
    {
      "id": "domain-xyz789",
      "type": "domain",
      "value": "dns.google",
      "reputation": "Exceptional",
      "reputation_score": 3,
      "accuracy": "Precise",
      "accuracy_score": 3,
      "first_seen": "2021-02-15T00:00:00Z",
      "last_seen": "2023-06-10T12:00:00Z"
    }
  ],
  "extended_metadata": [
    {
      "id": "registrar-def456",
      "type": "registrar",
      "value": "Google LLC",
      "reputation": "Exceptional",
      "reputation_score": 3,
      "accuracy": "Precise",
      "accuracy_score": 3,
      "first_seen": "2021-02-15T00:00:00Z",
      "last_seen": "2023-06-10T12:00:00Z"
    }
  ]
}

Error Response Headers

For responses with error status codes, the following headers are included:

Header Description
x-error Human-readable error message describing what went wrong
x-error-id Unique identifier for error tracking and support

Error Codes

Status Code Description Possible Cause
400 Bad Request Invalid entity ID or invalid request parameters
401 Unauthorized Invalid authentication credentials
404 Not Found Entity not found
500 Internal Server Error Server-side error; please contact support if persistent