Types

View as markdown

The fields of every response and event type, and the enumerations they use.

Lookup types

Every response type is an immutable Data class, as are ResponseMetadata, RateLimit, and GRPCSchema::Schema.

  • Fields: Read fields with the methods named after them. to_h, with, ==, and pattern matching work as for any Data, and arrays and hashes decoded from a response are frozen.
  • Optional fields: A field typed with a trailing ? is nil when the API omits it or sends null.
  • Decoding: A response with a required field missing or of the wrong type raises DecodeError. Unknown fields are ignored so that additive API changes don't break decoding.
  • Timestamps: Unix timestamps from the API become Time values in UTC, whether the API sends seconds or milliseconds.

IPInfo

The intelligence Synthient holds for an IP address. See the IP API for how each field is derived.

  • Name
    ip
    Type
    IPAddr
    Description

    The address that was looked up.

  • Name
    network
    Type
    Network?
    Description

    The network that announces the address, or nil if the API has no network data.

  • Name
    location
    Type
    Location?
    Description

    The geolocation of the address, or nil if the API has no location data.

  • Name
    intelligence
    Type
    Intelligence?
    Description

    The risk score and the proxy, VPN, and device observations for the address, or nil if the API has no intelligence data.

Network

  • Name
    asn
    Type
    Integer
    Description

    The autonomous system number, or 0 if the address is not routed.

  • Name
    isp
    Type
    String
    Description

    The internet service provider that operates the network.

  • Name
    org
    Type
    String?
    Description

    The organization the address is registered to, or nil if unknown.

  • Name
    domain
    Type
    String?
    Description

    The network operator's domain, or nil if unknown.

  • Name
    type
    Type
    String
    Description

    The kind of network, such as NetworkType::RESIDENTIAL. See Enumerations.

  • Name
    abuse_email
    Type
    String?
    Description

    The operator's abuse contact email, or nil if unknown.

  • Name
    abuse_phone
    Type
    String?
    Description

    The operator's abuse contact phone number, or nil if unknown.

Location

  • Name
    country
    Type
    String
    Description

    The ISO 3166-1 alpha-2 country code.

  • Name
    state
    Type
    String
    Description

    The state or region.

  • Name
    city
    Type
    String
    Description

    The city.

  • Name
    timezone
    Type
    String
    Description

    The IANA time zone name.

  • Name
    latitude
    Type
    Float
    Description

    The latitude in degrees.

  • Name
    longitude
    Type
    Float
    Description

    The longitude in degrees.

  • Name
    geo_hash
    Type
    String
    Description

    The geohash of the coordinates.

Intelligence

Synthient's assessment of an address. See Methodology for how it is built.

  • Name
    risk_score
    Type
    Integer
    Description

    The risk of the address, from 0 to 100.

  • Name
    categories
    Type
    Array[String]
    Description

    The kinds of services seen on the address. New values may be added.

  • Name
    behavior
    Type
    Array[String]
    Description

    Behaviors observed from the address. New values may be added.

  • Name
    providers
    Type
    Array[Provider]
    Description

    The proxy, VPN, and anonymizer services seen using the address. An empty list does not mean the address is clean.

  • Name
    devices
    Type
    Array[Device]
    Description

    The device types seen behind the address.

Provider

A proxy, VPN, or anonymizer service seen using an address.

  • Name
    name
    Type
    String
    Description

    The service tag, such as "BRIGHTDATA". The API names this field provider. See Service Tags.

  • Name
    type
    Type
    String
    Description

    The service category.

  • Name
    last_seen
    Type
    Time
    Description

    When the service was last seen on the address.

Device

A device type seen behind an address.

  • Name
    os
    Type
    String
    Description

    The operating system, such as OS::ANDROID. See Enumerations.

  • Name
    version
    Type
    String
    Description

    The operating system version.

  • Name
    last_seen
    Type
    Time
    Description

    When the device was last seen.

Domain types

DomainInfo

