Every endpoint of the API Reference is in the Deepinfo Postman collection, in the same modules and groups as on this site, with its parameters, request bodies and descriptions. Download the collection and the Production environment, add your API key and send your first request in a few minutes.

Set It Up

  1. Download both files with the buttons above.
  2. In Postman, choose Import and drop both files.
  3. Select the Deepinfo - Production environment in Postman's environment menu.
  4. Put your API key in that environment's api_key variable, in Current value, so it stays on your machine. No key yet? See Get an API Key.
  5. Open a request, for example Lookup › Domain WHOIS, and select Send.

Authentication is set once on the collection (Authorization tab, API Key): every request sends your key in the apikey header, so you never add it by hand.

Variables

Every URL in the collection starts with {{api_base_url}}/{{api_version}}, so the host and the version come from the selected environment.

Variable Value Description
api_base_url https://api.deepinfo.com API host, without /v1
api_version v1 API version, the first path segment of every endpoint
api_key your key Sent in the apikey header of every request

The three variables are defined on the collection (defaults) and in the environment. The environment wins, so keep your key there.

Demo Accounts

With a demo account, set api_base_url to https://api.deepinfodemo.com in your environment. A copy of the environment named Demo lets you keep both. See Environments & Base URL.

What It Contains

  • Every request of the API Reference, with its query and path parameters and, for searches and other POST requests, a request body to start from. Search & Filters explains the filter format.
  • Two checks after every request: the response must not be a server error, and a 401 is reported as a missing API key. The deepinfo-request-id header of the last response is kept in the last_request_id collection variable: include it when you contact support@deepinfo.com.
  • The requests behind the error examples of Errors, in the Getting Started › Errors folder.
  • No saved example responses. Each endpoint's page on this site shows its example responses, and in Postman you see your own data.

Updates

The collection is built from the same source as this site, so it changes when the reference does. Download it again to get new endpoints and changes; the Changelog lists them.

Last updated