Types

View as markdown

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

Lookup types

Response models are sealed classes with init properties.

  • Nullability: A property whose type does not end in ? is always set: a response that omits it or sends null for it, or a null element in a list or dictionary, throws a SynthientException rather than producing a partial object.
  • Unknown fields: Fields the SDK does not know are ignored.
  • Units: Timestamps are DateTimeOffset values. The API sends most as Unix seconds and some as Unix milliseconds, and the SDK reads numbers of 1e12 or more as milliseconds and returns both in UTC. The exception is AccountApiKey.CreatedAt, which the API sends as an RFC 3339 string.

IPInfo

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

  • Name
    IP
    Type
    IPAddress
    Description

    The address that was looked up, as the API canonicalized it.

  • Name
    Network
    Type
    Network?
    Description

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

  • Name
    Location
    Type
    Location?
    Description

    The geolocation of the address, or null 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 null if the API has no intelligence data.

Network

  • Name
    Asn
    Type
    long
    Description

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

  • Name
    Isp
    Type
    string
    Description

    The name of the internet service provider.

  • Name
    Type
    Type
    string
    Description

    The kind of network, such as NetworkType.Residential. See Enumerations.

  • Name
    Org
    Type
    string?
    Description

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

  • Name
    Domain
    Type
    string?
    Description

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

  • Name
    AbuseEmail
    Type
    string?
    Description

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

  • Name
    AbusePhone
    Type
    string?
    Description

    The operator's abuse contact phone number, or null 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
    double
    Description

    The latitude in degrees.

  • Name
    Longitude
    Type
    double
    Description

    The longitude in degrees.

  • Name
    GeoHash
    Type
    string
    Description

    The geohash of the coordinates.

Intelligence

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

  • Name
    RiskScore
    Type
    int
    Description

    The risk of the address, from 0 to 100.

  • Name
    Categories
    Type
    IReadOnlyList<string>
    Description

    The kinds of services seen on the address, such as "RESIDENTIAL_PROXY". New values may be added.

  • Name
    Behavior
    Type
    IReadOnlyList<string>
    Description

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

  • Name
    Providers
    Type
    IReadOnlyList<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
    IReadOnlyList<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
    LastSeen
    Type
    DateTimeOffset
    Description

    When the service was last seen using the address.

Device

A device type seen behind an address.

  • Name
    OS
    Type
    string
    Description

    The operating system, such as DeviceOS.Android. See Enumerations.

  • Name
    Version
    Type
    string
    Description

    The operating system version.

  • Name
    LastSeen
    Type
    DateTimeOffset
    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, DomainStatus.Active or DomainStatus.Inactive.

  • Name
    Stats
    Type
    DomainStats
    Description

    Aggregate event counts.

  • Name
    TimeSeries
    Type
    IReadOnlyList<TimeSeriesPoint>
    Description

    Daily event counts.

  • Name
    UniqueIPs
    Type
    UniqueIPCounts
    Description

    The number of distinct source addresses.

  • Name
    TopAsn
    Type
    AsnCount?
    Description

    The network that sent the most events, or null if there were none.

  • Name
    TopSubdomains
    Type
    IReadOnlyList<SubdomainCount>
    Description

    The most targeted subdomains.

  • Name
    TopPorts
    Type
    IReadOnlyList<PortCount>
    Description

    The most targeted ports.

  • Name
    GeoDistribution
    Type
    IReadOnlyList<CountryCount>
    Description

    Event counts by source country.

  • Name
    HourDowHeatmap
    Type
    IReadOnlyList<IReadOnlyList<long>>
    Description

    The last 30 days of events by UTC day of week and hour, indexed as HourDowHeatmap[day][hour]. Day 0 is Monday, unlike DayOfWeek, where 0 is Sunday.

  • Name
    ActivityStats
    Type
    ActivityStats
    Description

    The hourly activity pattern.

  • Name
    RecentEvents
    Type
    IReadOnlyList<DomainEvent>
    Description

    The most recent events, capped by the lookup's limit.