The honeypot traffic Synthient has observed for a domain.

  • Name
    domain
    Type
    String
    Description

    The domain that was looked up.

  • Name
    status
    Type
    String
    Description

    Whether the domain had events in the last 24 hours, as a DomainStatus value.

  • Name
    stats
    Type
    DomainStats
    Description

    Aggregate event counts.

  • Name
    unique_ips
    Type
    UniqueIPs
    Description

    Counts of the distinct source addresses.

  • Name
    time_series
    Type
    Array[TimeSeriesPoint]
    Description

    Daily event counts.

  • Name
    top_asn
    Type
    ASNCount?
    Description

    The network that sent the most events, or nil when there were no events.

  • Name
    top_subdomains
    Type
    Array[SubdomainCount]
    Description

    The most targeted subdomains.

  • Name
    top_ports
    Type
    Array[PortCount]
    Description

    The most targeted ports.

  • Name
    geo_distribution
    Type
    Array[CountryCount]
    Description

    Event counts by source country.

  • Name
    hour_dow_heatmap
    Type
    Array[Array[Integer]]
    Description

    The last 30 days of events as 7 rows, Monday first, of 24 UTC hourly counts, indexed as hour_dow_heatmap[day][hour]. Day 0 is Monday, unlike Time#wday, where 0 is Sunday.

  • Name
    activity_stats
    Type
    ActivityStats
    Description

    The hourly activity pattern.

  • Name
    recent_events
    Type
    Array[DomainEvent]
    Description

    The most recent events, capped by the limit: passed to lookup_domain.

DomainStats

  • Name
    events_24h
    Type
    Integer
    Description

    Events in the last 24 hours.

  • Name
    total_events_30d
    Type
    Integer
    Description

    Events in the last 30 days.

UniqueIPs

The distinct source addresses seen for a domain.

  • Name
    value_24h
    Type
    Integer
    Description

    Distinct source addresses in the last 24 hours.

  • Name
    value_30d
    Type
    Integer
    Description

    Distinct source addresses in the last 30 days.

  • Name
    sparkline_24h
    Type
    Array[Integer]
    Description

    Hourly counts for the last 24 hours, oldest first.

TimeSeriesPoint

The event counts for one day.

  • Name
    date
    Type
    Time
    Description

    The start of the day.

  • Name
    events
    Type
    Integer
    Description

    Events that day.

  • Name
    unique_ips
    Type
    Integer
    Description

    The number of distinct source addresses that day.

ASNCount

  • Name
    asn
    Type
    Integer
    Description

    The autonomous system number.

  • Name
    events
    Type
    Integer
    Description

    Events from that network.

SubdomainCount

  • Name
    subdomain
    Type
    String
    Description

    The subdomain.

  • Name
    count
    Type
    Integer
    Description

    The number of events that targeted it.

PortCount

  • Name
    port
    Type
    Integer
    Description

    The port.

  • Name
    count
    Type
    Integer
    Description

    The number of events that targeted it.

CountryCount

  • Name
    country_code
    Type
    String
    Description

    The ISO 3166-1 alpha-2 country code.

  • Name
    events
    Type
    Integer
    Description

    Events from that country.

  • Name
    unique_ips
    Type
    Integer
    Description

    Distinct source addresses from that country.

ActivityStats

The hourly activity pattern of a domain.

  • Name
    cadence
    Type
    String
    Description

    How events are spread over the last 30 days, as a Cadence sentence. See Enumerations.

  • Name
    median_per_hour
    Type
    Integer
    Description

    The median number of events per hour.

  • Name
    p95_per_hour
    Type
    Integer
    Description

    The 95th percentile of events per hour.

  • Name
    peak_hour
    Type
    Integer
    Description

    The busiest UTC hour of the day.

  • Name
    quiet_hour
    Type
    Integer
    Description

    The quietest UTC hour of the day.

DomainEvent

A single honeypot event for a domain.

  • Name
    timestamp
    Type
    Time
    Description

    When the event happened.

  • Name
    source_ip
    Type
    String
    Description

    The full proxy exit address that carried the event. The API names the field source_ip_masked, but the address is not masked.

  • Name
    target_subdomain
    Type
    String
    Description

    The subdomain that was targeted.

  • Name
    country_code
    Type
    String
    Description

    The source country.

  • Name
    port
    Type
    Integer
    Description

    The destination port.

Account types

Account

