Skip to content

Commit e9b2406

Browse files
committed
IDEV-2011: Add documentation for Real-Time Threat Intelligence Feeds
1 parent 0d21455 commit e9b2406

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -211,5 +211,28 @@ API_KEY
211211
Python Version Support Policy
212212
===================
213213

214-
Please see the [supported versions](https://github.com/DomainTools/python_api/raw/main/PYTHON_SUPPORT.md) document
214+
Please see the [supported versions](https://github.com/DomainTools/python_api/raw/main/PYTHON_SUPPORT.md) document
215215
for the DomainTools Python support policy.
216+
217+
218+
Real-Time Threat Intelligence Feeds
219+
===================
220+
221+
Real-Time Threat Intelligence Feeds provide data on the different stages of the domain lifecycle: from first-observed in the wild, to newly re-activated after a period of quiet. Access current feed data in real-time or retrieve historical feed data through separate APIs.
222+
223+
Custom parameters aside from the common `GET` Request parameters:
224+
- `endpoint` (choose either `download` or `feed` API endpoint - default is `feed`)
225+
```python
226+
api = API(USERNAME, KEY)
227+
api.nod(endpoint="download")
228+
```
229+
- `header_authentication`: by default, we're using API Header Authentication. Set this False if you want to use API Key and Secret Authentication
230+
```python
231+
api = API(USERNAME, KEY)
232+
api.nod(header_authentication=False, **kwargs)
233+
```
234+
- `output_format`: (choose either `csv` or `jsonl` - default is `jsonl`). Cannot be used in `domainrdap` feeds. Additionally, `csv` is not available for `download` endpoints.
235+
```python
236+
api = API(USERNAME, KEY)
237+
api.nod(output_format="csv", **kwargs)
238+
```

0 commit comments

Comments
 (0)