Skip to content

A Ruby client for Trade.gov's Consolidated Screening List

License

Notifications You must be signed in to change notification settings

Hacker0x01/import_export

 
 

Repository files navigation

ImportExport

Gem Version Build Status

A Ruby client for Trade.gov's Consolidated Screening List.

Usage

client = ImportExport::Client.new :api_key => "12345"
client.search :q => "smith"
=> [
  #<ImportExport::Result name="PRIDMORE-SMITH, BRAMWELL J.">,
  #<ImportExport::Result name="PRIDMORE-SMITH, JOHN B.">
]

client.search :name => "smith", :fuzzy_name => true
=> [
  #<ImportExport::Result name="PRIDMORE-SMITH, JOHN B.">,
  #<ImportExport::Result name="PRIDMORE-SMITH, BRAMWELL J.">,
  #<ImportExport::Result name="MID-SOUTH INVESTMENTS LIMITED">,
  #<ImportExport::Result name="SOUTH-EAST MOVEMENT">,
  ...
]

NOTE: api_key defaults to ENV["TRADE_API_KEY"] if not specified.

Available parameters

  • q
  • sources
  • countries (defaults to all countries)
  • address
  • name
  • fuzzy_name (true or false)
  • type
  • size (number of results per page, defaults to 100)
  • offset (defaults to 0)

For more information, see the Consolidated Screening List API docs.

Command line usage

import_export [NAME]

Contributing

  1. Fork it (https://github.com/[my-github-username]/consolidated_screening_list/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

About

A Ruby client for Trade.gov's Consolidated Screening List

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Ruby 92.3%
  • Shell 7.7%