The account that owns the API key.

  • Name
    email
    Type
    String
    Description

    The account's email address.

  • Name
    first_name
    Type
    String
    Description

    The account holder's first name.

  • Name
    last_name
    Type
    String
    Description

    The account holder's last name.

  • Name
    organization
    Type
    Organization
    Description

    The organization the account belongs to.

  • Name
    scopes
    Type
    Array[String]
    Description

    The permissions granted to the API key, as Scope values. See Enumerations.

  • Name
    lookup_quota
    Type
    LookupQuota
    Description

    The remaining lookup credit balance.

  • Name
    api_key
    Type
    AccountAPIKey?
    Description

    The API key used for the request, or nil if the API omits it.

Organization

  • Name
    id
    Type
    String
    Description

    The organization's ID.

  • Name
    name
    Type
    String
    Description

    The organization's name.

  • Name
    relation
    Type
    String
    Description

    The account's role in the organization, as a Relation value. See Enumerations.

LookupQuota

An account's lookup credit balance.

  • Name
    credits
    Type
    Integer
    Description

    The number of lookup credits remaining.

  • Name
    resets_in
    Type
    Integer
    Description

    The number of seconds until the credits reset.

AccountAPIKey

  • Name
    id
    Type
    String
    Description

    The key's ID.

  • Name
    name
    Type
    String
    Description

    The key's display name.

  • Name
    created_at
    Type
    Time
    Description

    When the key was created, parsed from the API's RFC 3339 string.

Export types

ExportPage

One page of a feed's exports, newest first.

  • Name
    stream
    Type
    String
    Description

    The feed's stream identifier, such as "proxies".

  • Name
    exports
    Type
    Array[Export]
    Description

    The exports on this page. The API names this field feeds.

  • Name
    next_cursor
    Type
    String?
    Description

    Fetches the next page when passed as cursor:. It is nil on the last page.

Export

A Parquet export of a feed.

  • Name
    id
    Type
    String
    Description

    Identifies the export for export_meta, download_url, and download, which accept it as is. On the first page, the newest hourly export may have the ID "latest".

  • Name
    kind
    Type
    String
    Description

    Whether the export covers an hour or a day, as an ExportKind value.

  • Name
    date
    Type
    Date
    Description

    The UTC day of the export.

  • Name
    hour
    Type
    Integer?
    Description

    The UTC hour of an hourly export, or nil for a daily export.

  • Name
    size_bytes
    Type
    Integer
    Description

    The size of the Parquet file in bytes.

  • Name
    row_count
    Type
    Integer
    Description

    The number of rows in the file.

  • Name
    checksum
    Type
    String
    Description

    The hex-encoded SHA-256 of the Parquet file.

  • Name
    created_at
    Type
    Time
    Description

    When the export was created.

  • Name
    download_path
    Type
    String
    Description

    The API path of the export's download, including the /api/v4 prefix.

ExportMeta

A Parquet export without its contents.

  • Name
    id
    Type
    String
    Description

    The export ID.

  • Name
    stream
    Type
    String
    Description

    The feed's stream identifier.

  • Name
    kind
    Type
    String
    Description

    Whether the export covers an hour or a day, as an ExportKind value.

  • Name
    format
    Type
    String
    Description

    The file format.

  • Name
    date
    Type
    Time
    Description

    The start of the export's UTC day or hour.

  • Name
    hour
    Type
    Integer?
    Description

    The UTC hour of an hourly export, or nil for a daily export.

  • Name
    rows
    Type
    Integer
    Description

    The number of rows in the file.

  • Name
    size
    Type
    Integer
    Description

    The size of the Parquet file in bytes.

  • Name
    checksum
    Type
    String
    Description

    The hex-encoded SHA-256 of the Parquet file.

  • Name
    created_at
    Type
    Time
    Description

    When the export was created.

  • Name
    schema
    Type
    ParquetSchema
    Description

    The Parquet columns.

ParquetSchema

  • Name
    fields
    Type
    Array[ParquetColumn]
    Description

    The columns of the export.

ParquetColumn

  • Name
    name
    Type
    String
    Description

    The column name.

  • Name
    type
    Type
    String
    Description

    The column type, as a ParquetType value. See Enumerations.

Event types

Stream payloads match the Firehose and Helios documentation field for field, except where a field is renamed below. Fields typed with a trailing ? are nil when the API omits them.

