Skip to content

Analyst Notes

Introduction

The AnalystNoteMgr class of the analyst_notes module allows you to download, search, publish and fetch attachments of analyst notes. An analyst note is a note that is either:

  • written and published by someone in your organization via the Recorded Future portal or the Recorded Future API,
  • written and published by the Recorded Future Insikt team.

See the API Reference for internal details of the module.

Notes

  1. When searching for multiple notes or fetching a single note by id_, the object returned is the same. This is different from most of the Recorded Future API behaviours where a search is a portion of the full object. Which means that you don't have to search for all the new notes and fetch them one by one to get the full details.
  2. When searching for multiple notes, the number of notes returned is not defined by the max_results parameter. The max_results defined the maximum number of references from which notes are fetched, up to 1000. Note: The number of notes returned can be lower than this limit if some of the fetched references links to the same analyst note.

Examples

Warning

Below are some examples of usage of the module. Consider adding error handling as necessary. All the errors that can be raised by each method or function are specified in the API Reference page.

Also, you need to configure the RF_TOKEN environment variable before starting. See Learn.

Example 1: Search for the last day of analyst notes, download and save the attachments if present.

The fetch_attachment method returns a tuple with the attachment content and extension. If the note does not contain an attachment, it will return empty content and extension. To limit the number of calls made to the API, you can check if the attribute attachment is present, if yes fetch the attachment. 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
from pathlib import Path

from psengine.analyst_notes import AnalystNoteMgr, save_attachment

OUTPUT_DIR = Path(__file__).parent / 'attachments'
OUTPUT_DIR.mkdir(exist_ok=True)

mgr = AnalystNoteMgr()
notes = mgr.search(published='-1d')

for note in notes:
    if note.attributes.attachment:
        attachment, ext = mgr.fetch_attachment(note.id_)
        save_attachment(note.id_, attachment, ext, OUTPUT_DIR)

Example 2: Search for the last day of analyst notes, download and save them as markdown.

Similarly to the previous example, you can generate the markdown of an analyst note calling the markdown method defined for the AnalystNote object. In this example we are setting max_results to 2 for a shorter output, since we are printing the markdown to console.

To run this example you will first need to add the rich package to your virtual environment: 

1
pip install rich
After that you can run it and see the markdown begin written in the terminal and being saved in the attachment directory. 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from pathlib import Path

from rich.console import Console

from psengine.analyst_notes import AnalystNoteMgr, save_attachment

OUTPUT_DIR = Path(__file__).parent / 'attachments'
OUTPUT_DIR.mkdir(exist_ok=True)

mgr = AnalystNoteMgr()
console = Console()
notes = mgr.search(published='-1d', max_results=2)

for note in notes:
    markdown = note.markdown(diamond_model=True)
    save_attachment(note.id_, markdown, 'md', OUTPUT_DIR)

    console.print(markdown)
    console.print('---------------------------')
The markdown method accept different arguments, such as diamond_model to add to the markdown the diamond model information, if present. For more information see the API Reference.

In this example we use the search method with the topic argument, which accept either a string or a list of strings by topic id. The list of topic ids can be found in the Analyst Note API support article. When performing a search, notes are getting deduplicated, in case you select two or more topics and a note is tagged with both of them.

The save_note method can be used to save the note as json. 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from pathlib import Path

from psengine.analyst_notes import AnalystNoteMgr, save_note

OUTPUT_DIR = Path(__file__).parent / 'attachments'
OUTPUT_DIR.mkdir(exist_ok=True)

mgr = AnalystNoteMgr()
notes = mgr.search(published='-1y', topic=['xG68dQ', 'xG68dS'])

for note in notes:
    save_note(note, OUTPUT_DIR)