DomainStats

  • Name
    Events24h
    Type
    long
    Description

    The number of events in the last 24 hours.

  • Name
    TotalEvents30d
    Type
    long
    Description

    The number of events in the last 30 days.

UniqueIPCounts

The number of distinct source addresses seen for a domain.

  • Name
    Value24h
    Type
    long
    Description

    The count for the last 24 hours.

  • Name
    Value30d
    Type
    long
    Description

    The count for the last 30 days.

  • Name
    Sparkline24h
    Type
    IReadOnlyList<long>
    Description

    Hourly counts for the last 24 hours.

TimeSeriesPoint

The event counts for one day.

  • Name
    Date
    Type
    DateTimeOffset
    Description

    The start of the UTC day.

  • Name
    Events
    Type
    long
    Description

    The number of events that day.

  • Name
    UniqueIPs
    Type
    long
    Description

    The number of distinct source addresses that day.

AsnCount

  • Name
    Asn
    Type
    long
    Description

    The autonomous system number.

  • Name
    Events
    Type
    long
    Description

    The number of events from the network.

SubdomainCount

  • Name
    Subdomain
    Type
    string
    Description

    The targeted subdomain.

  • Name
    Count
    Type
    long
    Description

    The number of events that targeted it.

PortCount

  • Name
    Port
    Type
    int
    Description

    The targeted port.

  • Name
    Count
    Type
    long
    Description

    The number of events that targeted it.

CountryCount

  • Name
    CountryCode
    Type
    string
    Description

    The ISO 3166-1 alpha-2 country code.

  • Name
    Events
    Type
    long
    Description

    The number of events from the country.

  • Name
    UniqueIPs
    Type
    long
    Description

    The number of distinct addresses from the country.

ActivityStats

The hourly activity pattern of a domain.

  • Name
    Cadence
    Type
    string
    Description

    A sentence describing how events are spread over the last 30 days. See Enumerations.

  • Name
    MedianPerHour
    Type
    long
    Description

    The median number of events per hour.

  • Name
    P95PerHour
    Type
    long
    Description

    The 95th percentile of events per hour.

  • Name
    PeakHour
    Type
    int
    Description

    The busiest UTC hour of the day.

  • Name
    QuietHour
    Type
    int
    Description

    The quietest UTC hour of the day.

DomainEvent

A single honeypot event for a domain.

  • Name
    Timestamp
    Type
    DateTimeOffset
    Description

    When the event happened.

  • Name
    SourceIP
    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
    TargetSubdomain
    Type
    string
    Description

    The subdomain that was targeted.

  • Name
    CountryCode
    Type
    string
    Description

    The source country.

  • Name
    Port
    Type
    int
    Description

    The targeted port.

Account types

Account

The account that owns the API key.

  • Name
    Email
    Type
    string
    Description

    The account holder's email address.

  • Name
    FirstName
    Type
    string
    Description

    The account holder's first name.

  • Name
    LastName
    Type
    string
    Description

    The account holder's last name.

  • Name
    Organization
    Type
    Organization
    Description

    The organization the account belongs to.

  • Name
    Scopes
    Type
    IReadOnlyList<string>
    Description

    The permissions granted to the API key. See Enumerations.

  • Name
    LookupQuota
    Type
    LookupQuota
    Description

    The remaining lookup credit balance.

  • Name
    ApiKey
    Type
    AccountApiKey?
    Description

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

Organization

  • Name
    Id
    Type
    string
    Description

    The organization's ID, a UUID.

  • Name
    Name
    Type
    string
    Description

    The organization's name.

  • Name
    Relation
    Type
    string
    Description

    The account's role in the organization. See Enumerations.

LookupQuota

An account's lookup credit balance.

  • Name
    Credits
    Type
    long
    Description

    The number of lookup credits remaining.

  • Name
    ResetsIn
    Type
    TimeSpan
    Description

    How long until the credits reset.

AccountApiKey