ProxyEvent

A proxy sighting from the proxies feed.

  • Name
    ip
    Type
    String?
    Description

    The proxy exit address.

  • Name
    provider
    Type
    String?
    Description

    The proxy service tag.

  • Name
    type
    Type
    String?
    Description

    The service category, as a ProxyType value. See Enumerations.

  • Name
    country_code
    Type
    String?
    Description

    The ISO 3166-1 alpha-2 country of the address.

  • Name
    asn
    Type
    Integer?
    Description

    The autonomous system number of the address.

  • Name
    timestamp
    Type
    Time?
    Description

    When the proxy was seen.

AnonymizerEvent

A VPN or anonymizer address range from the anonymizers feed.

  • Name
    range_start
    Type
    String?
    Description

    The first address of the range.

  • Name
    range_end
    Type
    String?
    Description

    The last address of the range.

  • Name
    provider
    Type
    String?
    Description

    The service tag.

  • Name
    type
    Type
    String?
    Description

    The service category, such as ProxyType::COMMERCIAL_VPN.

  • Name
    country_code
    Type
    String?
    Description

    The ISO 3166-1 alpha-2 country of range_start.

  • Name
    asn
    Type
    Integer?
    Description

    The autonomous system number of range_start.

  • Name
    timestamp
    Type
    Time?
    Description

    When the range was seen.

TorrentEvent

A torrent observed on the BitTorrent DHT or a tracker.

  • Name
    info_hash
    Type
    String?
    Description

    The hex-encoded SHA-1 info hash.

  • Name
    name
    Type
    String?
    Description

    The torrent's name.

  • Name
    magnet_uri
    Type
    String?
    Description

    The torrent's magnet link.

  • Name
    total_size
    Type
    Integer?
    Description

    The total size of the torrent's files in bytes.

  • Name
    piece_length
    Type
    Integer?
    Description

    The piece size in bytes.

  • Name
    file_count
    Type
    Integer?
    Description

    The number of files in the torrent.

  • Name
    files
    Type
    Array[TorrentFile]?
    Description

    The files in the torrent.

  • Name
    peers
    Type
    Array[TorrentPeer]?
    Description

    The peers seen sharing the torrent.

  • Name
    timestamp
    Type
    Time?
    Description

    When the torrent was seen.

TorrentFile

  • Name
    path
    Type
    String?
    Description

    The file path within the torrent.

  • Name
    length
    Type
    Integer?
    Description

    The file size in bytes.

TorrentPeer

  • Name
    ip
    Type
    String?
    Description

    The peer's address.

  • Name
    port
    Type
    Integer?
    Description

    The peer's port.

  • Name
    source
    Type
    String?
    Description

    Where the peer was found, such as "DHT", "PEX", or "tracker".

  • Name
    encrypted
    Type
    bool?
    Description

    Whether the peer supports encrypted connections.

JA4TEvent

A JA4T TCP fingerprint sighting.

  • Name
    ip
    Type
    String?
    Description

    The address the fingerprint was seen from.

  • Name
    ja4t
    Type
    String?
    Description

    The JA4T fingerprint.

  • Name
    provider
    Type
    String?
    Description

    The service tag of the address.

  • Name
    type
    Type
    String?
    Description

    The service category, such as ProxyType::DATACENTER_PROXY.

  • Name
    country_code
    Type
    String?
    Description

    The ISO 3166-1 alpha-2 country of the address.

  • Name
    asn
    Type
    Integer?
    Description

    The autonomous system number of the address.

  • Name
    timestamp
    Type
    Time?
    Description

    When the fingerprint was seen.

HeliosMeta

The Helios honeypot sensor that captured an event.

  • Name
    proxy_ip
    Type
    String?
    Description

    The proxy exit address the traffic arrived through.

  • Name
    server
    Type
    String?
    Description

    The sensor that captured the traffic.

  • Name
    pool_id
    Type
    String?
    Description

    The sensor pool.

  • Name
    provider
    Type
    String?
    Description

    The proxy service the traffic arrived through.

HeliosHTTPEvent

