Class: SecurityTrails::Clients::General

Inherits:

SecurityTrails::Client

• Object
• SecurityTrails::Client
• SecurityTrails::Clients::General

Defined in:

lib/securitytrails/clients/general.rb

Constant Summary

Constants inherited from SecurityTrails::Client

SecurityTrails::Client::API_KEY_HEADER, SecurityTrails::Client::HOST, SecurityTrails::Client::URL, SecurityTrails::Client::VERSION

Instance Attribute Summary

Attributes inherited from SecurityTrails::Client

#api_key

Instance Method Summary

• #ping ⇒ Hash

  You can use this simple endpoint to test your authentication and access to the SecurityTrails API.

• #scroll(scroll_id) ⇒ Hash

  A fast and easy way to fetch many results.

• #usage ⇒ Hash

  Usage.

Methods inherited from SecurityTrails::Client

#initialize

Constructor Details

This class inherits a constructor from SecurityTrails::Client

Instance Method Details

#ping ⇒ Hash

You can use this simple endpoint to test your authentication and access to the SecurityTrails API.

Returns:

• (Hash)

See Also:

• https://docs.securitytrails.com/reference#ping

# File 'lib/securitytrails/clients/general.rb', line 13

def ping
  get("/ping") { |json| json }
end

#scroll(scroll_id) ⇒ Hash

A fast and easy way to fetch many results. Currently only available for the DSL API endpoints.

Parameters:

• The (String) —

  scroll_id returned in the scroll request.

Returns:

• (Hash)

See Also:

• https://docs.securitytrails.com/reference#scroll

# File 'lib/securitytrails/clients/general.rb', line 37

def scroll(scroll_id)
  get("/scroll/#{scroll_id}") { |json| json }
end

#usage ⇒ Hash

Usage

Returns:

• (Hash)

See Also:

• https://docs.securitytrails.com/reference#usage

# File 'lib/securitytrails/clients/general.rb', line 24

def usage
  get("/account/usage") { |json| json }
end