An API key. It never contains the secret key itself.

  • Name
    Id
    Type
    string
    Description

    The key's ID, a UUID.

  • Name
    Name
    Type
    string
    Description

    The key's display name.

  • Name
    CreatedAt
    Type
    DateTimeOffset
    Description

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

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
    IReadOnlyList<Export>
    Description

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

  • Name
    NextCursor
    Type
    string?
    Description

    Fetches the next page through the cursor parameter. It is null or empty on the last page.

Export

A Parquet export of a feed.

  • Name
    Id
    Type
    string
    Description

    Identifies the export for GetExportMetaAsync, GetDownloadUrlAsync, and DownloadAsync. On the first page, the newest hourly export may have the ID ExportId.Latest.

  • Name
    Kind
    Type
    string
    Description

    Whether the export covers an hour or a day, ExportKind.Hourly or ExportKind.Daily.

  • Name
    Date
    Type
    DateOnly
    Description

    The UTC day of the export.

  • Name
    Hour
    Type
    int?
    Description

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

  • Name
    SizeBytes
    Type
    long
    Description

    The size of the Parquet file in bytes.

  • Name
    RowCount
    Type
    long
    Description

    The number of rows in the file.

  • Name
    Checksum
    Type
    string
    Description

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

  • Name
    CreatedAt
    Type
    DateTimeOffset
    Description

    When the export was produced.

  • Name
    DownloadPath
    Type
    string
    Description

    The API path of the export's download, including the version prefix.

ExportMeta

A Parquet export's checksum, size, and schema, without its contents. Unlike Export.Date, its Date is a DateTimeOffset.

  • 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, ExportKind.Hourly or ExportKind.Daily.

  • Name
    Format
    Type
    string
    Description

    The file format, "parquet".

  • Name
    Date
    Type
    DateTimeOffset
    Description

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

  • Name
    Hour
    Type
    int?
    Description

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

  • Name
    Rows
    Type
    long
    Description

    The number of rows in the file.

  • Name
    Size
    Type
    long
    Description

    The size of the Parquet file in bytes.

  • Name
    Checksum
    Type
    string
    Description

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

  • Name
    CreatedAt
    Type
    DateTimeOffset
    Description

    When the export was produced.

  • Name
    Schema
    Type
    ParquetSchema
    Description

    The Parquet columns.

ParquetSchema

  • Name
    Fields
    Type
    IReadOnlyList<ParquetColumn>
    Description

    The columns in file order.

ParquetColumn

  • Name
    Name
    Type
    string
    Description

    The column name.

  • Name
    Type
    Type
    string
    Description

    The column type. See Enumerations.

Event types

Stream payloads match the Firehose and Helios documentation field for field. The API may omit any field of ProxyEvent, AnonymizerEvent, TorrentEvent, and Ja4tEvent, so all of their properties are nullable, as are those of TorrentFile and TorrentPeer. Timestamps are decoded as described under Lookup types.

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. See Enumerations.

  • Name
    CountryCode
    Type
    string?
    Description

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

  • Name
    Asn
    Type
    long?
    Description

    The autonomous system number of the address.

  • Name
    Timestamp
    Type
    DateTimeOffset?
    Description

    When the proxy was seen.

AnonymizerEvent

A VPN or anonymizer IP range from the Anonymizers feed.

  • Name
    RangeStart
    Type
    string?
    Description

    The first address of the range.

  • Name
    RangeEnd
    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.CommercialVpn.

  • Name
    CountryCode
    Type
    string?
    Description

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

  • Name
    Asn
    Type
    long?
    Description

    The autonomous system number of RangeStart.

  • Name
    Timestamp
    Type
    DateTimeOffset?
    Description

    When the range was seen.

TorrentEvent

A torrent observed on the BitTorrent DHT or a tracker.

  • Name
    InfoHash
    Type
    string?
    Description

    The hex-encoded SHA-1 info hash.

  • Name
    Name
    Type
    string?
    Description

    The torrent's name.

  • Name
    MagnetUri
    Type
    string?
    Description

    The torrent's magnet link.

  • Name
    TotalSize
    Type
    long?
    Description

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

  • Name
    PieceLength
    Type
    long?
    Description

    The piece size in bytes.

  • Name
    FileCount
    Type
    int?
    Description

    The number of files in the torrent.

  • Name
    Files
    Type
    IReadOnlyList<TorrentFile>?
    Description

    The files in the torrent.

  • Name
    Peers
    Type
    IReadOnlyList<TorrentPeer>?
    Description

    The peers seen sharing the torrent.

  • Name
    Timestamp
    Type
    DateTimeOffset?
    Description

    When the torrent was seen.

