backscatterio 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5508c62631c77d734b28d680bbb89c49a56eda99
+  data.tar.gz: ce8ae7f744ba3b595c591a7fc3bc8ebcd283c9f0
+SHA512:
+  metadata.gz: f78082fa1777ec84a86bf497876bc2d79c633682129588ae287bff6c3e1634ffb012bfe0a77e1718d6ae10524954c21c598717f9871f27c104d5f6945f4cca69
+  data.tar.gz: c2f87dc57d467364a7192f6af912da489ab5cc6e63d42f2e01383b8491d050b0d4d3522e15407e8add4db4ec68d831cefa451b42d295e1dbb3bb0d0f88ee3834

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+end

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,120 @@
+# Backscatter.io Ruby
+
+BackscatterIO - the Ruby gem for the Backscatter.io
+
+[This is the Backscatter.io API.](https://backscatter.io/developers) 
+
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API version: 1.0.0
+- Package version: 1.0.0
+- Build package: io.swagger.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build backscatterio.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./backscatterio-1.0.0.gem
+```
+(for development, run `gem install --dev ./backscatterio-1.0.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'backscatterio', '~> 1.0.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/backscatterio/ruby, then add the following in the Gemfile:
+
+    gem 'backscatterio', :git => 'https://github.com/backscatterio/ruby.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+```ruby
+# Load the gem
+require 'backscatterio'
+
+# Setup authorization
+BackscatterIO.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-KEY'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-API-KEY'] = 'Bearer'
+end
+
+api_instance = BackscatterIO::Api.new
+
+query = 'query_example' # String | 
+
+
+begin
+  #enriches asn
+  result = api_instance.enrich_asn(query)
+  p result
+rescue BackscatterIO::ApiError => e
+  puts "Exception when calling Api->enrich_asn: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.backscatter.io/v0*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*BackscatterIO::Api* | [**enrich_asn**](docs/Api.md#enrich_asn) | **GET** /enrichment/asn | enriches asn
+*BackscatterIO::Api* | [**enrich_ip**](docs/Api.md#enrich_ip) | **GET** /enrichment/ip | enriches ip
+*BackscatterIO::Api* | [**enrich_network**](docs/Api.md#enrich_network) | **GET** /enrichment/network | enriches network
+*BackscatterIO::Api* | [**hello**](docs/Api.md#hello) | **GET** /hello | authenticate to the service
+*BackscatterIO::Api* | [**observations**](docs/Api.md#observations) | **GET** /observations/{queryType} | fetches observations for a given ip address
+*BackscatterIO::Api* | [**trends**](docs/Api.md#trends) | **GET** /trends/popular/{trendType} | Top N items
+
+
+## Documentation for Models
+
+ - [BackscatterIO::ASNEnrichment](docs/ASNEnrichment.md)
+ - [BackscatterIO::ASNEnrichmentResults](docs/ASNEnrichmentResults.md)
+ - [BackscatterIO::Hello](docs/Hello.md)
+ - [BackscatterIO::IPEnrichment](docs/IPEnrichment.md)
+ - [BackscatterIO::IPEnrichmentResults](docs/IPEnrichmentResults.md)
+ - [BackscatterIO::NetworkEnrichment](docs/NetworkEnrichment.md)
+ - [BackscatterIO::NetworkEnrichmentResults](docs/NetworkEnrichmentResults.md)
+ - [BackscatterIO::Observation](docs/Observation.md)
+ - [BackscatterIO::Observations](docs/Observations.md)
+ - [BackscatterIO::Query](docs/Query.md)
+ - [BackscatterIO::Results](docs/Results.md)
+ - [BackscatterIO::Summary](docs/Summary.md)
+ - [BackscatterIO::Trends](docs/Trends.md)
+ - [BackscatterIO::Unique](docs/Unique.md)
+
+
+## Documentation for Authorization
+
+
+### ApiKeyAuth
+
+- **Type**: API key
+- **API key parameter name**: X-API-KEY
+- **Location**: HTTP header
+

data/Rakefile

@@ -0,0 +1,8 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/backscatterio.gemspec

@@ -0,0 +1,45 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#Backscatter.io
+
+#[This is the Backscatter.io API.](https://backscatter.io/developers) 
+
+OpenAPI spec version: 1.0.0
+Contact: info@backscatter.io
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.0
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "backscatterio/version"
+
+Gem::Specification.new do |s|
+  s.name        = "backscatterio"
+  s.version     = BackscatterIO::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["rubygems@chrislee.dhs.org"]
+  s.email       = ["rubygems@chrislee.dhs.org"]
+  s.homepage    = "https://github.com/backscatterio/ruby"
+  s.summary     = "Backscatter.io Ruby Gem"
+  s.description = "[This is the Backscatter.io API.](https://backscatter.io/developers) "
+  s.license     = "Unlicense"
+  s.required_ruby_version = ">= 1.9"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+  s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
+  s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
+  s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
+  s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
+  s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
+  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/docs/ASNEnrichment.md

@@ -0,0 +1,9 @@
+# SwaggerClient::ASNEnrichment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**results** | [**ASNEnrichmentResults**](ASNEnrichmentResults.md) |  | [optional] 
+**success** | **BOOLEAN** |  | [optional] 
+
+

data/docs/ASNEnrichmentResults.md

@@ -0,0 +1,11 @@
+# SwaggerClient::ASNEnrichmentResults
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**as_num** | **Integer** |  | [optional] 
+**as_name** | **String** |  | [optional] 
+**prefix_count** | **Integer** |  | [optional] 
+**prefixes** | **Array<String>** |  | [optional] 
+
+

data/docs/Api.md

@@ -0,0 +1,339 @@
+# BackscatterIO::Api
+
+All URIs are relative to *https://api.backscatter.io/v0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**enrich_asn**](Api.md#enrich_asn) | **GET** /enrichment/asn | enriches asn
+[**enrich_ip**](Api.md#enrich_ip) | **GET** /enrichment/ip | enriches ip
+[**enrich_network**](Api.md#enrich_network) | **GET** /enrichment/network | enriches network
+[**hello**](Api.md#hello) | **GET** /hello | authenticate to the service
+[**observations**](Api.md#observations) | **GET** /observations/{queryType} | fetches observations for a given ip address
+[**trends**](Api.md#trends) | **GET** /trends/popular/{trendType} | Top N items
+
+
+# **enrich_asn**
+> ASNEnrichment enrich_asn(query)
+
+enriches asn
+
+returns enrichment data for an ASN
+
+### Example
+```ruby
+# load the gem
+require 'backscatterio'
+# setup authorization
+BackscatterIO.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-KEY'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-API-KEY'] = 'Bearer'
+end
+
+api_instance = BackscatterIO::Api.new
+
+query = 'query_example' # String | 
+
+
+begin
+  #enriches asn
+  result = api_instance.enrich_asn(query)
+  p result
+rescue BackscatterIO::ApiError => e
+  puts "Exception when calling Api->enrich_asn: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **query** | **String**|  | 
+
+### Return type
+
+[**ASNEnrichment**](ASNEnrichment.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **enrich_ip**
+> IPEnrichment enrich_ip(query)
+
+enriches ip
+
+returns enrichment data for an ip
+
+### Example
+```ruby
+# load the gem
+require 'backscatterio'
+# setup authorization
+BackscatterIO.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-KEY'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-API-KEY'] = 'Bearer'
+end
+
+api_instance = BackscatterIO::Api.new
+
+query = 'query_example' # String | 
+
+
+begin
+  #enriches ip
+  result = api_instance.enrich_ip(query)
+  p result
+rescue BackscatterIO::ApiError => e
+  puts "Exception when calling Api->enrich_ip: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **query** | **String**|  | 
+
+### Return type
+
+[**IPEnrichment**](IPEnrichment.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **enrich_network**
+> NetworkEnrichment enrich_network(query)
+
+enriches network
+
+returns enrichment data for a network
+
+### Example
+```ruby
+# load the gem
+require 'backscatterio'
+# setup authorization
+BackscatterIO.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-KEY'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-API-KEY'] = 'Bearer'
+end
+
+api_instance = BackscatterIO::Api.new
+
+query = 'query_example' # String | 
+
+
+begin
+  #enriches network
+  result = api_instance.enrich_network(query)
+  p result
+rescue BackscatterIO::ApiError => e
+  puts "Exception when calling Api->enrich_network: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **query** | **String**|  | 
+
+### Return type
+
+[**NetworkEnrichment**](NetworkEnrichment.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **hello**
+> Hello hello
+
+authenticate to the service
+
+### Example
+```ruby
+# load the gem
+require 'backscatterio'
+# setup authorization
+BackscatterIO.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-KEY'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-API-KEY'] = 'Bearer'
+end
+
+api_instance = BackscatterIO::Api.new
+
+begin
+  #authenticate to the service
+  result = api_instance.hello
+  p result
+rescue BackscatterIO::ApiError => e
+  puts "Exception when calling Api->hello: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Hello**](Hello.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **observations**
+> Observations observations(query_type, query, opts)
+
+fetches observations for a given ip address
+
+### Example
+```ruby
+# load the gem
+require 'backscatterio'
+# setup authorization
+BackscatterIO.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-KEY'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-API-KEY'] = 'Bearer'
+end
+
+api_instance = BackscatterIO::Api.new
+
+query_type = 'query_type_example' # String | query type ip, network, asn, port, country
+
+query = 'query_example' # String | ip address, cidr block, asn, port, or country
+
+opts = { 
+  scope: 'scope_example' # String | timeframe to search over, e.g., 1d, 7d
+}
+
+begin
+  #fetches observations for a given ip address
+  result = api_instance.observations(query_type, query, opts)
+  p result
+rescue BackscatterIO::ApiError => e
+  puts "Exception when calling Api->observations: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **query_type** | **String**| query type ip, network, asn, port, country | 
+ **query** | **String**| ip address, cidr block, asn, port, or country | 
+ **scope** | **String**| timeframe to search over, e.g., 1d, 7d | [optional] 
+
+### Return type
+
+[**Observations**](Observations.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **trends**
+> Trends trends(trend_type, opts)
+
+Top N items
+
+A listing of the top N items observered over the query scope
+
+### Example
+```ruby
+# load the gem
+require 'backscatterio'
+# setup authorization
+BackscatterIO.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-KEY'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-API-KEY'] = 'Bearer'
+end
+
+api_instance = BackscatterIO::Api.new
+
+trend_type = 'trend_type_example' # String | which item type you want to perform a trend over
+
+opts = { 
+  scope: 'scope_example' # String | timeframe to search over, e.g., 1d, 7d
+}
+
+begin
+  #Top N items
+  result = api_instance.trends(trend_type, opts)
+  p result
+rescue BackscatterIO::ApiError => e
+  puts "Exception when calling Api->trends: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **trend_type** | **String**| which item type you want to perform a trend over | 
+ **scope** | **String**| timeframe to search over, e.g., 1d, 7d | [optional] 
+
+### Return type
+
+[**Trends**](Trends.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+