Psychic Model Download

post

https://api.greynoise.io/v1/psychic

Downloads a Psychic model file. The request body selects the model
(1, 2, 3, m1, m2, m3, model1, model2, or model3).
Models 1, 2, and 3 may set date to latest or a YYYY-MM-DD
date. When date is omitted, the latest daily model is used. Models 1,
2, and 3 may also request an inclusive date range with start_date and
end_date; ranges are limited to 30 days and return one combined
download.
Set format to mmdb to download a MaxMind DB file. When format
is omitted, the binary model format is used.

License: This endpoint requires the Psychic model meter entitlement
for the requested model. Historical dates also require that model's
Psychic lookback-days entitlement to cover the requested date or range
start date.

Body Params

Psychic model selector, optional daily model date or range, and optional file format.

model

string

enum

required

Psychic model selector. Accepted selectors identify models 1, 2, and 3.

date

string

When omitted, the latest daily model is used.

start_date

string

Inclusive range start date. Must be sent with end_date, cannot be combined with date, and is supported only for models 1, 2, and 3.

end_date

string

Inclusive range end date. Must be sent with start_date, cannot be combined with date, and ranges cannot exceed 30 days.

format

string

enum

Defaults to bin

Download file format. Defaults to bin.

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/octet-stream

application/vnd.maxmind.maxmind-db

application/json

200OK - binary Psychic model file.

400Bad request - request syntax is invalid for the Psychic download endpoint.

401Unauthorized. Please check your API key.

403Forbidden - request is not authorized due to API-key access, Psychic entitlement, or Psychic lookback limitations.

404Psychic model file not found.

413Request body too large. BI request-body inspection is limited to 32 KiB.

429Too many requests - either too many concurrent Psychic range downloads are being generated, or the requested Psychic model meter has no remaining usage. Retry later for concurrent-generation limits, or contact [email protected] to adjust model usage entitlements.

500Unexpected Psychic download error.