TorrentFile

  • Name
    Path
    Type
    string?
    Description

    The file path within the torrent.

  • Name
    Length
    Type
    long?
    Description

    The file size in bytes.

TorrentPeer

  • Name
    IP
    Type
    string?
    Description

    The peer's address.

  • Name
    Port
    Type
    int?
    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.DatacenterProxy.

  • Name
    CountryCode
    Type
    string?
    Description

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

  • Name
    Asn
    Type
    long?
    Description

    The autonomous system number of the address.

  • Name
    Timestamp
    Type
    DateTimeOffset?
    Description

    When the fingerprint was seen.

HeliosMeta

The Helios honeypot sensor that captured an event. The API may omit any of its fields.

  • Name
    ProxyIP
    Type
    string?
    Description

    The proxy exit address the traffic arrived through.

  • Name
    Server
    Type
    string?
    Description

    The sensor that captured the traffic.

  • Name
    PoolId
    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
    DateTimeOffset
    Description

    When the request was captured.

  • Name
    TunnelId
    Type
    ulong
    Description

    Identifies the proxy tunnel the request arrived through. Live values use the full ulong range.

  • Name
    Domain
    Type
    string
    Description

    The host the tunnel was opened to.

  • Name
    Port
    Type
    int
    Description

    The destination port.

  • Name
    Protocol
    Type
    string
    Description

    The protocol, "http".

  • Name
    Meta
    Type
    HeliosMeta
    Description

    The capturing sensor.

  • Name
    Details
    Type
    HttpRequestDetails?
    Description

    The parsed request, or null if the API omits it.

  • Name
    Raw
    Type
    byte[]?
    Description

    The raw request bytes, decoded from the API's base64, or null if the API omits them.

HttpRequestDetails

A parsed HTTP request. The API may omit any of its fields.

  • Name
    Method
    Type
    string?
    Description

    The request 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
    IReadOnlyDictionary<string, string>?
    Description

    The request headers.

HeliosHttpsEvent

A TLS ClientHello captured by a Helios honeypot.

  • Name
    Timestamp
    Type
    DateTimeOffset
    Description

    When the handshake was captured.

  • Name
    TunnelId
    Type
    ulong
    Description

    Identifies the proxy tunnel the handshake arrived through. Live values use the full ulong range.

  • Name
    Domain
    Type
    string
    Description

    The host the tunnel was opened to.

  • Name
    Port
    Type
    int
    Description

    The destination port.

  • Name
    Protocol
    Type
    string
    Description

    The protocol, "https".

  • Name
    Meta
    Type
    HeliosMeta
    Description

    The capturing sensor.

  • Name
    Details
    Type
    TlsClientHello?
    Description

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

  • Name
    Raw
    Type
    string?
    Description

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

TlsClientHello

