v1

latestOpenAPI 3.1.12026-07-242899061.7 MB

URL

Lookup a URL entity by id

Get full URL enrichment including risk scoring, AI threat analysis, and malware family relationships.

get/url/{id}

Path parameters

idstring required

URL entity id

Query parameters

fieldsstring

The enrichment fields requested for the entities returned. Several fields can be given as a comma separated string.

See https://docs.recordedfuture.com/reference/enrichment-field-attributes for a list of values.

{"stackTrail":"components:parameters:MetadataParameter:schema","oasType":"schema","type":"unknown"}

Annotates the response with additional metadata explaining the response data elements.

taggedTextboolean

Enable or disable entity tags in text fragments

commentstring

Response

Result of operation

metadataobject

Request metadata. Included when the metadata query parameter is set to true.

Example response

{
  "data": {
    "entity": {
      "id": "B_E7B",
      "provided_id": "B_E7B",
      "type": "Company",
      "name": "Microsoft"
    },
    "analystNotes": [
      {
        "id": "BDFvC2y",
        "attributes": {
          "topic": {
            "id": "TXSFt3",
            "name": "Threat Lead",
            "type": "Topic"
          },
          "context_entities": [
            {
              "id": "B_E7B",
              "provided_id": "B_E7B",
              "type": "Company",
              "name": "Microsoft"
            }
          ],
          "note_entities": [
            {
              "id": "B_E7B",
              "provided_id": "B_E7B",
              "type": "Company",
              "name": "Microsoft"
            }
          ],
          "validation_urls": [
            {
              "id": "B_E7B",
              "provided_id": "B_E7B",
              "type": "Company",
              "name": "Microsoft"
            }
          ]
        },
        "source": {
          "id": "source:VKz42X",
          "name": "Insikt Group",
          "type": "Source"
        }
      }
    ],
    "relatedEntities": [
      {
        "type": "RelatedIpAddress",
        "entities": [
          {
            "count": 682,
            "entity": {
              "id": "B_E7B",
              "provided_id": "B_E7B",
              "type": "Company",
              "name": "Microsoft"
            }
          }
        ]
      }
    ],
    "counts": [
      {
        "date": "2021-12-24",
        "count": 1970
      }
    ],
    "metrics": [
      {
        "type": "linkedToCyberExploit",
        "value": 4018
      }
    ]
  }
}