{"id":15606389,"url":"https://github.com/encoreshao/amazon-awis","last_synced_at":"2025-10-13T13:31:01.747Z","repository":{"id":56842699,"uuid":"84406332","full_name":"encoreshao/amazon-awis","owner":"encoreshao","description":"Amazon - Alexa Web Information Service (AWIS)","archived":true,"fork":false,"pushed_at":"2021-08-13T11:25:45.000Z","size":84,"stargazers_count":6,"open_issues_count":0,"forks_count":5,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-10-02T04:49:55.112Z","etag":null,"topics":["alexa","amazon","api","ruby","ruby-client"],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/encoreshao.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-03-09T06:26:57.000Z","updated_at":"2024-09-18T13:41:40.000Z","dependencies_parsed_at":"2022-08-29T10:51:19.553Z","dependency_job_id":null,"html_url":"https://github.com/encoreshao/amazon-awis","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/encoreshao/amazon-awis","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/encoreshao%2Famazon-awis","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/encoreshao%2Famazon-awis/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/encoreshao%2Famazon-awis/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/encoreshao%2Famazon-awis/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/encoreshao","download_url":"https://codeload.github.com/encoreshao/amazon-awis/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/encoreshao%2Famazon-awis/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279006321,"owners_count":26084085,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-11T02:00:06.511Z","response_time":55,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["alexa","amazon","api","ruby","ruby-client"],"created_at":"2024-10-03T04:22:14.634Z","updated_at":"2025-10-13T13:31:01.453Z","avatar_url":"https://github.com/encoreshao.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Amazon - Alexa Web Information Service (AWIS)\nRuby Library for AWIS REST API - see: [Alexa Docs](http://docs.amazonwebservices.com/AlexaWebInfoService/latest/)\n\n### How to installation\n\n```ruby\ngem install awis-sdk-ruby\n```\n\n### Support Ruby 2.x \n\n- The latest update requires Ruby 2.0 or higher\n\n### How to usage\n\n##### Configure your amazon certificate\n\n```ruby\nrequire 'awis'\n\nAWIS_CONFIG = YAML.load(File.read('awis.yml'))\nAwis.config do |c|\n  c.access_key_id       = AWIS_CONFIG['access_key_id']\n  c.secret_access_key   = AWIS_CONFIG['secret_access_key']\n  c.debug               = AWIS_CONFIG['debug']\n  c.protocol            = 'https' # Default 'https'\n  c.timeout             = 10 # Default 10\n  c.open_timeout        = 10 # Default 10\n  c.logger              = false # Default nil\nend\n```\n\n##### Get Url Info\n\n```ruby\nclient = Awis::Client.new\nurl_info = client.url_info(url: \"site.com\")\n```\n\nIf you looking for the API request URI:\n\n```ruby\nAwis::API::UrlInfo.new.load_request_uri(url: 'site.com')\n```\n\nreturns object that contains attributes:\n\n* data_url\n* rank\n* asin\n* xml\n\nNew methods:\n\n* is_404?\n* not_found?\n* pretty_xml\n\n`pretty_xml` method will easily to review the XML response from the terminal\n\nreturns object that contains relationships:\n\n**contact_info**\n- attrubutes\n  - data_url\n  - owner_name\n  - email\n  - physical_address\n  - company_stock_ticker\n  - phone_numbers\n\n**content_data**\n- attrubutes\n  - data_url\n  - site_title\n  - site_description\n  - speed_median_load_time\n  - speed_percentile\n  - adult_content\n  - language_locale\n  - links_in_count\n  - owned_domains\n\n**usage_statistics**\n- attrubutes\n  - time_range_months\n  - time_range_days\n  - rank_value\n  - rank_delta\n  - reach_rank_value\n  - reach_rank_delta,\n  - reach_per_million_value\n  - reach_per_million_delta\n  - page_views_per_million_value\n  - page_views_per_million_delta,\n  - page_views_rank_value\n  - page_views_rank_delta\n  - page_views_per_user_value\n  - page_views_per_user_delta\n- Methods: \n  - range_type\n  - range_count\n\n**related_links** \n- attrubutes\n  - data_url\n  - navigable_url\n  - title\n\n**categories** \n- attrubutes\n  - title\n  - absolute_path\n\nYou can specify options:\n\n* url\n* response_group - which data to include in response (i.e. [\"rank\", \"contact_info\", \"content_data\"]) - defaults to all available\n\n##### Get Sites Linking In\n\n```ruby\nclient = Awis::Client.new\nsites_linking_in = client.sites_linking_in(url: \"site.com\")\n```\n\nIf you looking for the API request URI:\n\n```ruby\nAwis::API::SitesLinkingIn.new.load_request_uri(url: 'site.com')\n```\n\nReturns object that contains relationships:\n\n* sites [:title, :url]\n\nYou can specify options:\n\n* url\n* count - how many results to retrieve - defaults to max value that is 20\n* start - offset of results - defaults to 0\n\n##### Get Traffic History\n\n```ruby\nclient = Awis::Client.new\ntraffic_history = client.traffic_history(url: \"site.com\")\n```\n\nIf you looking for the API request URI:\n\n```ruby\nAwis::API::TrafficHistory.new.load_request_uri(url: 'site.com')\n```\n\nReturns object that contains methods:\n\n* range\n* site\n* start\n\nReturns object that contains relationships:\n\n* historical_data [:date, :page_views_per_million, :page_views_per_user, :rank, :reach_per_million]\n\nYou can specify options:\n\n* url\n* range - how many days to retrieve - defaults to max value 31\n* start - start date (i.e. \"20120120\", 4.days.ago) - defaults to range number days ago\n\n##### Get Category Listings\n\n```ruby\nclient = Awis::Client.new\ncategory_listings = client.category_listings(path: \"Top/Arts\")\n```\n\nIf you looking for the API request URI:\n\n```ruby\nAwis::API::CategoryListings.new.load_request_uri(path: \"Top/Games/Card_Games\")\n```\n\nReturns object that contains methods:\n\n* count\n* recursive_count\n\nReturns object that contains relationships:\n\n* listings [:data_url, :title, :popularity_rank, :description]\n\n##### Get Category Browse\n\n```ruby\nclient = Awis::Client.new\ncategory_browses = client.category_browse(path: \"Top/Arts\")\n```\n\nIf you looking for the API request URI:\n\n```ruby\nAwis::API::CategoryBrowse.new.load_request_uri(path: \"Top/Games/Card_Games\")\n```\n\nReturns object that contains methods:\n\n* categories [:path, :title, :sub_category_count, :total_listing_count]\n* language_categories [:path, :title, :sub_category_count, :total_listing_count]\n* related_categories [:path, :title, :sub_category_count, :total_listing_count]\n* letter_bars [:path, :title, :sub_category_count, :total_listing_count]\n\nReturns object that contains relationships:\n\n* listings [:data_url, :title, :popularity_rank, :description]\n\n##### How to run test\n\n* bundle exec rake test\n\n##### Request ID and Status Code\n\nYou can retrieve status code and requestID\n\n* request_id\n* status_code\n\n### Parsers\n\nAwis is using `nokogiri` to parse XML documents.\n\n### Contributors\n\n* [Encore Shao](https://github.com/encoreshao)\n\n### Copyright\n\nCopyright (c) Encore Shao. See LICENSE for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fencoreshao%2Famazon-awis","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fencoreshao%2Famazon-awis","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fencoreshao%2Famazon-awis/lists"}