A TLS ClientHello parsed by a Helios sensor. Fields the sensor could not parse are null, and new fields may be added.

  • Name
    RecordVersion
    Type
    string?
    Description

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

  • Name
    HandshakeVersion
    Type
    string?
    Description

    The ClientHello version, such as "TLS 1.2".

  • Name
    ClientRandom
    Type
    string?
    Description

    The hex-encoded 32-byte client random.

  • Name
    SessionId
    Type
    string?
    Description

    The hex-encoded session ID.

  • Name
    SessionIdLength
    Type
    int?
    Description

    The length of the session ID in bytes.

  • Name
    CipherSuites
    Type
    IReadOnlyList<TlsCodeName>?
    Description

    The offered cipher suites.

  • Name
    CompressionMethods
    Type
    IReadOnlyList<int>?
    Description

    The offered compression methods.

  • Name
    Extensions
    Type
    IReadOnlyList<TlsExtension>?
    Description

    The extensions in wire order.

  • Name
    Sni
    Type
    string?
    Description

    The server_name extension value.

  • Name
    Alpn
    Type
    IReadOnlyList<string>?
    Description

    The offered application protocols.

  • Name
    SupportedVersions
    Type
    IReadOnlyList<string>?
    Description

    The offered TLS versions.

  • Name
    SupportedGroups
    Type
    IReadOnlyList<TlsCodeName>?
    Description

    The offered key exchange groups.

  • Name
    SignatureAlgorithms
    Type
    IReadOnlyList<TlsCodeName>?
    Description

    The offered signature algorithms.

  • Name
    EcPointFormats
    Type
    IReadOnlyList<string>?
    Description

    The offered elliptic curve point formats.

  • Name
    KeyShareGroups
    Type
    IReadOnlyList<string>?
    Description

    The groups the client sent key shares for.

  • Name
    PskKeyExchangeModes
    Type
    IReadOnlyList<string>?
    Description

    The offered pre-shared key exchange modes.

  • Name
    CompressCertificate
    Type
    IReadOnlyList<string>?
    Description

    The offered certificate compression algorithms.

  • Name
    HasGrease
    Type
    bool?
    Description

    Whether the ClientHello contains GREASE values.

  • Name
    ApplicationSettings
    Type
    bool?
    Description

    Whether the client offered application settings (ALPS).

  • Name
    DelegatedCredentials
    Type
    bool?
    Description

    Whether the client offered the delegated_credentials extension.

  • Name
    EncryptThenMac
    Type
    bool?
    Description

    Whether the client offered the encrypt_then_mac extension.

  • Name
    ExtendedMasterSecret
    Type
    bool?
    Description

    Whether the client offered the extended_master_secret extension.

  • Name
    PostHandshakeAuth
    Type
    bool?
    Description

    Whether the client offered the post_handshake_auth extension.

  • Name
    RenegotiationInfo
    Type
    bool?
    Description

    Whether the client offered the renegotiation_info extension.

  • Name
    SignedCertificateTimestamps
    Type
    bool?
    Description

    Whether the client offered the signed_certificate_timestamp extension.

  • Name
    StatusRequest
    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
    int?
    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
    int?
    Description

    The extension type.

  • Name
    Name
    Type
    string?
    Description

    The extension's registered name.

  • Name
    Length
    Type
    int?
    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
    DateTimeOffset
    Description

    When the event was captured.

  • Name
    TunnelId
    Type
    ulong
    Description

    Identifies the proxy tunnel. Live values use the full ulong range.

  • Name
    Domain
    Type
    string
    Description

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

  • Name
    Port
    Type
    int
    Description

    The destination port.

  • Name
    Protocol
    Type
    string
    Description

    The protocol, "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
    SequentialId
    Type
    long
    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
    Hash
    Type
    string
    Description

    The hex-encoded SHA-256 the sensor assigns to the session's payload. 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 static class of string constants, and the properties that hold these values are typed string. Compare them with the constants, and handle values that have no constant: the API may add values to the sets marked open.

NetworkType

The kind of network that announces an address, used by Network.Type. Open.

ConstantValue
NetworkType.MobileMOBILE
NetworkType.SatelliteSATELLITE
NetworkType.InFlightWifiIN_FLIGHT_WIFI
NetworkType.ResidentialRESIDENTIAL
NetworkType.CorporateCORPORATE
NetworkType.AcademicACADEMIC
NetworkType.DatacenterDATACENTER
NetworkType.GovernmentGOVERNMENT

ProxyType

The kind of service seen on an address, used by ProxyEvent.Type, AnonymizerEvent.Type, and Ja4tEvent.Type. Open.

