From 2eba183f8bb87dd0d502b0e0519be2be52f359b9 Mon Sep 17 00:00:00 2001 From: Muhammad Daffa Date: Thu, 18 Aug 2022 14:40:21 +0700 Subject: [PATCH] Added 13 templates --- aviationstack/README.md | 63 ++++++++++++++++++++++++++++++++++++++ cloudmersive/README.md | 2 +- ipapi/README.md | 60 ++++++++++++++++++++++++++++++++++++ ipstack/README.md | 53 ++++++++++++++++++++++++++++++++ iqair/README.md | 2 +- languagelayer/README.md | 54 +++++++++++++++++++++++++++++++++ mediastack/README.md | 57 ++++++++++++++++++++++++++++++++++ positionstack/README.md | 64 +++++++++++++++++++++++++++++++++++++++ reviewapi/README.md | 46 ++++++++++++++++++++++++++++ screenshotlayer/README.md | 43 ++++++++++++++++++++++++++ sportdataapi/README.md | 58 +++++++++++++++++++++++++++++++++++ userstack/README.md | 54 +++++++++++++++++++++++++++++++++ weatherstack/README.md | 61 +++++++++++++++++++++++++++++++++++++ zenserp/README.md | 41 +++++++++++++++++++++++++ zipcodebase/README.md | 59 ++++++++++++++++++++++++++++++++++++ 15 files changed, 715 insertions(+), 2 deletions(-) create mode 100644 aviationstack/README.md create mode 100644 ipapi/README.md create mode 100644 ipstack/README.md create mode 100644 languagelayer/README.md create mode 100644 mediastack/README.md create mode 100644 positionstack/README.md create mode 100644 reviewapi/README.md create mode 100644 screenshotlayer/README.md create mode 100644 sportdataapi/README.md create mode 100644 userstack/README.md create mode 100644 weatherstack/README.md create mode 100644 zenserp/README.md create mode 100644 zipcodebase/README.md diff --git a/aviationstack/README.md b/aviationstack/README.md new file mode 100644 index 0000000..2aa0985 --- /dev/null +++ b/aviationstack/README.md @@ -0,0 +1,63 @@ +# [aviationstack](https://aviationstack.com/documentation) + +## __Description__ +Real-time Flight Status & Global Aviation Data API + +## __Example Request__ +* Curl +``` +curl "https://api.aviationstack.com/v1/flights?access_key={{token}}" +``` + +* Raw +``` +GET /v1/flights?access_key={{token}} HTTP/1.1 +Host: api.aviationstack.com +... +``` + +## __Response__ +* Success +``` +{ + "pagination": { + "limit": 100, + "offset": 0, + "count": 100, + "total": 1669022 + }, + "data": [ + { + "flight_date": "2019-12-12", + "flight_status": "active", + "departure": { + "airport": "San Francisco International", + "timezone": "America/Los_Angeles", + "iata": "SFO", + "icao": "KSFO", + "terminal": "2", + "gate": "D11", + ... + } + } + ] +} +``` +* Error +``` +{ + "error": { + "code": "invalid_access_key", + "message": "You have not supplied a valid API Access Key." + } +} +``` +## __Regex__ +``` +[a-z0-9]{32} +``` + +## __Example API key__ +``` +tue3sv9hzsey1me4l7fwq3t46u5k8wag +``` diff --git a/cloudmersive/README.md b/cloudmersive/README.md index a50f44d..7193451 100644 --- a/cloudmersive/README.md +++ b/cloudmersive/README.md @@ -34,7 +34,7 @@ Content-Length: 31 ``` ## __Regex__ ``` -[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12} +[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} ``` ## __Example API key__ diff --git a/ipapi/README.md b/ipapi/README.md new file mode 100644 index 0000000..3154230 --- /dev/null +++ b/ipapi/README.md @@ -0,0 +1,60 @@ +# [ipapi](https://ipapi.com/documentation) + +## __Description__ +Real-time Geolocation & Reverse IP Lookup REST API + +## __Example Request__ +* Curl +``` +curl "http://api.ipapi.com/api/161.185.160.93?access_key={{token}}" +``` + +* Raw +``` +GET /api/161.185.160.93?access_key={{token}} HTTP/1.1 +Host: api.ipapi.com +... +``` + +## __Response__ +* Success +``` +{ + "ip": "161.185.160.93", + "hostname": "161.185.160.93", + "type": "ipv4", + "continent_code": "NA", + "continent_name": "North America", + "country_code": "US", + "country_name": "United States", + "region_code": "NY", + "region_name": "New York", + "city": "Brooklyn", + "zip": "11238", + "latitude": 40.676, + "longitude": -73.9629, + "location": { + ... + } +} +``` +* Error +``` +{ + "success":false, + "error":{ + "code":101, + "type":"invalid_access_key", + "info":"You have not supplied a valid API Access Key. [Technical Support: support@apilayer.com]" + } +} +``` +## __Regex__ +``` +[a-z0-9]{32} +``` + +## __Example API key__ +``` +tue3sv9hzsey1me4l7fwq3t46u5k8wag +``` diff --git a/ipstack/README.md b/ipstack/README.md new file mode 100644 index 0000000..946efac --- /dev/null +++ b/ipstack/README.md @@ -0,0 +1,53 @@ +# [ipstack](https://ipstack.com/documentation) + +## __Description__ +Locate and identify website visitors by IP address + +## __Example Request__ +* Curl +``` +curl "https://api.ipstack.com/134.201.250.155?access_key={{token}}" +``` + +* Raw +``` +GET /134.201.250.155?access_key={{token}} HTTP/1.1 +Host: api.ipstack.com +... +``` + +## __Response__ +* Success +``` +{ + "ip": "134.201.250.155", + "hostname": "134.201.250.155", + "type": "ipv4", + "continent_code": "NA", + "continent_name": "North America", + "country_code": "US", + "country_name": "United States", + "region_code": "CA", + ... +} +``` +* Error +``` +{ + "success": false, + "error": { + "code": 101, + "type": "invalid_access_key", + "info": "You have not supplied a valid API Access Key. [Technical Support: support@apilayer.com]" + } +} +``` +## __Regex__ +``` +[a-z0-9]{32} +``` + +## __Example API key__ +``` +tue3sv9hzsey1me4l7fwq3t46u5k8wag +``` diff --git a/iqair/README.md b/iqair/README.md index f9ef0fc..6b0f3ea 100644 --- a/iqair/README.md +++ b/iqair/README.md @@ -41,7 +41,7 @@ Host: api.airvisual.com ``` ## __Regex__ ``` -[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12} +[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} ``` ## __Example API key__ diff --git a/languagelayer/README.md b/languagelayer/README.md new file mode 100644 index 0000000..3c58528 --- /dev/null +++ b/languagelayer/README.md @@ -0,0 +1,54 @@ +# [languagelayer](https://languagelayer.com/documentation) + +## __Description__ +Language Detection JSON API supporting 173 languages + +## __Example Request__ +* Curl +``` +curl "https://api.languagelayer.com/detect?access_key={{token}}&query=The%20pessimist%20complains%20about%20the%20wind%3B%20the%20optimist%20expects%20it%20to%20change%3B%20the%20realist%20adjusts%20the%20sails" +``` + +* Raw +``` +GET /detect?access_key={{token}}&query=The%20pessimist%20complains%20about%20the%20wind%3B%20the%20optimist%20expects%20it%20to%20change%3B%20the%20realist%20adjusts%20the%20sails HTTP/1.1 +Host: api.languagelayer.com +... +``` + +## __Response__ +* Success +``` +{ + "success": true, + "results": [ + { + "language_code": "en", + "language_name": "English", + "probability": 83.896703655741, + "percentage": 100, + "reliable_result": true + } + ] +} +``` +* Error +``` +{ + "success": false, + "error": { + "code": 101, + "type": "invalid_access_key", + "info": "You have not supplied a valid API Access Key. [Technical Support: support@apilayer.com]" + } +} +``` +## __Regex__ +``` +[a-z0-9]{32} +``` + +## __Example API key__ +``` +tue3sv9hzsey1me4l7fwq3t46u5k8wag +``` diff --git a/mediastack/README.md b/mediastack/README.md new file mode 100644 index 0000000..f0f6a1e --- /dev/null +++ b/mediastack/README.md @@ -0,0 +1,57 @@ +# [mediastack](https://mediastack.com/documentation) + +## __Description__ +Free, Simple REST API for Live News & Blog Articles + +## __Example Request__ +* Curl +``` +curl "https://api.mediastack.com/v1/news?access_key={{token}}&keywords=tennis&countries=us,gb,de" +``` + +* Raw +``` +GET /v1/news?access_key={{token}}&keywords=tennis&countries=us,gb,de HTTP/1.1 +Host: api.mediastack.com +... +``` + +## __Response__ +* Success +``` +{ + "pagination": { + "limit": 100, + "offset": 0, + "count": 100, + "total": 293 + }, + "data": [ + { + "author": "TMZ Staff", + "title": "Rafael Nadal Pulls Out Of U.S. Open Over COVID-19 Concerns", + "description": "Rafael Nadal is officially OUT of the U.S. Open ... the tennis legend said Tuesday it's just too damn unsafe for him to travel to America during the COVID-19 pandemic. \"The situation is very complicated worldwide,\" Nadal wrote in a statement. \"The…", + "url": "https://www.tmz.com/2020/08/04/rafael-nadal-us-open-tennis-covid-19-concerns/", + ... + } + ] +} +``` +* Error +``` +{ + "error": { + "code": "invalid_access_key", + "message": "You have not supplied a valid API Access Key." + } +} +``` +## __Regex__ +``` +[a-z0-9]{32} +``` + +## __Example API key__ +``` +tue3sv9hzsey1me4l7fwq3t46u5k8wag +``` diff --git a/positionstack/README.md b/positionstack/README.md new file mode 100644 index 0000000..d6301fc --- /dev/null +++ b/positionstack/README.md @@ -0,0 +1,64 @@ +# [positionstack](https://positionstack.com/documentation) + +## __Description__ +Accurate Forward & Reverse Batch Geocoding REST API + +## __Example Request__ +* Curl +``` +curl "http://api.positionstack.com/v1/forward?access_key={{token}}&query=1600%20Pennsylvania%20Ave%20NW,%20Washington%20DC" +``` + +* Raw +``` +GET /v1/forward?access_key={{token}}&query=1600%20Pennsylvania%20Ave%20NW,%20Washington%20DC HTTP/1.1 +Host: api.positionstack.com +... +``` + +## __Response__ +* Success +``` +{ + "data": { + "results": [ + { + "latitude": 38.897675, + "longitude": -77.036547, + "label": "1600 Pennsylvania Avenue NW, Washington, DC, USA", + "name": "1600 Pennsylvania Avenue NW", + "type": "address", + "number": "1600", + "street": "Pennsylvania Avenue NW", + "postal_code": "20500", + "confidence": 1, + "region": "District of Columbia", + "region_code": "DC", + "administrative_area": null, + "neighbourhood": "White House Grounds", + "country": "United States", + "country_code": "US", + "map_url": "http://map.positionstack.com/38.897675,-77.036547" + } + ] + } +} +``` +* Error +``` +{ + "error": { + "code": "invalid_access_key", + "message": "You have not supplied a valid API Access Key." + } +} +``` +## __Regex__ +``` +[a-z0-9]{32} +``` + +## __Example API key__ +``` +tue3sv9hzsey1me4l7fwq3t46u5k8wag +``` diff --git a/reviewapi/README.md b/reviewapi/README.md new file mode 100644 index 0000000..55dfe1d --- /dev/null +++ b/reviewapi/README.md @@ -0,0 +1,46 @@ +# [ReviewApi](https://app.reviewapi.io/documentation) + +## __Description__ +Review API to scrape structured and normalized JSON review data from 10+ review platforms to build your apps or custom reports. + +## __Example Request__ +* Curl +``` +curl "https://app.reviewapi.io/api/v1/reviews?apikey={{token}}&url=https%3A%2F%2Fwww.capterra.com%2Fp%2F140650%2FRecruitee%2Freviews&amount=25" +``` + +* Raw +``` +GET /api/v1/reviews?apikey={{token}}&url=https%3A%2F%2Fwww.capterra.com%2Fp%2F140650%2FRecruitee%2Freviews&amount=25 HTTP/1.1 +Host: app.reviewapi.io +... +``` + +## __Response__ +* Success +``` +{ + "id": "kzPdyP7bQr", + "state": "queued", + "url": "https://reviewapi.lan/api/v1/batches/kzPdyP7bQr", + "jobs": [ + "kQBeXDWeyK" + ] + } +``` +* Error +``` +{ + "error":"Not enough requests." +} +``` + +## __Regex__ +``` +[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} +``` + +## __Example API key__ +``` +da3ec69e-bdc3-8f07-b5e3-6521c026d4be +``` \ No newline at end of file diff --git a/screenshotlayer/README.md b/screenshotlayer/README.md new file mode 100644 index 0000000..16fdf25 --- /dev/null +++ b/screenshotlayer/README.md @@ -0,0 +1,43 @@ +# [screenshotlayer](https://screenshotlayer.com/documentation) + +## __Description__ +URL 2 Image + +## __Example Request__ +* Curl +``` +curl "http://api.screenshotlayer.com/api/capture?access_key={{token}}&url=http%3A%2F%2Fgoogle.com" +``` + +* Raw +``` +GET /api/capture?access_key={{token}}&url=http%3A%2F%2Fgoogle.com HTTP/1.1 +Host: api.screenshotlayer.com +... +``` + +## __Response__ +* Success +``` +Google image will appear +``` +* Error +``` +{ + "success":false, + "error":{ + "code":101, + "type":"invalid_access_key", + "info":"You have not supplied a valid API Access Key. [Technical Support: support@apilayer.com]" + } +} +``` +## __Regex__ +``` +[a-z0-9]{32} +``` + +## __Example API key__ +``` +tue3sv9hzsey1me4l7fwq3t46u5k8wag +``` diff --git a/sportdataapi/README.md b/sportdataapi/README.md new file mode 100644 index 0000000..2f3b584 --- /dev/null +++ b/sportdataapi/README.md @@ -0,0 +1,58 @@ +# [SportdataAPI](https://app.sportdataapi.com/documentation) + +## __Description__ +Get sports data from all over the world with our sports data API + +## __Example Request__ +* Curl +``` +curl "https://app.sportdataapi.com/api/v1/soccer/countries?apikey={{token}}&continent=Europe" +``` + +* Raw +``` +GET /api/v1/soccer/countries?apikey={{token}}&continent=Europe HTTP/1.1 +Host: app.sportdataapi.com +... +``` + +## __Response__ +* Success +``` +{ + "query":{ + "continent":"Europe" + }, + "results":[ + { + "id":135, + "name":"Europe", + "country_code":null, + "continent":"Europe" + }, + { + "id":8, + "name":"Albania", + "country_code":"al", + "continent":"Europe" + }, + ... + ] +} +``` +* Error +``` +{ + "error":"Not enough requests." +} +``` + +## __Regex__ +``` +[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} +``` + +## __Example API key__ +``` +da3ec69e-bdc3-8f07-b5e3-6521c026d4be +``` \ No newline at end of file diff --git a/userstack/README.md b/userstack/README.md new file mode 100644 index 0000000..2fcff1b --- /dev/null +++ b/userstack/README.md @@ -0,0 +1,54 @@ +# [userstack](https://userstack.com/documentation) + +## __Description__ +Secure User-Agent String Lookup JSON API + +## __Example Request__ +* Curl +``` +curl "https://api.userstack.com/api/detect?access_key={{token}}" +``` + +* Raw +``` +GET /api/detect?access_key={{token}} HTTP/1.1 +Host: api.userstack.com +... +``` + +## __Response__ +* Success +``` +{ + "ua": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36", + "type": "browser", + "brand": "Apple", + "name": "Mac", + "url": "https://www.google.com/about/company/", + "os": { + "name": "macOS 10.14 Mojave", + "code": "macos_10_14", + ... + } +} +``` +* Error +``` +{ + "success": false, + "error": { + "code": 101, + "type": "invalid_access_key", + "info": "You have not supplied a valid API Access Key. [Technical Support: support@apilayer.com]" + } +} +``` +## __Regex__ +``` +[a-z0-9]{32} +``` + +## __Example API key__ +``` +tue3sv9hzsey1me4l7fwq3t46u5k8wag +``` diff --git a/weatherstack/README.md b/weatherstack/README.md new file mode 100644 index 0000000..9dbb663 --- /dev/null +++ b/weatherstack/README.md @@ -0,0 +1,61 @@ +# [weatherstack](https://weatherstack.com/documentation) + +## __Description__ +Real-Time & Historical World Weather Data API + +## __Example Request__ +* Curl +``` +curl "https://api.weatherstack.com/current?access_key={{token}}&query=New%20York" +``` + +* Raw +``` +GET /current?access_key={{token}}&query=New%20York HTTP/1.1 +Host: api.weatherstack.com +... +``` + +## __Response__ +* Success +``` +{ + "request": { + "type": "City", + "query": "New York, United States of America", + "language": "en", + "unit": "m" + }, + "location": { + "name": "New York", + "country": "United States of America", + "region": "New York", + "lat": "40.714", + "lon": "-74.006", + "timezone_id": "America/New_York", + "localtime": "2019-09-07 08:14", + "localtime_epoch": 1567844040, + "utc_offset": "-4.0" + }, +} +``` +* Error +``` +{ + "success": false, + "error": { + "code": 101, + "type": "invalid_access_key", + "info": "You have not supplied a valid API Access Key. [Technical Support: support@apilayer.com]" + } +} +``` +## __Regex__ +``` +[a-z0-9]{32} +``` + +## __Example API key__ +``` +tue3sv9hzsey1me4l7fwq3t46u5k8wag +``` diff --git a/zenserp/README.md b/zenserp/README.md new file mode 100644 index 0000000..22de182 --- /dev/null +++ b/zenserp/README.md @@ -0,0 +1,41 @@ +# [Zenserp](https://app.zenserp.com/documentation) + +## __Description__ +Scrape search engine result pages in realtime + +## __Example Request__ +* Curl +``` +curl "https://app.zenserp.com/api/v2/status?apikey={{token}}" +``` + +* Raw +``` +GET /api/v2/status?apikey={{token}} HTTP/1.1 +Host: app.zenserp.com +... +``` + +## __Response__ +* Success +``` +{ + "remaining_requests": 1500 +} +``` +* Error +``` +{ + "error":"Not enough requests." +} +``` + +## __Regex__ +``` +[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} +``` + +## __Example API key__ +``` +da3ec69e-bdc3-8f07-b5e3-6521c026d4be +``` \ No newline at end of file diff --git a/zipcodebase/README.md b/zipcodebase/README.md new file mode 100644 index 0000000..cf06a32 --- /dev/null +++ b/zipcodebase/README.md @@ -0,0 +1,59 @@ +# [Zipcodebase](https://app.zipcodebase.com/documentation) + +## __Description__ +Lookup postal codes, calculate distances and much more with our free zip code api. + +## __Example Request__ +* Curl +``` +curl "https://app.zipcodebase.com/api/v1/search?apikey={{token}}&codes=10005%2C51503" +``` + +* Raw +``` +GET /api/v1/search?apikey={{token}}&codes=10005%2C51503 HTTP/1.1 +Host: app.zipcodebase.com +... +``` + +## __Response__ +* Success +``` +{ + "query":{ + "codes":[ + "10005", + "51503" + ], + "country":null + }, + "results":{ + "10005":[ + { + "postal_code":"10005", + "country_code":"DZ", + "latitude":"36.26960000", + "longitude":"3.66360000", + "city":"Ouled Zidane", + "state":"Bouira", + "state_code":"10", + "province":null, + ... +} +``` +* Error +``` +{ + "error":"Not enough requests." +} +``` + +## __Regex__ +``` +[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} +``` + +## __Example API key__ +``` +da3ec69e-bdc3-8f07-b5e3-6521c026d4be +``` \ No newline at end of file