An HTTP request captured by a Helios honeypot.

  • Name
    timestamp
    Type
    Time
    Description

    When the request was captured.

  • Name
    tunnel_id
    Type
    Integer
    Description

    Identifies the proxy tunnel the request arrived through. Live values use the full unsigned 64-bit range.

  • Name
    domain
    Type
    String
    Description

    The host the tunnel was opened to.

  • Name
    port
    Type
    Integer
    Description

    The destination port.

  • Name
    protocol
    Type
    String
    Description

    Always "http".

  • Name
    meta
    Type
    HeliosMeta
    Description

    The capturing sensor.

  • Name
    details
    Type
    HTTPRequestDetails?
    Description

    The parsed request.

  • Name
    raw
    Type
    String?
    Description

    The raw request bytes as a binary String, decoded from the API's base64.

HTTPRequestDetails

A parsed HTTP request.

  • Name
    http_method
    Type
    String?
    Description

    The request method. The API names this field method.

  • Name
    uri
    Type
    String?
    Description

    The request target.

  • Name
    version
    Type
    String?
    Description

    The HTTP version, such as "HTTP/1.1".

  • Name
    headers
    Type
    Hash[String, String]?
    Description

    The request headers.

HeliosHTTPSEvent

A TLS ClientHello captured by a Helios honeypot.

  • Name
    timestamp
    Type
    Time
    Description

    When the handshake was captured.

  • Name
    tunnel_id
    Type
    Integer
    Description

    Identifies the proxy tunnel the handshake arrived through. Live values use the full unsigned 64-bit range.

  • Name
    domain
    Type
    String
    Description

    The host the tunnel was opened to.

  • Name
    port
    Type
    Integer
    Description

    The destination port.

  • Name
    protocol
    Type
    String
    Description

    Always "https".

  • Name
    meta
    Type
    HeliosMeta
    Description

    The capturing sensor.

  • Name
    details
    Type
    TLSClientHello?
    Description

    The parsed ClientHello, or nil if the sensor could not parse the handshake.

  • Name
    raw
    Type
    String?
    Description

    Always nil, because the sensors do not capture handshake bytes.

TLSClientHello

A TLS ClientHello parsed by a Helios sensor. Fields the sensor could not parse are nil.

  • Name
    record_version
    Type
    String?
    Description

    The record layer version, such as "TLS 1.0".

  • Name
    handshake_version
    Type
    String?
    Description

    The ClientHello version, such as "TLS 1.2".

  • Name
    client_random
    Type
    String?
    Description

    The hex-encoded 32-byte client random.

  • Name
    session_id
    Type
    String?
    Description

    The hex-encoded session ID.

  • Name
    session_id_length
    Type
    Integer?
    Description

    The length of the session ID in bytes.

  • Name
    cipher_suites
    Type
    Array[TLSCodeName]?
    Description

    The offered cipher suites.

  • Name
    compression_methods
    Type
    Array[Integer]?
    Description

    The offered compression methods.

  • Name
    extensions
    Type
    Array[TLSExtension]?
    Description

    The extensions in wire order.

  • Name
    sni
    Type
    String?
    Description

    The server_name extension value.

  • Name
    alpn
    Type
    Array[String]?
    Description

    The offered application protocols.

  • Name
    supported_versions
    Type
    Array[String]?
    Description

    The offered TLS versions.

  • Name
    supported_groups
    Type
    Array[TLSCodeName]?
    Description

    The offered key exchange groups.

  • Name
    signature_algorithms
    Type
    Array[TLSCodeName]?
    Description

    The offered signature algorithms.

  • Name
    ec_point_formats
    Type
    Array[String]?
    Description

    The offered elliptic curve point formats.

  • Name
    key_share_groups
    Type
    Array[String]?
    Description

    The groups the client sent key shares for.

  • Name
    psk_key_exchange_modes
    Type
    Array[String]?
    Description

    The offered pre-shared key exchange modes.

  • Name
    compress_certificate
    Type
    Array[String]?
    Description

    The offered certificate compression algorithms.

  • Name
    has_grease
    Type
    bool?
    Description

    Whether the ClientHello contains GREASE values.

  • Name
    application_settings
    Type
    bool?
    Description

    Whether the client offered application settings (ALPS).

  • Name
    delegated_credentials
    Type
    bool?
    Description

    Whether the client offered the delegated_credentials extension.

  • Name
    encrypt_then_mac
    Type
    bool?
    Description

    Whether the client offered the encrypt_then_mac extension.

  • Name
    extended_master_secret
    Type
    bool?
    Description

    Whether the client offered the extended_master_secret extension.

  • Name
    post_handshake_auth
    Type
    bool?
    Description

    Whether the client offered the post_handshake_auth extension.

  • Name
    renegotiation_info
    Type
    bool?
    Description

    Whether the client offered the renegotiation_info extension.

  • Name
    signed_certificate_timestamps
    Type
    bool?
    Description

    Whether the client offered the signed_certificate_timestamp extension.

  • Name
    status_request
    Type
    bool?
    Description

    Whether the client requested OCSP stapling.