ConstantValue
ProxyType.FreeVpnFREE_VPN
ProxyType.CommercialVpnCOMMERCIAL_VPN
ProxyType.EnterpriseVpnENTERPRISE_VPN
ProxyType.MobileProxyMOBILE_PROXY
ProxyType.BlockchainProxyBLOCKCHAIN_PROXY
ProxyType.ResidentialProxyRESIDENTIAL_PROXY
ProxyType.PublicProxyPUBLIC_PROXY
ProxyType.DatacenterProxyDATACENTER_PROXY
ProxyType.TorNodeTOR_NODE
ProxyType.PrivateRelayPRIVATE_RELAY
ProxyType.BotnetBOTNET
ProxyType.SearchEngineSEARCH_ENGINE
ProxyType.AICrawlerAI_CRAWLER
ProxyType.SocialMediaSOCIAL_MEDIA
ProxyType.UptimeMonitorUPTIME_MONITOR
ProxyType.LinkPreviewLINK_PREVIEW
ProxyType.SeoCrawlerSEO_CRAWLER
ProxyType.WebArchiverWEB_ARCHIVER
ProxyType.WebhookProviderWEBHOOK_PROVIDER
ProxyType.PaymentProcessorPAYMENT_PROCESSOR
ProxyType.InternetScannerINTERNET_SCANNER

DeviceOS

A device operating system, used by Device.OS. Open.

ConstantValue
DeviceOS.AndroidAndroid
DeviceOS.ChromeOSChrome OS
DeviceOS.FreeBsdFreeBSD
DeviceOS.IOSiOS
DeviceOS.LinuxLinux
DeviceOS.MacOSXMac OS X
DeviceOS.WindowsWindows

Scope

A permission granted to an API key, used by Account.Scopes. Open. Scope.Basic authorizes lookups and GetAccountAsync. 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.ProxyFeedsPROXY_FEEDS
Scope.ProxyFirehosePROXY_FIREHOSE
Scope.AnonymizersFeedANONYMIZERS_FEED
Scope.AnonymizersStreamANONYMIZERS_STREAM
Scope.Ja3FeedJA3_FEED
Scope.Ja3StreamJA3_STREAM
Scope.TorrentsFeedTORRENTS_FEED
Scope.TorrentsStreamTORRENTS_STREAM
Scope.HoneypotHttpFeedHONEYPOT_HTTP_FEED
Scope.HoneypotHttpStreamHONEYPOT_HTTP_STREAM
Scope.HoneypotHttpsFeedHONEYPOT_HTTPS_FEED
Scope.HoneypotHttpsStreamHONEYPOT_HTTPS_STREAM
Scope.HoneypotAdbFeedHONEYPOT_ADB_FEED
Scope.HoneypotAdbStreamHONEYPOT_ADB_STREAM
Scope.HoneypotDnsFeedHONEYPOT_DNS_FEED
Scope.HoneypotDnsStreamHONEYPOT_DNS_STREAM
Scope.Ja4FeedJA4_FEED
Scope.Ja4StreamJA4_STREAM
Scope.Ja4tFeedJA4T_FEED
Scope.Ja4tStreamJA4T_STREAM
Scope.AdminProxiesADMIN_PROXIES

Relation

An account's role in its organization, used by Organization.Relation.

ConstantValue
Relation.OwnerOWNER
Relation.AdminADMIN
Relation.MemberMEMBER

DomainStatus

Whether a domain has recent activity, used by DomainInfo.Status.

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 pattern, used by ActivityStats.Cadence.

ConstantValue
Cadence.NoActivityNo activity in the last 30 days.
Cadence.EvenlyDistributedActivity is evenly distributed across the day.
Cadence.BusinessHoursActivity follows a weekday business-hours pattern.
Cadence.WeekendActivity follows a weekend pattern.
Cadence.BurstDrivenActivity is burst-driven with significant peaks.

ExportKind

Whether an export covers an hour or a day, used by Export.Kind and ExportMeta.Kind.

ConstantValue
ExportKind.Hourlyhourly
ExportKind.Dailydaily

ParquetType

The type of a Parquet column, used by ParquetColumn.Type. Open.

ConstantValue
ParquetType.Stringstring
ParquetType.Int64int64
ParquetType.UInt32uint32
ParquetType.UInt64uint64
ParquetType.Boolbool
ParquetType.Bytesbytes