> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tracecat.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Spur (Context API)

> Reference for the Tracecat Spur (Context API) integration: registered actions, required secrets, expected inputs, and example workflow usage.

## Lookup API token status

Action ID: `tools.spur.lookup_api_token_status`

Retrieve the Spur API token's status, the number of queries it can still make, and the service tier. Does not use a query. Calls GET /status directly.

Reference: [https://docs.spur.us/context-api/endpoints#lookup-api-token-status](https://docs.spur.us/context-api/endpoints#lookup-api-token-status)

### Secrets

Required secrets:

* `spur`: required values `SPUR_TOKEN`.

### Input fields

**base\_url** `string | null`

Spur API base URL.

Default: `null`.

## Lookup IP address

Action ID: `tools.spur.lookup_ip`

Retrieve the Spur IP Context Object for an IPv4 or IPv6 address, or the context for a past date when `dt` is set. Calls GET /v2/context/\{ip} directly.

Reference: [https://docs.spur.us/context-api/endpoints#lookup-an-ip-address](https://docs.spur.us/context-api/endpoints#lookup-an-ip-address)

### Secrets

Required secrets:

* `spur`: required values `SPUR_TOKEN`.

### Input fields

**ip** `string` *required*

Public IPv4 or IPv6 address to look up.

**base\_url** `string | null`

Spur API base URL.

Default: `null`.

**dt** `string | null`

A datetime in the format YYYYmmdd. Only valid for tokens with the Context API Historical Query permission (Pro plans and above); other tokens get a 401.

Default: `null`.

**mmgeo** `integer | null`

A boolean value, that when set to 1, will return MaxMind's GeoLite2 geolocation data instead of Spur's geolocation data in the location object.

Default: `null`.

## Lookup tag metadata

Action ID: `tools.spur.lookup_tag_metadata`

Retrieve the Spur Tag Metadata Object (summary, metrics and attributes) for a service tag such as OXYLABS\_PROXY or PROTON\_VPN. Calls GET /v2/metadata/tags/\{tag} directly.

Reference: [https://docs.spur.us/context-api/endpoints#lookup-tag-metadata](https://docs.spur.us/context-api/endpoints#lookup-tag-metadata)

### Secrets

Required secrets:

* `spur`: required values `SPUR_TOKEN`.

### Input fields

**tag** `string` *required*

Service tag to look up, e.g. a tunnel operator or proxy tag returned in an IP Context Object (OXYLABS\_PROXY, PROTON\_VPN).

**base\_url** `string | null`

Spur API base URL.

Default: `null`.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.