TLSCodeName

A TLS registry code point and its name. GREASE values are named "GREASE(0x....)".

  • Name
    code
    Type
    Integer?
    Description

    The code point.

  • Name
    name
    Type
    String?
    Description

    The code point's registered name.

TLSExtension

An extension in a TLS ClientHello.

  • Name
    code
    Type
    Integer?
    Description

    The extension type.

  • Name
    name
    Type
    String?
    Description

    The extension's registered name.

  • Name
    length
    Type
    Integer?
    Description

    The extension body length in bytes.

HeliosDNSEvent

A destination that a Helios honeypot tunnel was asked to reach. Despite the feed's name, it is not a DNS query: names resolved inside a tunneled DNS session are not visible.

  • Name
    timestamp
    Type
    Time
    Description

    When the event was captured.

  • Name
    tunnel_id
    Type
    Integer
    Description

    Identifies the proxy tunnel. Live values use the full unsigned 64-bit range.

  • Name
    domain
    Type
    String
    Description

    The host name or address literal the tunnel was opened to.

  • Name
    port
    Type
    Integer
    Description

    The destination port.

  • Name
    protocol
    Type
    String
    Description

    Always "dns".

  • Name
    meta
    Type
    HeliosMeta
    Description

    The capturing sensor.

HeliosADBEvent

An Android Debug Bridge shell command captured by a Helios honeypot. It has no timestamp because the sensor sends none.

  • Name
    session
    Type
    String
    Description

    Identifies the ADB session as 32 hex characters.

  • Name
    sequential_id
    Type
    Integer
    Description

    The 1-based position of the command within its session.

  • Name
    command
    Type
    String
    Description

    The shell command. Invalid UTF-8 bytes are replaced with U+FFFD.

  • Name
    payload_hash
    Type
    String
    Description

    The hex-encoded SHA-256 the sensor assigns to the session's payload. The API names this field hash. It is not a hash of command: every command in a session shares it, and sessions that replay the same script share it too.

Enumerations

Each value set is a module of String constants under Synthient. Model fields hold plain strings, so compare them with the constants. Values the SDK does not know are kept as they are. The API may add values to the sets marked open, so handle unknown values instead of assuming a closed case.

NetworkType

The kind of network that announces an address. Open.

ConstantValue
NetworkType::MOBILEMOBILE
NetworkType::SATELLITESATELLITE
NetworkType::IN_FLIGHT_WIFIIN_FLIGHT_WIFI
NetworkType::RESIDENTIALRESIDENTIAL
NetworkType::CORPORATECORPORATE
NetworkType::ACADEMICACADEMIC
NetworkType::DATACENTERDATACENTER
NetworkType::GOVERNMENTGOVERNMENT

ProxyType

The kind of service seen on an address. Open.

