Made by NotHouse while bored for PenguinMod (penguinmod.site) PenguinMod Public API Documentation Introduction The PenguinMod API is a collection of utility endpoints for various data operations, including data validation, unit conversion, encryption, decryption, and hashing. This documentation provides information on how to use each endpoint, along with examples and explanations. Base URL The base URL for all API endpoints is HTTPS://PUBLIC-API.PENGUINMOD.SITE/PARAMETER1/PARAMETER2/PARAMETER3?APIKEY=YOURKEY Ratelimits There is a ratelimit of 1 request / second / IP address. Authentication To use the API, you need to include your API key as a query parameter in your requests. Without a valid API key, you will receive a 403 Forbidden response. You can obtain an API key by joining the PenguinMod Discord server (go to https://penguinmod.site to find the discord link) Make sure to include your API key as a query parameter in your requests by appending ?APIKEY=YOURKEY to the URL. Endpoints 1. Root Endpoint Endpoint: / Method: GET Description: Get a welcome message from PenguinMod API. Example: CURL HTTPS://PUBLIC-API.PENGUINMOD.SITE/?APIKEY=YOURKEY Response: "PENGUINMOD API MADE BY NOTHOUSE. NOTE FROM NOTHOUSE: IM BORED LOL" 2. Ping Endpoint Endpoint: /PING Method: GET Description: Test if the server is responsive. Made by NotHouse while bored for PenguinMod (penguinmod.site) Example: CURL HTTPS://PUBLIC-API.PENGUINMOD.SITE/PING/?APIKEY=YOURKEY Response: "PONG" 3. Email Validation Endpoint Endpoint: /VALIDATE/EMAIL Method: GET Description: Validate an email address. Parameters: - email (string, required): The email address to validate. Example: CURL -X GET HTTPS://PUBLIC- API.PENGUINMOD.SITE/VALIDATE/EMAIL/EMAIL/?APIKEY=YOURKEY Response (Valid Email): { "VALID": TRUE } Response (Invalid Email): { "VALID": FALSE, "ERROR": "INVALID EMAIL ADDRESS" } 4. URL Validation Endpoint Endpoint: /VALIDATE/URL Method: GET Description: Validate a URL. Parameters: - url (string, required): The URL to validate. Example: CURL -X GET HTTPS://PUBLIC-API.PENGUINMOD.SITE/VALIDATE/URL/URL?APIKEY=YOURKEY Response (Valid URL): { Made by NotHouse while bored for PenguinMod (penguinmod.site) "VALID": TRUE } Response (Invalid URL): { "VALID": FALSE, "ERROR": "INVALID URL" } 5. Phone Number Validation Endpoint Endpoint: /VALIDATE/PHONE Method: GET Description: Validate a phone number. Parameters: - phone (string, required): The phone number to validate. Example: CURL -X GET HTTPS://PUBLIC-API.PENGUINMOD.SITE/VALIDATE/PHONE/PHONE?APIKEY=YOURKEY Response (Valid Phone Number): { "VALID": TRUE } Response (Invalid Phone Number): { "VALID": FALSE, "ERROR": "INVALID PHONE NUMBER" } 6. JSON Validation Endpoint Endpoint: /VALIDATE/JSON Method: GET Description: Check if a string is valid JSON. Parameters: Made by NotHouse while bored for PenguinMod (penguinmod.site) - jsonString (string, required): The JSON string to validate. Example: CURL -X GET HTTPS://PUBLIC-API.PENGUINMOD.SITE/VALIDATE/JSON/JSONSTRING?APIKEY=YOURKEY Response (Valid JSON): { "VALID": TRUE } Response (Invalid JSON): { "VALID": FALSE, "ERROR": "INVALID JSON" } 7. Unit Conversion Endpoint Endpoint: /CONVERT Method: GET Description: Convert units of measurement (e.g., length, weight, volume). Parameters: - value (number, required): The value to convert. - fromUnit (string, required): The source unit. - toUnit (string, required): The target unit. Example: CURL -X GET HTTPS://PUBLIC- API.PENGUINMOD.SITE/CONVERT/VALUE/FROMUNIT/TOUNIT?APIKEY=YOURKEY Response: { "RESULT": 328.08398950131234 } 8. Data Encryption Endpoint Endpoint: /ENCRYPT Method: GET Made by NotHouse while bored for PenguinMod (penguinmod.site) Description: Encrypt data using AES encryption. Parameters: - data (string, required): The data to encrypt. - key (string, required): The encryption key. Example: CURL -X GET HTTPS://PUBLIC-API.PENGUINMOD.SITE/ENCRYPT/KEY/DATA?APIKEY=YOURKEY Response: { "ENCRYPTED": "E8A485CAF4BF8C61CA8D7A13EDC3B841" } 9. Data Decryption Endpoint Endpoint: /DECRYPT Method: GET Description: Decrypt data using AES decryption. Parameters: - key (string, required): The decryption key. - encrypted (string, required): The encrypted data. Example: CURL -X GET HTTPS://PUBLIC-API.PENGUINMOD.SITE/DECRYPT/KEY/DATA?APIKEY=YOURKEY Response: { "ENCRYPTED":"9BDAC3EFA860185380434BB4A28420B5" } 10.Hash Generation Endpoint Endpoint: /HASH Method: GET Description: Generate a cryptographic hash (e.g., MD5, SHA-256) for data. Parameters: - data (string, required): The data to hash. Made by NotHouse while bored for PenguinMod (penguinmod.site) - algorithm (string, required): The hashing algorithm ('sha512', 'md4', 'md5', 'sha1', 'sha384', 'sha512_224', 'sha512_256', 'ripemd160'). Example: CURL -X GET HTTPS://PUBLIC-API.PENGUINMOD.SITE/HASH/DATA/ALGORITHM?APIKEY=YOURKEY Response: { "HASHVALUE": "3858F62230AC3C915F300C664312C63F" } 11.Random Hash Generation Endpoint Endpoint: /RANDOM/HASH Method: GET Description: Generate a random cryptographic hash. Example: CURL HTTPS://PUBLIC-API.PENGUINMOD.SITE/RANDOM/HASH?APIKEY=YOURKEY Response: { "RANDOMHASH": "24AF9A82BB12E2D593A2FF1A41D610FF" } 12.Calculate Endpoint: /CALCULATE Method: GET Description: Calculate the given operation Parameters: - operation (number, required): The arithmetic operation (add, subtract, multiply, or divide. You can also get the Fibonacci number by specifying the amount of Fibonacci numbers in the num1 parameter). - num1 (number, required): The first number. - num2 (number, required except in fibonacci): The second number. Example: GET HTTPS://PUBLIC-API.PENGUINMOD.SITE/CALCULATE/OPERATION/NUM1/NUM2?APIKEY=YOURKEY Response: Made by NotHouse while bored for PenguinMod (penguinmod.site) 8 13.Text Operations Endpoint: /TEXT Method: GET Description: Perform various text transformations, such as converting text to uppercase, lowercase, reversing, and more. Parameters: - operation (string, required): The action to use while transforming the text. - string (String, required): The text to transform - substring (string, only required in COUNTOCCURRENCES) Operations: - UPPERCASE - Convert string into uppercase - LOWERCASE - Convert string into lowercase - REVERSE - Reverses string characters order - CAPITALIZE - Make string have all first letters uppercase only - REMOVESPACES - Removes spaces from string - LEETSPEAK - Convert string into leet speak - TRUNCATE - Truncate string in the amount of characters defined in substring - ROTATECHARACTERS - Rotate string characters (lowercase to uppercase and viceversa) - EMOJITEXT - Convert string into semi text sentence (just a few words translate to emojis, for example, Hello World) - COUNTOCCURRENCES - Counts the occurrences of substring in string - ISPALINDROME - Checks if string is a palindrome (radar, asdsa, 123454321) - GENERATEFIBONACCI - Get the amount of characters defined in stringof the Fibonacci number Example: GET HTTPS://PUBLIC-API.PENGUINMOD.SITE/TEXT/OPERATION/STRING/SUBSTRING?APIKEY=YOURKEY Response: { "RESULT": "HELLO" } 14.Count Text Endpoint: /COUNT Method: GET Made by NotHouse while bored for PenguinMod (penguinmod.site) Description: Count characters, words, or sentences in text. Parameters: - type (string, required): The count type (CHARACTERS, WORDS, or SENTENCES). - text (string, required): The text to count Example: GET HTTPS://PUBLIC-API.PENGUINMOD.SITE/COUNT/TYPE/TEXT&APIKEY=YOURKEY Response: { "COUNT": 5 } 15. Random Data Generation 15.1. Random Number Endpoint: /RANDOM/NUMBER Method: GET Description: Generate a random number from the given limits. Parameters: - min (number, optional): Minimum value (default: 0). - max (number, optional): Maximum value (default: 100). Example: GET HTTPS://PUBLIC-API.PENGUINMOD.SITE/RANDOM/NUMBER/MIN/MAX?APIKEY=YOURKEY Response: { "RESULT": 42 } 15.2. Random String Endpoint: /RANDOM/STRING Method: GET Description: Generates a random alphanumeric lowercase-uppercase string of the given length Parameters: Made by NotHouse while bored for PenguinMod (penguinmod.site) - length (integer, optional): Length of the random string (default: 10). Example: GET HTTPS://PUBLIC-API.PENGUINMOD.SITE/RANDOM/STRING/LENGTH?APIKEY=YOURKEY Response: { "RESULT": "H7EJZL9X" } 15.3. Random Date Endpoint: /RANDOM/DATE Method: GET Parameters: - startYear (optional): Start year (default: 2000). - endYear (optional): End year (default: 2023). Example: GET HTTPS://PUBLIC-API.PENGUINMOD.SITE/RANDOM/DATE/STARTYEAR/ENDYEAR?APIKEY=YOURKEY Response: { "RESULT": "2022-02-14T13:45:01.341Z" } 15.4. Random Boolean Endpoint: /RANDOM/BOOLEAN Method: GET Description: Get random Boolean (true / false) with 50% chance each Example: GET HTTPS://PUBLIC-API.PENGUINMOD.SITE/RANDOM/BOOLEAN?APIKEY=YOURKEY Response: { "RESULT": TRUE } 15.5. Lorem Ipsum Made by NotHouse while bored for PenguinMod (penguinmod.site) Endpoint: /RANDOM/LOREM Method: GET Description: Generate Lorem Ipsum text for placeholder content with custom amount of words Parameters: - wordCount (integer, optional): Amount of words (default: 50). Example: GET HTTPS://PUBLIC-API.PENGUINMOD.SITE/RANDOM/LOREM/WORDCOUNT?APIKEY=YOURKEY Response: LOREM IPSUM DOLOR SIT AMET, CONSECTETUR ADIPISCING ELIT... 16.Text Validation 16.1. Validate Email Endpoint: /VALIDATE/EMAIL Method: GET Parameters: - email (string, required): The email address to validate. Example: GET HTTPS://PUBLIC-API.PENGUINMOD.SITE/VALIDATE/EMAIL/EMAIL?APIKEY=YOURKEY Response: { "VALID": TRUE } 16.2. Validate URL Endpoint: /VALIDATE/URL Method: GET Parameters: - url (string, required): The URL to validate. Example: GET HTTPS://PUBLIC-API.PENGUINMOD.SITE/VALIDATE/URL/URL?APIKEY=YOURKEY Response: Made by NotHouse while bored for PenguinMod (penguinmod.site) { "VALID": TRUE } 16.3. Validate Phone Endpoint: /VALIDATE/PHONE Method: GET Parameters: - phoneNumber (number, required: The phone number to validate. Example: GET HTTPS://PUBLIC-API.PENGUINMOD.SITE/VALIDATE/PHONE/PHONENUMBER?APIKEY=YOURKEY Response: { "VALID": TRUE } 16.4. Validate JSON Endpoint: /VALIDATE/JSON Method: GET Parameters: - jsonString (string, required): The JSON string to validate. Example: GET HTTPS://PUBLIC-API.PENGUINMOD.SITE/VALIDATE/JSON/JSONSTRING?APIKEY=YOURKEY Response: { "VALID": TRUE } 17.Unit Conversion Endpoint: /CONVERT Method: GET Description: Convert units of measurement between different units and systems. Made by NotHouse while bored for PenguinMod (penguinmod.site) Parameters: - value (number, required): The value to convert. - fromUnit (string, required): The unit to convert from. - toUnit (string, required): The unit to convert to. Units: Length: mm, cm, m, in, ft-us, ft, mi Area: mm2, cm2, m2, ha, km2, in2, ft2, ac, mi2 Mass: mcg, mg, g, kg, oz, lb, mt, t Volume: mm3, cm3, ml, l, kl, m3, km3, tsp, Tbs, in3, fl-oz, cup, pnt, qt, gal, ft3, yd3 Volume Flow Rate: mm3/s, cm3/s, ml/s, cl/s, dl/s, l/s, l/min, l/h, kl/s, kl/min, kl/h, m3/s, m3/min, m3/h, km3/s, tsp/s, Tbs/s, in3/s, in3/min, in3/h, fl-oz/s, fl-oz/min, fl-oz/h, cup/s, pnt/s, pnt/min, pnt/h, qt/s, gal/s, gal/min, gal/h, ft3/s, ft3/min, ft3/h, yd3/s, yd3/min, yd3/h Temperature: C, F, K, R Time: ns, mu, ms, s, min, h, d, week, month, year Frequency: Hz, mHz, kHz, MHz, GHz, THz, rpm, deg/s, rad/s Speed: m/s, km/h, m/h, knot, ft/s Pace: s/m, min/km, s/ft, min/km Pressure: Pa, hPa, kPa, MPa, bar, torr, psi, ksi Digital: b, Kb, Mb, Gb, Tb, B, KB, MB, GB, TB Illuminance: lx, ft-cd Parts-Per: ppm, ppb, ppt, ppq Voltage: V, mV, kV Current: A, mA, kA Power: W, mW, kW, MW, GW Apparent Power: VA, mVA, kVA, MVA, GVA Reactive Power: VAR, mVAR, kVAR, MVAR, GVAR Energy: Wh, mWh, kWh, MWh, GWh, J, kJ Reactive Energy: VARh, mVARh, kVARh, MVARh, GVARh Angle: deg, rad, grad, arcmin, arcsec Example: Made by NotHouse while bored for PenguinMod (penguinmod.site) GET HTTPS://PUBLIC-API.PENGUINMOD.SITE/CONVERT/VALUE/FROMUNIT/TOUNIT?APIKEY=YOURKEY Response: { "RESULT": 16.4042 }
Enter the password to open this PDF file:
-
-
-
-
-
-
-
-
-
-
-
-