README.md

PolarPod

A set of useful apis

this API uses:

• open-graph-crapper

• word filter [only english support up to now]

• atob and btoa base64

• express

• js-video-url-parser

• qrcode-svg

Inside but not in use:

• metafetch [unused, secondary]
• nano-memoize [unused]
• mysql

General usage

Og tag getter

https://polarpod.herokuapp.com/apis/ogtags?u=[URL]

parameters:

• u: url
  

response:

• json

see samples file or below

SVG QR Code generator

https://polarpod.herokuapp.com/apis/qr?u=[URL]&d=[true]/[false]&w=[width]&c=[color]&bg=[background]

parameters:

• u: data
  
• d: dark/light [true/false] (if true generates a lighet qr)
  
• w: width
  
• c: HEX color (without the #) default colors: for dark themes=#CCCCCC and light=#222222
  
• bg: background color in HEX (without the #) default is transparent if any param was send, a message will be showed

response:

• SVG document

Video URL parser

http://polarpod.herokuapp.com/apis/vidurl?u=[URL]

params:

• u: video url

response:

• json

Bad-word message filter

https://polarpod.herokuapp.com/apis/filter?msg=[message_to_filter]

params:

• msg: message

response:

• json

responses

og tags response sample:

  {
    "name": "GitHub",
    "title": "Build software better, together",
    "desc": "description...",
    "type": "",
    "url": "https://github.com",
    "img": "https://github.githubassets.com/images/modules/open_graph/github-logo.png"
  }

video url parser:

  {
    "id": "jYCGSuNDy4M",
    "mediaType": "video",
    "provider": "youtube"
  }

bad-word filter:

  {
    "msg":"****"
  }

Modules credits

qrcode-svg by papnkukn

bad-words by web-mech

jsVideoUrlParser by Zod-

openGraphScraper by jshemas

metafetch by brahma-dev

LICENSE

• MIT