ConstantValue
ProxyType::FREE_VPNFREE_VPN
ProxyType::COMMERCIAL_VPNCOMMERCIAL_VPN
ProxyType::ENTERPRISE_VPNENTERPRISE_VPN
ProxyType::MOBILE_PROXYMOBILE_PROXY
ProxyType::BLOCKCHAIN_PROXYBLOCKCHAIN_PROXY
ProxyType::RESIDENTIAL_PROXYRESIDENTIAL_PROXY
ProxyType::PUBLIC_PROXYPUBLIC_PROXY
ProxyType::DATACENTER_PROXYDATACENTER_PROXY
ProxyType::TOR_NODETOR_NODE
ProxyType::PRIVATE_RELAYPRIVATE_RELAY
ProxyType::BOTNETBOTNET
ProxyType::SEARCH_ENGINESEARCH_ENGINE
ProxyType::AI_CRAWLERAI_CRAWLER
ProxyType::SOCIAL_MEDIASOCIAL_MEDIA
ProxyType::UPTIME_MONITORUPTIME_MONITOR
ProxyType::LINK_PREVIEWLINK_PREVIEW
ProxyType::SEO_CRAWLERSEO_CRAWLER
ProxyType::WEB_ARCHIVERWEB_ARCHIVER
ProxyType::WEBHOOK_PROVIDERWEBHOOK_PROVIDER
ProxyType::PAYMENT_PROCESSORPAYMENT_PROCESSOR
ProxyType::INTERNET_SCANNERINTERNET_SCANNER

OS

A device operating system. Open.

ConstantValue
OS::ANDROIDAndroid
OS::CHROME_OSChrome OS
OS::FREEBSDFreeBSD
OS::IOSiOS
OS::LINUXLinux
OS::MAC_OS_XMac OS X
OS::WINDOWSWindows

Scope

A permission granted to an API key. Open. Scope::BASIC authorizes lookups and account. Each feed has one scope for its exports and one for its stream, as listed under Feeds. See Authentication for how scopes are granted.

ConstantValue
Scope::BASICBASIC
Scope::PROXY_FEEDSPROXY_FEEDS
Scope::PROXY_FIREHOSEPROXY_FIREHOSE
Scope::ANONYMIZERS_FEEDANONYMIZERS_FEED
Scope::ANONYMIZERS_STREAMANONYMIZERS_STREAM
Scope::JA3_FEEDJA3_FEED
Scope::JA3_STREAMJA3_STREAM
Scope::TORRENTS_FEEDTORRENTS_FEED
Scope::TORRENTS_STREAMTORRENTS_STREAM
Scope::HONEYPOT_HTTP_FEEDHONEYPOT_HTTP_FEED
Scope::HONEYPOT_HTTP_STREAMHONEYPOT_HTTP_STREAM
Scope::HONEYPOT_HTTPS_FEEDHONEYPOT_HTTPS_FEED
Scope::HONEYPOT_HTTPS_STREAMHONEYPOT_HTTPS_STREAM
Scope::HONEYPOT_ADB_FEEDHONEYPOT_ADB_FEED
Scope::HONEYPOT_ADB_STREAMHONEYPOT_ADB_STREAM
Scope::HONEYPOT_DNS_FEEDHONEYPOT_DNS_FEED
Scope::HONEYPOT_DNS_STREAMHONEYPOT_DNS_STREAM
Scope::JA4_FEEDJA4_FEED
Scope::JA4_STREAMJA4_STREAM
Scope::JA4T_FEEDJA4T_FEED
Scope::JA4T_STREAMJA4T_STREAM
Scope::ADMIN_PROXIESADMIN_PROXIES

Relation

An account's role in its organization.

ConstantValue
Relation::OWNEROWNER
Relation::ADMINADMIN
Relation::MEMBERMEMBER

DomainStatus

Whether a domain has recent activity.

ConstantValueMeaning
DomainStatus::ACTIVEactiveThe domain had events in the last 24 hours.
DomainStatus::INACTIVEinactiveThe domain had no events in the last 24 hours, or has never been observed.

Cadence

A sentence describing a domain's activity over the last 30 days.

ConstantValue
Cadence::NO_ACTIVITYNo activity in the last 30 days.
Cadence::EVENLY_DISTRIBUTEDActivity is evenly distributed across the day.
Cadence::BUSINESS_HOURSActivity follows a weekday business-hours pattern.
Cadence::WEEKENDActivity follows a weekend pattern.
Cadence::BURST_DRIVENActivity is burst-driven with significant peaks.

ExportKind

Whether an export covers an hour or a day.

ConstantValue
ExportKind::HOURLYhourly
ExportKind::DAILYdaily

ParquetType

The type of a Parquet column. Open.

ConstantValue
ParquetType::STRINGstring
ParquetType::INT64int64
ParquetType::UINT32uint32
ParquetType::UINT64uint64
ParquetType::BOOLbool
ParquetType::BYTESbytes