{ "info": { "_postman_id": "3ccb01d8-83de-4d3f-bff9-d5cb124418e7", "name": "Toolset API", "description": "# Toolset API — Postman Collection\n\nProduction-ready Postman collection for the Toolset API, a unified utility API covering dates, documents, phones, finance, networking, and more.\n\n---\n\n## Tools\n\n📅 Dates: calculator, holidays, working days, ...\n\n🪪 Documents: operations with Brazilian CPF, Brazilian CNPJ Brazilian PIS/Pasep, USA SSN, USA EIN, ...\n\n📞 Phone numbers: validation of Brazilian, American, Canadian, British, German, French, Italian, Portuguese and Spanish formats\n\n🚗 Vehicle plates: validation for Mercosul, Brazil, USA and UK\n\n💯 Numbers: number-to-words, currency operations, ...\n\n🧮 Math: expression evaluation, area and volume calculators, Pythagorean theorem calculator\n\n🍎 Physics: distance, speed and temperature conversions\n\n💵 Finance: installments calculator, compount interest, ...\n\n💬 Strings: truncate, slug, mask, normalization, ...\n\n🌐 Networking & web: port verification, reserved ports, domain validation, URL parsing, URL validation, IPv4 and IPv6 validation, CIDR information, IP ranges, ...\n\n🖥️ Operating systems: path rules, path validation, ...\n\n✖️ Excel: formula translation\n\n💽 Base64: encoding and decoding\n\n---\n\n## Authentication\n\nUse your RapidAPI credentials in order to authenticate and use this API.\n\nRequired headers:\n\n`X-RapidAPI-Key` \n`X-RapidAPI-Host`\n\nThese can be defined in variables set in this collection.\n\n---\n\n## Standard Response Format\n\n### Success\n\nThe success responses can be verified with a `200 OK` HTTP status code response.\n\nThe response body will always be a JSON containing the requested data.\n\n### Error\n\nThe errors will be followed by a `4xx` or `5xx` HTTP status code response.\n\n``` json\n{\n \"code\": \"ERROR_CODE\",\n \"message\": \"Human-readable message\"\n}\n\n ```\n\nThe error codes can be one of the following:\n\n| **HTTP status code** | **Error code** | **Description** | **Common causes** | **Solution** |\n| --- | --- | --- | --- | --- |\n| 400 | INVALID_JSON | The request body could not be parsed as valid JSON. | The request body is not a well-formatted JSON. | Ensure the Content-Type header is application/json and the body is well-formed. |\n| 400 | INVALID_INPUT | A required parameter is missing, empty, or has a value that fails validation. The message field describes the specific field and rule that was violated. | A required field was not provided (e.g. phone, CPF, CNPJ, SSN, EIN, PIS, plate, text, URL, IP, CIDR, ...);
A numeric field is zero or negative (e.g. principal, rate, periods, months, max_length);
A date field is in the wrong format or logically invalid (e.g. end_date before start_date);
An enum field contains an unsupported value (e.g. rate_type, frequency, system);
A dependent field is missing (e.g. end_date is required when start_date is provided);
No duration was specified for installments (provide months, years, or start_date + end_date). | Make sure that all required fields are being provided;
Make sure all the provided fields contain valid values. |\n| 400 | INVALID_DATE | A date parameter was provided but does not conform to the expected YYYY-MM-DD format, or the value is not a real calendar date. | A date was provided in an invalid format. | Make sure all dates are provided in ISO format (YYYY-MM-DD) and that they do exist (e.g. not February 31st). |\n| 400 | INVALID_PORT | The port number provided is not a valid integer, or is outside the allowed range of 0–65535. | The port number provided is not a valid integer, or is outside the allowed range of 0–65535. | Make sure the port is a positive integer and between 0 and 65535. |\n| 400 | INVALID_IP | The IP parameter is not a valid IPv4 or IPv6 address. | The IP parameter is not a valid IPv4 or IPv6 address. | Make sure that the provided IP address is an actual IPv4 or IPv6 address. |\n| 400 | INVALID_CIDR | The CIDR parameter is not a valid CIDR block notation (e.g. 192.168.1.0/24). | The CIDR parameter is not a valid CIDR block notation (e.g. 192.168.1.0/24). | Make sure that the provided CIDR is valid block notation. |\n| 400 | CONVERSION_ERROR | The conversion operation failed. | For numeric inputs, the number may be out of the supported range;
The language/currency/mode combination may not be supported. | If the input is numeric, make sure it's within the supported range;
Make sure the language, currency and/or mode combination is supported by the endpoint. |\n| 400 | INVALID_LANGUAGE | The provided language is invalid or not supported. | The provided languge string is not a valid ISO format;
The provided language is not supported yet. | Verify if the string is a valid supported language for the endpoint. |\n| 400 | FORMULA_NOT_FOUND | The provided formula is not supported or is invalid. | The provided formula is not valid or is not supported yet. | Verify if the string is a valid and supported formula. |\n| 400 | EVAL_ERROR | The provided expression is not valid and an evaluation error has occurred. | Verify if the provided expression is logically valid and can be solved. | Verify if the provided expression is logically valid and can be solved. |\n| 400 | PAYLOAD_TOO_LARGE | The provided payload is larget than the maximum allowed size. | The provided payload is bigger then the maximum allowed size of 1 MB. | Make sure that the payload is smaller than 1 MB. |\n| 500 | INTERNAL_ERROR | An unexpected server-side error occurred. | ❓Not mapped yet. | Feel free to contact us for support or try again. |\n\n---\n\n## Changes and updates\n\nThis API is constantly updated. New endpoints will always be added as `v1`.\n\nSubsequent versions will be made available individually per endpoint if there are breaking changes.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "15468576", "_collection_link": "https://go.postman.co/collection/15468576-3ccb01d8-83de-4d3f-bff9-d5cb124418e7?source=collection_link" }, "item": [ { "name": "Dates", "item": [ { "name": "Date difference", "request": { "method": "GET", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "url": { "raw": "{{Hostname}}/v1/dates/diff?from=1990-12-31&to=2000-12-31&include_days_of_week=false", "host": [ "{{Hostname}}" ], "path": [ "v1", "dates", "diff" ], "query": [ { "key": "from", "value": "1990-12-31", "description": "The initial date in ISO (YYYY-MM-DD) format." }, { "key": "to", "value": "2000-12-31", "description": "The end date in ISO (YYYY-MM-DD) format." }, { "key": "include_days_of_week", "value": "false", "description": "Whether to include the count of days of week in the response." } ] }, "description": "# 📅 Date difference\n\nThis endpoint provides a calculation result between two dates, giving the number of days between those and other information about the date range.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| from | Date | Yes | | Initial date. | ISO format (`YYYY-MM-DD`). |\n| to | Date | Yes | | End date. | ISO format (`YYYY-MM-DD`). |\n| include_days_of_week | Boolean | No | false | Whether the count of days of week should be returned. | |\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the calendar days, weeks and months:\n\n##### Without days of week:\n\n``` json\n{\n \"days\": 3653,\n \"weeks\": 521,\n \"months\": 120\n}\n\n ```\n\n##### With days of week:\n\n``` json\n{\n \"days\": 3653,\n \"weeks\": 521,\n \"months\": 120,\n \"days_of_week\": {\n \"sundays\": 522,\n \"mondays\": 522,\n \"tuesdays\": 522,\n \"wednesdays\": 522,\n \"thursdays\": 522,\n \"fridays\": 522,\n \"saturdays\": 522\n }\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for a invalid date format, containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_DATE\",\n \"message\": \"Invalid date format\"\n}\n\n ```" }, "response": [] } ], "description": "# 📅 Dates\n\nThis directory contains the endpoints related to date operations, such as date differences." }, { "name": "Base64", "item": [ { "name": "Encoding", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/encoding/base64/encode?data=Toolset API", "host": [ "{{Hostname}}" ], "path": [ "v1", "encoding", "base64", "encode" ], "query": [ { "key": "data", "value": "Toolset API", "description": "The data to be encoded." } ] }, "description": "# 💽 Base64 encoding\n\nThis endpoint provides a base64 encoding for strings.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| data | String | Yes | | Value to be encoded. | |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `GET` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the encoded base64 string:\n\n``` json\n{\n \"result\": \"VG9vbHNldCBBUEk=\"\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for a invalid date format, containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"PAYLOAD_TOO_LARGE\",\n \"message\": \"Invalid date format\"\n}\n\n ```" }, "response": [] }, { "name": "Encoding", "request": { "method": "POST", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"data\": \"Toolset API\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/encoding/base64/encode", "host": [ "{{Hostname}}" ], "path": [ "v1", "encoding", "base64", "encode" ] }, "description": "# 💽 Base64 encoding\n\nThis endpoint provides a base64 encoding for strings.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| data | String | Yes | | Value to be encoded. | |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `POST` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the encoded base64 string:\n\n``` json\n{\n \"result\": \"VG9vbHNldCBBUEk=\"\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for a invalid date format, containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"PAYLOAD_TOO_LARGE\",\n \"message\": \"Invalid date format\"\n}\n\n ```" }, "response": [] }, { "name": "Decoding", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/encoding/base64/decode?data=VG9vbHNldCBBUEk=", "host": [ "{{Hostname}}" ], "path": [ "v1", "encoding", "base64", "decode" ], "query": [ { "key": "data", "value": "VG9vbHNldCBBUEk=", "description": "The data to be encoded." } ] }, "description": "# 💽 Base64 decoding\n\nThis endpoint provides a base64 string decoding.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| data | String | Yes | | Value to be decoded. | |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `GET` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the encoded base64 string:\n\n``` json\n{\n \"result\": \"Toolset API\"\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for a invalid date format, containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"PAYLOAD_TOO_LARGE\",\n \"message\": \"Invalid date format\"\n}\n\n ```\n\n#### Notes\n\nThis endpoint will **not** decode non-string resources." }, "response": [] }, { "name": "Decoding", "request": { "method": "POST", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"data\": \"VG9vbHNldCBBUEk=\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/encoding/base64/decode", "host": [ "{{Hostname}}" ], "path": [ "v1", "encoding", "base64", "decode" ] }, "description": "# 💽 Base64 decoding\n\nThis endpoint provides a base64 string decoding.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| data | String | Yes | | Value to be decoded. | |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `POST` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the encoded base64 string:\n\n``` json\n{\n \"result\": \"Toolset API\"\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for a invalid date format, containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"PAYLOAD_TOO_LARGE\",\n \"message\": \"Invalid date format\"\n}\n\n ```\n\n#### Notes\n\nThis endpoint will **not** decode non-string resources." }, "response": [] } ], "description": "# 💽 Base64\n\nThis directory contains the endpoints related to base64 operations, such as encoding and decoding." }, { "name": "Excel", "item": [ { "name": "Formula translation", "request": { "method": "GET", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "url": { "raw": "{{Hostname}}/v1/excel/formulas/translate?formula=SUM&from=en&to=pt-BR", "host": [ "{{Hostname}}" ], "path": [ "v1", "excel", "formulas", "translate" ], "query": [ { "key": "formula", "value": "SUM", "description": "The formula term." }, { "key": "from", "value": "en", "description": "Current language ISO code." }, { "key": "to", "value": "pt-BR", "description": "Language ISO code of the target language." } ] }, "description": "# ✖️ Formula translation\n\nThis endpoint provides a Excel formula translation between supported languages: English, Brazilian Portuguese, Spanish, Italian and French.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| formula | String | Yes | | The formula term to be translated. | |\n| from | String | No | en | Language ISO code. | Supported languages: `en`, `pt-BR,` `es`, `it`, `fr` and `de`. |\n| to | String | No | pt-BR | Language ISO code. | Supported languages: `en`, `pt-BR,` `es`, `it`, `fr` and `de`. |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `GET` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the translated formula term:\n\n``` json\n{\n \"formula\": \"SOMA\"\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for a unsupported language, containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_LANGUAGE\",\n \"message\": \"unsupported target language\"\n}\n\n ```" }, "response": [] }, { "name": "Formula translation", "request": { "method": "POST", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"formula\": \"SUM\",\r\n \"from\": \"en\",\r\n \"to\": \"pt-bR\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/excel/formulas/translate", "host": [ "{{Hostname}}" ], "path": [ "v1", "excel", "formulas", "translate" ] }, "description": "# ✖️ Formula translation\n\nThis endpoint provides a Excel formula translation between supported languages: English, Brazilian Portuguese, Spanish, Italian and French.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| formula | String | Yes | | The formula term to be translated. | |\n| from | String | No | en | Language ISO code. | Supported languages: `en`, `pt-BR,` `es`, `it`, `fr` and `de`. |\n| to | String | No | pt-BR | Language ISO code. | Supported languages: `en`, `pt-BR,` `es`, `it`, `fr` and `de`. |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `POST` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the translated formula term:\n\n``` json\n{\n \"formula\": \"SOMA\"\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for a unsupported language, containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_LANGUAGE\",\n \"message\": \"unsupported target language\"\n}\n\n ```" }, "response": [] } ], "description": "# ✖️ Excel\n\nThis directory contains the endpoints related to Excel operations, such as formula translation." }, { "name": "Finance", "item": [ { "name": "Installments", "request": { "method": "POST", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"principal\": 100.00,\r\n \"rate\": 10.00,\r\n \"rate_type\": \"annual\",\r\n \"system\": \"price\",\r\n \"months\": 12\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/finance/installments", "host": [ "{{Hostname}}" ], "path": [ "v1", "finance", "installments" ] }, "description": "# 💵 Installments\n\nThis endpoint provides a installments calculation given a principal and an monthly or annual rate for Price or SAC systems.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| principal | Float | Yes | | Principal monetary value. | |\n| rate | Float | Yes | | Interest rate. | |\n| system | String | No | price | Amortization system. | Can be `price` or `sac`. |\n| rate_type | String | No | annual | The rate type. | Can be `annual` or `monthly`. |\n| start_date | Date | No | | The initial date. | ISO format (`YYYY-MM-DD`). |\n| end_date | Date | No, except if `start_date` is defined. | | Tne end date. | ISO format (`YYYY-MM-DD`). |\n| months | Integer | No | | Month periods. | |\n| years | Integer | No | | Year periods. | |\n\n_Note that a time reference shall be informed. That can be the absolute dates (_`_start_date_` _and_ `_end_date_`_) or one form of relative time control (_`_months_` _or_ `_years_`_)._\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `POST` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving a summary with the total payment, total interest rate and effective monthly interest rate. Also, a schedule is provided detailing the installment number, due date (if an absolute date is provided), the payment amount, the principal, interest rate and balance:\n\n##### Without an absolute date provided:\n\n``` json\n{\n \"summary\": {\n \"total_payment\": 105.42,\n \"total_interest\": 5.42,\n \"effective_monthly_rate\": 0.008333333333333333\n },\n \"schedule\": [\n {\n \"installment\": 1,\n \"payment\": 9.17,\n \"principal\": 8.33,\n \"interest\": 0.83,\n \"balance\": 91.67\n },\n {\n \"installment\": 2,\n \"payment\": 9.1,\n \"principal\": 8.33,\n \"interest\": 0.76,\n \"balance\": 83.33\n },\n {\n \"installment\": 3,\n \"payment\": 9.03,\n \"principal\": 8.33,\n \"interest\": 0.69,\n \"balance\": 75\n },\n {\n \"installment\": 4,\n \"payment\": 8.96,\n \"principal\": 8.33,\n \"interest\": 0.63,\n \"balance\": 66.67\n },\n {\n \"installment\": 5,\n \"payment\": 8.89,\n \"principal\": 8.33,\n \"interest\": 0.56,\n \"balance\": 58.33\n },\n {\n \"installment\": 6,\n \"payment\": 8.82,\n \"principal\": 8.33,\n \"interest\": 0.49,\n \"balance\": 50\n },\n {\n \"installment\": 7,\n \"payment\": 8.75,\n \"principal\": 8.33,\n \"interest\": 0.42,\n \"balance\": 41.67\n },\n {\n \"installment\": 8,\n \"payment\": 8.68,\n \"principal\": 8.33,\n \"interest\": 0.35,\n \"balance\": 33.33\n },\n {\n \"installment\": 9,\n \"payment\": 8.61,\n \"principal\": 8.33,\n \"interest\": 0.28,\n \"balance\": 25\n },\n {\n \"installment\": 10,\n \"payment\": 8.54,\n \"principal\": 8.33,\n \"interest\": 0.21,\n \"balance\": 16.67\n },\n {\n \"installment\": 11,\n \"payment\": 8.47,\n \"principal\": 8.33,\n \"interest\": 0.14,\n \"balance\": 8.33\n },\n {\n \"installment\": 12,\n \"payment\": 8.4,\n \"principal\": 8.33,\n \"interest\": 0.07,\n \"balance\": 0\n }\n ]\n}\n\n ```\n\n##### With an absolute date provided (`start_date` and `end_date`):\n\n``` json\n{\n \"summary\": {\n \"start_date\": \"2026-01-01\",\n \"end_date\": \"2026-12-01\",\n \"total_payment\": 105.07,\n \"total_interest\": 5.07,\n \"effective_monthly_rate\": 0.008333333333333333\n },\n \"schedule\": [\n {\n \"installment\": 1,\n \"due_date\": \"2026-02-01\",\n \"payment\": 9.55,\n \"principal\": 8.72,\n \"interest\": 0.83,\n \"balance\": 91.28\n },\n {\n \"installment\": 2,\n \"due_date\": \"2026-03-01\",\n \"payment\": 9.55,\n \"principal\": 8.79,\n \"interest\": 0.76,\n \"balance\": 82.49\n },\n {\n \"installment\": 3,\n \"due_date\": \"2026-04-01\",\n \"payment\": 9.55,\n \"principal\": 8.86,\n \"interest\": 0.69,\n \"balance\": 73.63\n },\n {\n \"installment\": 4,\n \"due_date\": \"2026-05-01\",\n \"payment\": 9.55,\n \"principal\": 8.94,\n \"interest\": 0.61,\n \"balance\": 64.69\n },\n {\n \"installment\": 5,\n \"due_date\": \"2026-06-01\",\n \"payment\": 9.55,\n \"principal\": 9.01,\n \"interest\": 0.54,\n \"balance\": 55.68\n },\n {\n \"installment\": 6,\n \"due_date\": \"2026-07-01\",\n \"payment\": 9.55,\n \"principal\": 9.09,\n \"interest\": 0.46,\n \"balance\": 46.59\n },\n {\n \"installment\": 7,\n \"due_date\": \"2026-08-01\",\n \"payment\": 9.55,\n \"principal\": 9.16,\n \"interest\": 0.39,\n \"balance\": 37.42\n },\n {\n \"installment\": 8,\n \"due_date\": \"2026-09-01\",\n \"payment\": 9.55,\n \"principal\": 9.24,\n \"interest\": 0.31,\n \"balance\": 28.18\n },\n {\n \"installment\": 9,\n \"due_date\": \"2026-10-01\",\n \"payment\": 9.55,\n \"principal\": 9.32,\n \"interest\": 0.23,\n \"balance\": 18.87\n },\n {\n \"installment\": 10,\n \"due_date\": \"2026-11-01\",\n \"payment\": 9.55,\n \"principal\": 9.39,\n \"interest\": 0.16,\n \"balance\": 9.47\n },\n {\n \"installment\": 11,\n \"due_date\": \"2026-12-01\",\n \"payment\": 9.55,\n \"principal\": 9.47,\n \"interest\": 0.08,\n \"balance\": 0\n }\n ]\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for a invalid installment lenght (like 0 months), containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_INPUT\",\n \"message\": \"months must be greater than 0\"\n}\n\n ```" }, "response": [] }, { "name": "Installments", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/finance/installments?principal=100.00&rate=10.0&rate_type=annual&system=price&months=12", "host": [ "{{Hostname}}" ], "path": [ "v1", "finance", "installments" ], "query": [ { "key": "principal", "value": "100.00", "description": "The principal value. Must be a positive float." }, { "key": "rate", "value": "10.0", "description": "The interest rate. Must be a positive float." }, { "key": "rate_type", "value": "annual", "description": "The rate type. Can be either ANNUAL or MONTHLY. If not set, defaults to ANNUAL." }, { "key": "system", "value": "price", "description": "The system. Can be either PRICE or SAC. If not set, defaults to SAC." }, { "key": "months", "value": "12", "description": "The installments months. If not set, you must provide YEARS (amount of years) or both START_DATE and END_DATE, in ISO (YYYY-MM-DD) format." } ] }, "description": "# 💵 Installments\n\nThis endpoint provides a installments calculation given a principal and an monthly or annual rate for Price or SAC systems.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| principal | Float | Yes | | Principal monetary value. | |\n| rate | Float | Yes | | Interest rate. | |\n| system | String | No | price | Amortization system. | Can be `price` or `sac`. |\n| rate_type | String | No | annual | The rate type. | Can be `annual` or `monthly`. |\n| start_date | Date | No | | The initial date. | ISO format (`YYYY-MM-DD`). |\n| end_date | Date | No, except if `start_date` is defined. | | Tne end date. | ISO format (`YYYY-MM-DD`). |\n| months | Integer | No | | Month periods. | |\n| years | Integer | No | | Year periods. | |\n\n_Note that a time reference shall be informed. That can be the absolute dates (_`_start_date_` _and_ `_end_date_`_) or one form of relative time control (_`_months_` _or_ `_years_`_)._\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `GET` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving a summary with the total payment, total interest rate and effective monthly interest rate. Also, a schedule is provided detailing the installment number, due date (if an absolute date is provided), the payment amount, the principal, interest rate and balance:\n\n##### Without an absolute date provided:\n\n``` json\n{\n \"summary\": {\n \"total_payment\": 105.42,\n \"total_interest\": 5.42,\n \"effective_monthly_rate\": 0.008333333333333333\n },\n \"schedule\": [\n {\n \"installment\": 1,\n \"payment\": 9.17,\n \"principal\": 8.33,\n \"interest\": 0.83,\n \"balance\": 91.67\n },\n {\n \"installment\": 2,\n \"payment\": 9.1,\n \"principal\": 8.33,\n \"interest\": 0.76,\n \"balance\": 83.33\n },\n {\n \"installment\": 3,\n \"payment\": 9.03,\n \"principal\": 8.33,\n \"interest\": 0.69,\n \"balance\": 75\n },\n {\n \"installment\": 4,\n \"payment\": 8.96,\n \"principal\": 8.33,\n \"interest\": 0.63,\n \"balance\": 66.67\n },\n {\n \"installment\": 5,\n \"payment\": 8.89,\n \"principal\": 8.33,\n \"interest\": 0.56,\n \"balance\": 58.33\n },\n {\n \"installment\": 6,\n \"payment\": 8.82,\n \"principal\": 8.33,\n \"interest\": 0.49,\n \"balance\": 50\n },\n {\n \"installment\": 7,\n \"payment\": 8.75,\n \"principal\": 8.33,\n \"interest\": 0.42,\n \"balance\": 41.67\n },\n {\n \"installment\": 8,\n \"payment\": 8.68,\n \"principal\": 8.33,\n \"interest\": 0.35,\n \"balance\": 33.33\n },\n {\n \"installment\": 9,\n \"payment\": 8.61,\n \"principal\": 8.33,\n \"interest\": 0.28,\n \"balance\": 25\n },\n {\n \"installment\": 10,\n \"payment\": 8.54,\n \"principal\": 8.33,\n \"interest\": 0.21,\n \"balance\": 16.67\n },\n {\n \"installment\": 11,\n \"payment\": 8.47,\n \"principal\": 8.33,\n \"interest\": 0.14,\n \"balance\": 8.33\n },\n {\n \"installment\": 12,\n \"payment\": 8.4,\n \"principal\": 8.33,\n \"interest\": 0.07,\n \"balance\": 0\n }\n ]\n}\n\n ```\n\n##### With an absolute date provided (`start_date` and `end_date`):\n\n``` json\n{\n \"summary\": {\n \"start_date\": \"2026-01-01\",\n \"end_date\": \"2026-12-01\",\n \"total_payment\": 105.07,\n \"total_interest\": 5.07,\n \"effective_monthly_rate\": 0.008333333333333333\n },\n \"schedule\": [\n {\n \"installment\": 1,\n \"due_date\": \"2026-02-01\",\n \"payment\": 9.55,\n \"principal\": 8.72,\n \"interest\": 0.83,\n \"balance\": 91.28\n },\n {\n \"installment\": 2,\n \"due_date\": \"2026-03-01\",\n \"payment\": 9.55,\n \"principal\": 8.79,\n \"interest\": 0.76,\n \"balance\": 82.49\n },\n {\n \"installment\": 3,\n \"due_date\": \"2026-04-01\",\n \"payment\": 9.55,\n \"principal\": 8.86,\n \"interest\": 0.69,\n \"balance\": 73.63\n },\n {\n \"installment\": 4,\n \"due_date\": \"2026-05-01\",\n \"payment\": 9.55,\n \"principal\": 8.94,\n \"interest\": 0.61,\n \"balance\": 64.69\n },\n {\n \"installment\": 5,\n \"due_date\": \"2026-06-01\",\n \"payment\": 9.55,\n \"principal\": 9.01,\n \"interest\": 0.54,\n \"balance\": 55.68\n },\n {\n \"installment\": 6,\n \"due_date\": \"2026-07-01\",\n \"payment\": 9.55,\n \"principal\": 9.09,\n \"interest\": 0.46,\n \"balance\": 46.59\n },\n {\n \"installment\": 7,\n \"due_date\": \"2026-08-01\",\n \"payment\": 9.55,\n \"principal\": 9.16,\n \"interest\": 0.39,\n \"balance\": 37.42\n },\n {\n \"installment\": 8,\n \"due_date\": \"2026-09-01\",\n \"payment\": 9.55,\n \"principal\": 9.24,\n \"interest\": 0.31,\n \"balance\": 28.18\n },\n {\n \"installment\": 9,\n \"due_date\": \"2026-10-01\",\n \"payment\": 9.55,\n \"principal\": 9.32,\n \"interest\": 0.23,\n \"balance\": 18.87\n },\n {\n \"installment\": 10,\n \"due_date\": \"2026-11-01\",\n \"payment\": 9.55,\n \"principal\": 9.39,\n \"interest\": 0.16,\n \"balance\": 9.47\n },\n {\n \"installment\": 11,\n \"due_date\": \"2026-12-01\",\n \"payment\": 9.55,\n \"principal\": 9.47,\n \"interest\": 0.08,\n \"balance\": 0\n }\n ]\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for a invalid installment lenght (like 0 months), containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_INPUT\",\n \"message\": \"months must be greater than 0\"\n}\n\n ```" }, "response": [] }, { "name": "Compound interest", "request": { "method": "POST", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"principal\": 100.00,\r\n \"rate\": 10.00,\r\n \"periods\": 1,\r\n \"frequency\": \"annual\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/finance/compound-interest", "host": [ "{{Hostname}}" ], "path": [ "v1", "finance", "compound-interest" ] }, "description": "# 💵 Compound interest\n\nThis endpoint provides a compound interest calculator.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| principal | Float | Yes | | Principal monetary value. | |\n| rate | Float | Yes | | Interest rate. | |\n| period | Integer | Yes | | Period value. | Can be used as years, month or days. |\n| frequency | String | No | annual | The period frequency. | Can be `annual`, `monthly` or `daily`. |\n| start_date | Date | No | | The initial date. | ISO format (`YYYY-MM-DD`). |\n| end_date | Date | No, except if `start_date` is defined. | | Tne end date. | ISO format (`YYYY-MM-DD`). |\n| months | Integer | No | | Month periods. | |\n| years | Integer | No | | Year periods. | |\n\n_Note that a time reference shall be informed. That can be the absolute dates (_`_start_date_` _and_ `_end_date_`_) or one form of relative time control (_`_months_` _or_ `_years_`_)._\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `POST` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the final amount, total interest rate and growth factor:\n\n``` json\n{\n \"final_amount\": 110.00000000000001,\n \"total_interest\": 10.000000000000014,\n \"growth_factor\": 1.1\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for a invalid rate, containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_INPUT\",\n \"message\": \"rate must be a valid number\"\n}\n\n ```" }, "response": [] }, { "name": "Compound interest", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/finance/compound-interest?principal=100.00&rate=10.0&periods=1&frequency=annual", "host": [ "{{Hostname}}" ], "path": [ "v1", "finance", "compound-interest" ], "query": [ { "key": "principal", "value": "100.00", "description": "The principal value. Must be a positive float." }, { "key": "rate", "value": "10.0" }, { "key": "periods", "value": "1", "description": "The amount of periods. Must be a positive integer." }, { "key": "frequency", "value": "annual", "description": "The frequency. Can be ANNUAL, MONTHLY or DAILY. If not set, defaults to ANNUAL." } ] }, "description": "# 💵 Compound interest\n\nThis endpoint provides a compound interest calculator.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| principal | Float | Yes | | Principal monetary value. | |\n| rate | Float | Yes | | Interest rate. | |\n| period | Integer | Yes | | Period value. | Can be used as years, month or days. |\n| frequency | String | No | annual | The period frequency. | Can be `annual`, `monthly` or `daily`. |\n| start_date | Date | No | | The initial date. | ISO format (`YYYY-MM-DD`). |\n| end_date | Date | No, except if `start_date` is defined. | | Tne end date. | ISO format (`YYYY-MM-DD`). |\n| months | Integer | No | | Month periods. | |\n| years | Integer | No | | Year periods. | |\n\n_Note that a time reference shall be informed. That can be the absolute dates (_`_start_date_` _and_ `_end_date_`_) or one form of relative time control (_`_months_` _or_ `_years_`_)._\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `GET` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the final amount, total interest rate and growth factor:\n\n``` json\n{\n \"final_amount\": 110.00000000000001,\n \"total_interest\": 10.000000000000014,\n \"growth_factor\": 1.1\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for a invalid rate, containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_INPUT\",\n \"message\": \"rate must be a valid number\"\n}\n\n ```" }, "response": [] } ], "description": "# 💵 Finance\n\nThis directory contains the endpoints related to financial operations, such as installment and compound interest calculators." }, { "name": "Strings", "item": [ { "name": "Slug", "request": { "method": "POST", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"text\": \"Toolset API\",\r\n \"separator\": \"-\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/strings/slug", "host": [ "{{Hostname}}" ], "path": [ "v1", "strings", "slug" ] }, "description": "# 💬 Slug\n\nThis endpoint provides a slug converter.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| text | String | Yes | | Text to be used. | |\n| separator | String | No | \\- | Slug separator. | |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `POST` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the slug:\n\n``` json\n{\n \"slug\": \"toolset-api\"\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for a invalid request with no text, containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_INPUT\",\n \"message\": \"text parameter is required\"\n}\n\n ```" }, "response": [] }, { "name": "Slug", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/strings/slug?text=Toolset API&separator=-", "host": [ "{{Hostname}}" ], "path": [ "v1", "strings", "slug" ], "query": [ { "key": "text", "value": "Toolset API", "description": "The text to generate the slug." }, { "key": "separator", "value": "-", "description": "The separator to be used." } ] }, "description": "# 💬 Slug\n\nThis endpoint provides a slug converter.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| text | String | Yes | | Text to be used. | |\n| separator | String | No | \\- | Slug separator. | |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `GET` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the slug:\n\n``` json\n{\n \"slug\": \"toolset-api\"\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for a invalid request with no text, containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_INPUT\",\n \"message\": \"text parameter is required\"\n}\n\n ```" }, "response": [] }, { "name": "Truncate", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/strings/truncate?text=Toolset API&max_length=10&strategy=hard&ellipsis=...", "host": [ "{{Hostname}}" ], "path": [ "v1", "strings", "truncate" ], "query": [ { "key": "text", "value": "Toolset API", "description": "The text to generate the slug." }, { "key": "max_length", "value": "10", "description": "The maximum allowed length. This includes the ellipsis that will be added in the end of the truncation." }, { "key": "strategy", "value": "hard", "description": "The strategy to be used in the process, supporting HARD, WORD and SENTENCE." }, { "key": "ellipsis", "value": "...", "description": "The ellipsis to be used if the string needs truncation." } ] }, "description": "# 💬 Truncate\n\nThis endpoint provides a truncate converter.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| text | String | Yes | | Text to be used. | |\n| max_length | Integer | Yes | | Maximum allowed length. | Includes the ellipsis. |\n| strategy | String | No | hard | Truncation strategy. | Can be `hard`, `word` or `sentence`. |\n| ellipsis | String | No | ... | Ellipsis string to be used. | |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `GET` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the truncated text, the original length and a boolean status to inform if the provided string was actually truncated:\n\n``` json\n{\n \"truncated\": \"Toolset...\",\n \"original_length\": 11,\n \"truncated_bool\": true\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for a invalid length, containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_INPUT\",\n \"message\": \"max_length must be greater than 0\"\n}\n\n ```" }, "response": [] }, { "name": "Truncate", "request": { "method": "POST", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"text\": \"Toolset API\",\r\n \"max_length\": 10,\r\n \"strategy\": \"hard\",\r\n \"ellipsis\": \"...\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/strings/truncate", "host": [ "{{Hostname}}" ], "path": [ "v1", "strings", "truncate" ] }, "description": "# 💬 Truncate\n\nThis endpoint provides a truncate converter.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| text | String | Yes | | Text to be used. | |\n| max_length | Integer | Yes | | Maximum allowed length. | Includes the ellipsis. |\n| strategy | String | No | hard | Truncation strategy. | Can be `hard`, `word` or `sentence`. |\n| ellipsis | String | No | ... | Ellipsis string to be used. | |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `POST` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the truncated text, the original length and a boolean status to inform if the provided string was actually truncated:\n\n``` json\n{\n \"truncated\": \"Toolset...\",\n \"original_length\": 11,\n \"truncated_bool\": true\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for a invalid length, containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_INPUT\",\n \"message\": \"max_length must be greater than 0\"\n}\n\n ```" }, "response": [] }, { "name": "Mask", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/strings/mask?value=00000000000000&mask=%23%23.%23%23%23.%23%23%23/%23%23%23%23-%23%23", "host": [ "{{Hostname}}" ], "path": [ "v1", "strings", "mask" ], "query": [ { "key": "value", "value": "00000000000000", "description": "The original string to be masked." }, { "key": "mask", "value": "%23%23.%23%23%23.%23%23%23/%23%23%23%23-%23%23", "description": "The mask to be applied. Use # to map the dynamic values from the previous argument." } ] }, "description": "# 💬 Masking\n\nThis endpoint provides a masking operation.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| value | String | Yes | | Text to be used. | |\n| mask | String | Yes | | Mask to be used. | The hashtag (`#`) is used as a dynamic character, accepting values from the `value` argument. Other characters will be static. |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `GET` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the masked result:\n\n``` json\n{\n \"masked\": \"00.000.000/0000-00\"\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for a invalid request without mandatory arguments, containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_INPUT\",\n \"message\": \"value parameter is required\"\n}\n\n ```" }, "response": [] }, { "name": "Mask", "request": { "method": "POST", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"value\": \"00000000000000\",\r\n \"mask\": \"##.###.###/####-##\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/strings/mask", "host": [ "{{Hostname}}" ], "path": [ "v1", "strings", "mask" ] }, "description": "# 💬 Masking\n\nThis endpoint provides a masking operation.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| value | String | Yes | | Text to be used. | |\n| mask | String | Yes | | Mask to be used. | The hashtag (`#`) is used as a dynamic character, accepting values from the `value` argument. Other characters will be static. |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `POST` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the masked result:\n\n``` json\n{\n \"masked\": \"00.000.000/0000-00\"\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for a invalid request without mandatory arguments, containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_INPUT\",\n \"message\": \"value parameter is required\"\n}\n\n ```" }, "response": [] }, { "name": "Normalize", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/strings/normalize?text=Tóôlsèt Ãpï&operations=lowercase,remove_accents", "host": [ "{{Hostname}}" ], "path": [ "v1", "strings", "normalize" ], "query": [ { "key": "text", "value": "Tóôlsèt Ãpï", "description": "The original string to be normalized." }, { "key": "operations", "value": "lowercase,remove_accents", "description": "The operations to be applied. Options are LOWERCASE, UPPERCASE, REMOVE_ACCENTS, REMOVE_PUNCTUATION and COLLAPSE_SPACES. Accepts a comma-separated array of values." } ] }, "description": "# 💬 Normalization\n\nThis endpoint provides a string normalization operation.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| text | String | Yes | | Text to be used. | |\n| operations | String | Yes | | The operations to be used. | Can be `lowercase`, `uppercase`, `remove_accents`, `remove_punctuation` and/or `collapse_space`. Use a comma as separator for multiple values. |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `GET` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the normalized string:\n\n``` json\n{\n \"normalized\": \"toolset api\"\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for a request without an specified operation, containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_INPUT\",\n \"message\": \"operations array is required\"\n}\n\n ```" }, "response": [] }, { "name": "Normalize", "request": { "method": "POST", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"text\": \"Tóôlsèt Ãpï\",\r\n \"operations\": [\r\n \"lowercase\",\r\n \"remove_accents\"\r\n ]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/strings/normalize", "host": [ "{{Hostname}}" ], "path": [ "v1", "strings", "normalize" ] }, "description": "# 💬 Normalization\n\nThis endpoint provides a string normalization operation.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| text | String | Yes | | Text to be used. | |\n| operations | Array of strings | Yes | | The operations to be used. | Can be `lowercase`, `uppercase`, `remove_accents`, `remove_punctuation` and/or `collapse_space`. |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `POST` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the normalized string:\n\n``` json\n{\n \"normalized\": \"toolset api\"\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for a request without an specified operation, containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_INPUT\",\n \"message\": \"operations array is required\"\n}\n\n ```" }, "response": [] } ], "description": "# 💬 Strings\n\nThis directory contains the endpoints related to strings operations, such as slug, truncate, masking and normalization." }, { "name": "Numbers", "item": [ { "name": "Numbers to words", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/numbers/to-words?number=1234.56&mode=currency&language=en-US¤cy=USD", "host": [ "{{Hostname}}" ], "path": [ "v1", "numbers", "to-words" ], "query": [ { "key": "number", "value": "1234.56", "description": "The numeric input. Must be an integer for CARDINAL and ORDINAL. Can be either an integer or a float for CURRENCY." }, { "key": "mode", "value": "currency", "description": "The operation mode, supporting CARDINAL, ORDINAL and CURRENCY." }, { "key": "language", "value": "en-US", "description": "The ISO code for the language to be used." }, { "key": "currency", "value": "USD", "description": "The currency. This is used only for CURRENCY mode." } ] }, "description": "# 💯 Numbers to words\n\nThis endpoint provides a number-to-words conversion, supporting English, Portuguese (Brazil), Spanish (Spain) and Spanish (Argentina), besides cardinal, ordinal and currency modes.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| number | Integer or Float | Yes | | Numeric value. | Integer is used for `cardinal` or `ordinal` modes while `currency` supports both integer and float values. |\n| mode | String | No | cardinal | Operation mode. | Can be `cardinal`, `ordinal` or `currency`. |\n| language | String | No | en-US | Language ISO code. | Can be `en-US`, `pt-BR`, `es-AR` or `es-ES`. |\n| currency | String | No | USD | International currency code. | Can be `USD`, `BRL`, `EUR`, `GBP`, `ARS` or `BTC`. |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `GET` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the string result:\n\n``` json\n{\n \"words\": \"one thousand two hundred thirty-four dollars and fifty-six cents\"\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for a request with an unsupported currency, containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"CONVERSION_ERROR\",\n \"message\": \"unsupported currency\"\n}\n\n ```" }, "response": [] }, { "name": "Numbers to words", "request": { "method": "POST", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"number\": 1234.56,\r\n \"mode\": \"currency\",\r\n \"language\": \"en-US\",\r\n \"currency\": \"USD\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/numbers/to-words", "host": [ "{{Hostname}}" ], "path": [ "v1", "numbers", "to-words" ] }, "description": "# 💯 Numbers to words\n\nThis endpoint provides a number-to-words conversion, supporting English, Portuguese (Brazil), Spanish (Spain) and Spanish (Argentina), besides cardinal, ordinal and currency modes.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| number | Integer or Float | Yes | | Numeric value. | Integer is used for `cardinal` or `ordinal` modes while `currency` supports both integer and float values. |\n| mode | String | No | cardinal | Operation mode. | Can be `cardinal`, `ordinal` or `currency`. |\n| language | String | No | en-US | Language ISO code. | Can be `en-US`, `pt-BR`, `es-AR` or `es-ES`. |\n| currency | String | No | USD | International currency code. | Can be `USD`, `BRL`, `EUR`, `GBP`, `ARS` or `BTC`. |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `POST` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the normalized string:\n\n``` json\n{\n \"words\": \"one thousand two hundred thirty-four dollars and fifty-six cents\"\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for a request with an unsupported currency, containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"CONVERSION_ERROR\",\n \"message\": \"unsupported currency\"\n}\n\n ```" }, "response": [] } ], "description": "# 💯 Numbers\n\nThis directory contains the endpoints related to number operations, such as numbers to words." }, { "name": "Math", "item": [ { "name": "Expression evaluation", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/math/evaluate?expression=sin(pi/2)+sqrt(16)", "host": [ "{{Hostname}}" ], "path": [ "v1", "math", "evaluate" ], "query": [ { "key": "expression", "value": "sin(pi/2)+sqrt(16)", "description": "The expression to be calculated." } ] }, "description": "# 🧮 Expression evaluation\n\nThis endpoint provides a calculator, supporting several simple and complex math operations, such as addition, subtraction, multiplication, division, exponentiation, factorial, parenthesis priorization, elevation, roots and several others (see the table below for detailed information).\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| expression | String | Yes | | The formula to be calculated. | |\n\n_Note that the formula cannot contain letters. If you'd like to discover the value of a specified letter, adjust the formula to a compatible format._\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `GET` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the formula result:\n\n``` json\n{\n \"result\": 5\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for a request with an invalid expression, containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"EVAL_ERROR\",\n \"message\": \"unexpected token \\\"s\\\" at position 10\"\n}\n\n ```\n\n#### Supported features\n\n| **Category** | **Example** |\n| --- | --- |\n| Operators | `+`, `-`, `\\\\\\\\\\\\\\*`, `/`, `%`, `^` and `**` |\n| Postfix | `5!` and `3!!` |\n| Roots | `sqrt(x)`, `cbrt(x)`, `root(n, x)` and `nrt(n, x)` |\n| Powers/logs | `exp`, `exp2`, `pow`, `ln`/`log`, `log2`, `log10` and `logb(base, x)` |\n| Trig | `sin`, `cos`, `tan`, `asin`, `acos`, `atan`, `atan2`, `sinh`, `cosh`, `tanh`, `asinh`, `acosh` and `atanh` |\n| Conversion | `deg(rad)` and `rad(deg)` |\n| Rounding | `abs`, `ceil`, `floor`, `round`, `trunc` and `sign` |\n| Aggregates | `min`, `max`, `clamp`, `sum`, `product` and `avg`/`mean` |\n| Combinatorics | `factorial`/`fact`, `gamma`, `perm`/`npr` and `comb`/`ncr`/`binomial` |\n| Number theory | `gcd`, `lcm`, `hypot`, `mod` and `rem` |\n| Constants | `pi`, `e`, `phi`/`golden`, `tau` and `inf` |" }, "response": [] }, { "name": "Expression evaluation", "request": { "method": "POST", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"expression\": \"sin(pi/2)+sqrt(16)\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/math/evaluate", "host": [ "{{Hostname}}" ], "path": [ "v1", "math", "evaluate" ] }, "description": "# 🧮 Expression evaluation\n\nThis endpoint provides a calculator, supporting several simple and complex math operations, such as addition, subtraction, multiplication, division, exponentiation, factorial, parenthesis priorization, elevation, roots and several others (see the table below for detailed information).\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| expression | String | Yes | | The formula to be calculated. | |\n\n_Note that the formula cannot contain letters. If you'd like to discover the value of a specified letter, adjust the formula to a compatible format._\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `POST` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the formula result:\n\n``` json\n{\n \"result\": 5\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for a request with an invalid expression, containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"EVAL_ERROR\",\n \"message\": \"unexpected token \\\"s\\\" at position 10\"\n}\n\n ```\n\n#### Supported features\n\n| **Category** | **Example** |\n| --- | --- |\n| Operators | `+`, `-`, `\\\\\\\\\\\\\\\\*`, `/`, `%`, `^` and `**` |\n| Postfix | `5!` and `3!!` |\n| Roots | `sqrt(x)`, `cbrt(x)`, `root(n, x)` and `nrt(n, x)` |\n| Powers/logs | `exp`, `exp2`, `pow`, `ln`/`log`, `log2`, `log10` and `logb(base, x)` |\n| Trig | `sin`, `cos`, `tan`, `asin`, `acos`, `atan`, `atan2`, `sinh`, `cosh`, `tanh`, `asinh`, `acosh` and `atanh` |\n| Conversion | `deg(rad)` and `rad(deg)` |\n| Rounding | `abs`, `ceil`, `floor`, `round`, `trunc` and `sign` |\n| Aggregates | `min`, `max`, `clamp`, `sum`, `product` and `avg`/`mean` |\n| Combinatorics | `factorial`/`fact`, `gamma`, `perm`/`npr` and `comb`/`ncr`/`binomial` |\n| Number theory | `gcd`, `lcm`, `hypot`, `mod` and `rem` |\n| Constants | `pi`, `e`, `phi`/`golden`, `tau` and `inf` |" }, "response": [] }, { "name": "Area calculator", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/math/area?shape=rectangle&width=2.0&height=3.0", "host": [ "{{Hostname}}" ], "path": [ "v1", "math", "area" ], "query": [ { "key": "shape", "value": "rectangle", "description": "The shape." }, { "key": "width", "value": "2.0", "description": "The width of a rectangle." }, { "key": "height", "value": "3.0", "description": "The height of a ractangle." }, { "key": "size", "value": "2.0", "description": "The size of a square.", "type": "text", "disabled": true }, { "key": "base", "value": "2.0", "description": "The base of a triangle.", "type": "text", "disabled": true }, { "key": "height", "value": "3.0", "description": "The height of a triangle.", "type": "text", "disabled": true }, { "key": "radius", "value": "2.0", "description": "The radius of a circle.", "type": "text", "disabled": true }, { "key": "a", "value": "2.0", "description": "The first axis of a ellipse.", "type": "text", "disabled": true }, { "key": "b", "value": "3.0", "description": "The second axis of a ellipse.", "type": "text", "disabled": true }, { "key": "a", "value": "2.0", "description": "The first dimension of a trapezoid.", "type": "text", "disabled": true }, { "key": "b", "value": "3.0", "description": "The second dimension of a trapezoid.", "type": "text", "disabled": true }, { "key": "height", "value": "4.0", "description": "The height of a trapezoid.", "type": "text", "disabled": true }, { "key": "base", "value": "2.0", "description": "The base of a parallelogram.", "type": "text", "disabled": true }, { "key": "height", "value": "3.0", "description": "The height of a parallelogram.", "type": "text", "disabled": true }, { "key": "d1", "value": "2.0", "description": "The first diagonal of a rhombus.", "type": "text", "disabled": true }, { "key": "d2", "value": "3.0", "description": "The second diagonal of a rhombus.", "type": "text", "disabled": true }, { "key": "side", "value": "2.0", "description": "The side of a hexagon.", "type": "text", "disabled": true }, { "key": "side", "value": "2.0", "description": "The side of a pentagon.", "type": "text", "disabled": true }, { "key": "radius", "value": "2.0", "description": "The radius of a sector.", "type": "text", "disabled": true }, { "key": "angle", "value": "90", "description": "The angle, in degrees, of a sector.", "disabled": true } ] }, "description": "# 🧮 Area calculator\n\nThis endpoint provides a area calculator, supporting several shapes.\n\n### Arguments\n\nThe required arguments are mutable in this endpoint, depending on the selected shape. See the supported shapes table for detailed information.\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| shape | String | Yes | | The shape to be considered. | Supported shapes are listed below alongside its required dimensions. |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `GET` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the formula result:\n\n``` json\n{\n \"area\": 6\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for a request with an invalid expression, containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"EVAL_ERROR\",\n \"message\": \"unexpected token \\\"s\\\" at position 10\"\n}\n\n ```\n\n#### Supported shapes\n\n| Shape | Required dimensions (arguments) |\n| --- | --- |\n| `rectangle`/`rect` | `width` and `height` |\n| `square` | `side` |\n| `triangle` | `base` and `height` |\n| `circle` | `radius` |\n| `ellipse` | `a` and `b` (semi-axes) |\n| `trapezoid`/`trapezium` | `a`, `b` and `height` |\n| `parallelogram` | `base` and `height` |\n| `rhombus` | `d1` and `d2` (diagonals) |\n| `hexagon` | `side` |\n| `pentagon` | `side` |\n| `sector` | `radius` and `angle` (degrees) |\n\n_Note that all dimensions support integer and float values._" }, "response": [] }, { "name": "Area calculator", "request": { "method": "POST", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"shape\": \"rectangle\",\r\n \"width\": 2.0,\r\n \"height\": 3.0\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/math/area", "host": [ "{{Hostname}}" ], "path": [ "v1", "math", "area" ] }, "description": "# 🧮 Area calculator\n\nThis endpoint provides a area calculator, supporting several shapes.\n\n### Arguments\n\nThe required arguments are mutable in this endpoint, depending on the selected shape. See the supported shapes table for detailed information.\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| shape | String | Yes | | The shape to be considered. | Supported shapes are listed below alongside its required dimensions. |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `POST` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the formula result:\n\n``` json\n{\n \"area\": 6\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for a request with missing dimensions, containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_INPUT\",\n \"message\": \"missing required dimension(s): width, height\"\n}\n\n ```\n\n#### Supported shapes\n\n| Shape | Required dimensions (arguments) |\n| --- | --- |\n| `rectangle`/`rect` | `width` and `height` |\n| `square` | `side` |\n| `triangle` | `base` and `height` |\n| `circle` | `radius` |\n| `ellipse` | `a` and `b` (semi-axes) |\n| `trapezoid`/`trapezium` | `a`, `b` and `height` |\n| `parallelogram` | `base` and `height` |\n| `rhombus` | `d1` and `d2` (diagonals) |\n| `hexagon` | `side` |\n| `pentagon` | `side` |\n| `sector` | `radius` and `angle` (degrees) |\n\n_Note that all dimensions support integer and float values._" }, "response": [] }, { "name": "Volume calculator", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/math/volume?shape=cube&side=2.0", "host": [ "{{Hostname}}" ], "path": [ "v1", "math", "volume" ], "query": [ { "key": "shape", "value": "cube", "description": "The shape." }, { "key": "side", "value": "2.0", "description": "The cube side." }, { "key": "width", "value": "2.0", "description": "The cuboid width.", "disabled": true }, { "key": "height", "value": "3.0", "description": "The cuboid height.", "disabled": true }, { "key": "depth", "value": "4.0", "description": "The cuboid depth.", "disabled": true }, { "key": "radius", "value": "2.0", "description": "The sphere radius.", "disabled": true }, { "key": "radius", "value": "2.0", "description": "The cylinder radius.", "disabled": true }, { "key": "height", "value": "3.0", "description": "The cylinder height.", "disabled": true }, { "key": "radius", "value": "2.0", "description": "The cone radius.", "disabled": true }, { "key": "height", "value": "3.0", "description": "The cone height.", "disabled": true }, { "key": "a", "value": "2.0", "description": "The ellipsoid first dimension.", "disabled": true }, { "key": "b", "value": "3.0", "description": "The ellipsoid second dimension.", "disabled": true }, { "key": "c", "value": "4.0", "description": "The ellipsoid third dimension.", "disabled": true }, { "key": "base_area", "value": "2.0", "description": "The pyramid base area.", "disabled": true }, { "key": "height", "value": "3.0", "description": "The pyramid height.", "disabled": true }, { "key": "side", "value": "2.0", "description": "The square pyramid side.", "disabled": true }, { "key": "height", "value": "3.0", "description": "The square pyramid height.", "disabled": true }, { "key": "side", "value": "2.0", "description": "The tetrahdron side.", "disabled": true }, { "key": "base_area", "value": "2.0", "description": "The prism base area.", "disabled": true }, { "key": "height", "value": "3.0", "description": "The prism height.", "disabled": true }, { "key": "r", "value": "2.0", "description": "The torus tube radius.", "disabled": true }, { "key": "R", "value": "3.0", "description": "The torus major radius.", "disabled": true }, { "key": "radius", "value": "2.0", "description": "The capsule radius.", "disabled": true }, { "key": "height", "value": "3.0", "description": "The capsule height.", "disabled": true } ] }, "description": "# 🧮 Volume calculator\n\nThis endpoint provides a volume calculator, supporting several shapes.\n\n### Arguments\n\nThe required arguments are mutable in this endpoint, depending on the selected shape. See the supported shapes table for detailed information.\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| shape | String | Yes | | The shape to be considered. | Supported shapes are listed below alongside its required dimensions. |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `GET` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the formula result:\n\n``` json\n{\n \"volume\": 8\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for a request with an unsupported shape, containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_INPUT\",\n \"message\": \"unknown shape\"\n}\n\n ```\n\n#### Supported shapes\n\n| Shape | Required dimensions (arguments) |\n| --- | --- |\n| `cube` | `side` |\n| `cuboid`/`box` | `width`, `height` and `depth` |\n| `sphere` | `radius` |\n| `hemisphere` | `radius` |\n| `cylinder` | `radius` and `height` |\n| `cone` | `radius` and `height` |\n| `ellipsoid` | `a`, `b` and `c` |\n| `pyramid` | `base_area` and `height` |\n| `square_pyramid` | `side` and `height` |\n| `tetrahedron` | `side` |\n| `prism` | `base_area` and `height` |\n| `torus` | `r` (tube radius) and `R` (major radius) |\n| `capsule` | `radius` and `height` |\n\n_Note that all dimensions support integer and float values._" }, "response": [] }, { "name": "Volume calculator", "request": { "method": "POST", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"shape\": \"cube\",\r\n \"side\": 2.0\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/math/volume", "host": [ "{{Hostname}}" ], "path": [ "v1", "math", "volume" ] }, "description": "# 🧮 Volume calculator\n\nThis endpoint provides a volume calculator, supporting several shapes.\n\n### Arguments\n\nThe required arguments are mutable in this endpoint, depending on the selected shape. See the supported shapes table for detailed information.\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| shape | String | Yes | | The shape to be considered. | Supported shapes are listed below alongside its required dimensions. |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `POST` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the formula result:\n\n``` json\n{\n \"volume\": 8\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for a request with an unsupported shape, containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_INPUT\",\n \"message\": \"unknown shape\"\n}\n\n ```\n\n#### Supported shapes\n\n| Shape | Required dimensions (arguments) |\n| --- | --- |\n| `cube` | `side` |\n| `cuboid`/`box` | `width`, `height` and `depth` |\n| `sphere` | `radius` |\n| `hemisphere` | `radius` |\n| `cylinder` | `radius` and `height` |\n| `cone` | `radius` and `height` |\n| `ellipsoid` | `a`, `b` and `c` |\n| `pyramid` | `base_area` and `height` |\n| `square_pyramid` | `side` and `height` |\n| `tetrahedron` | `side` |\n| `prism` | `base_area` and `height` |\n| `torus` | `r` (tube radius) and `R` (major radius) |\n| `capsule` | `radius` and `height` |\n\n_Note that all dimensions support integer and float values._" }, "response": [] }, { "name": "Pythagorean theorem calculator", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/math/pythagoras?a=1&b=2", "host": [ "{{Hostname}}" ], "path": [ "v1", "math", "pythagoras" ], "query": [ { "key": "a", "value": "1", "description": "First leg." }, { "key": "b", "value": "2", "description": "Second leg." }, { "key": "c", "value": "3", "description": "Hypotenuse.", "disabled": true } ] }, "description": "# 🧮 Pythagorean theorem calculator\n\nThis endpoint provides a Pythagorean theorem calculator.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| a | Integer or Float | Yes, except if both `b` and `c` are defined. | | First leg. | |\n| b | Integer or Float | Yes, except if both `a` and `c` are defined. | | Second leg. | |\n| c | Integer or Float | Yes, except if both `a` and `b` are defined. | | Hypotenuse. | |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `GET` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the calculated side in the result:\n\n``` json\n{\n \"result\": 2.23606797749979\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for a request with all three arguments provided, containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_INPUT\",\n \"message\": \"exactly two of a, b, c must be provided\"\n}\n\n ```" }, "response": [] }, { "name": "Pythagorean theorem calculator", "request": { "method": "POST", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"a\": 1,\r\n \"b\": 2\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/math/pythagoras", "host": [ "{{Hostname}}" ], "path": [ "v1", "math", "pythagoras" ] }, "description": "# 🧮 Pythagorean theorem calculator\n\nThis endpoint provides a Pythagorean theorem calculator.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| a | Integer or Float | Yes, except if both `b` and `c` are defined. | | First leg. | |\n| b | Integer or Float | Yes, except if both `a` and `c` are defined. | | Second leg. | |\n| c | Integer or Float | Yes, except if both `a` and `b` are defined. | | Hypotenuse. | |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `POST` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the calculated side in the result:\n\n``` json\n{\n \"result\": 2.23606797749979\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for a request with all three arguments provided, containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_INPUT\",\n \"message\": \"exactly two of a, b, c must be provided\"\n}\n\n ```" }, "response": [] } ], "description": "# 🧮 Math\n\nThis directory contains the endpoints related to math operations, such as calculator, volume and area calculators, Pythagorean theorem calculator." }, { "name": "Physics", "item": [ { "name": "Distance converter", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/physics/distance?value=100&from=km&to=mi", "host": [ "{{Hostname}}" ], "path": [ "v1", "physics", "distance" ], "query": [ { "key": "value", "value": "100", "description": "The value to be converted." }, { "key": "from", "value": "km", "description": "The original unit." }, { "key": "to", "value": "mi", "description": "The target unit." } ] }, "description": "# 🧮 Distance converter\n\nThis endpoint provides a distance converter supporting metric, imperial, nautical and astronomical systems.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| value | Integer | Yes | | Value to be converter. | |\n| from | String | Yes | | Original unit. | See the supported units table below. |\n| to | String | Yes | | Target unit. | See the supported units table below. |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `GET` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the formula result:\n\n``` json\n{\n \"result\": 62.13711922373339\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for a request with an invalid unit, containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_INPUT\",\n \"message\": \"unknown unit \\\"mil\\\"\"\n}\n\n ```\n\n#### Supported units and systems\n\n| System | Unit |\n| --- | --- |\n| Metric/SI | `nm` |\n| Metric/SI | `um`/`µm` |\n| Metric/SI | `mm` |\n| Metric/SI | `cm` |\n| Metric/SI | `dm` |\n| Metric/SI | `m`/`metre` |\n| Metric/SI | `km` |\n| Imperial/US | `in`/`inch` |\n| Imperial/US | `ft`/`foot`/`feet` |\n| Imperial/US | `yd`/`yard` |\n| Imperial/US | `mi`/`mile` |\n| Imperial/US | `league` |\n| Imperial/US | `furlong` |\n| Imperial/US | `chain` |\n| Imperial/US | `rod` |\n| Imperial/US | `cubit` |\n| Nautical | `nmi`/`nautical_mile` |\n| Nautical | `fathom`/`ftm` |\n| Nautical | `cable` |\n| Astronomical | `au`/`astronomical_unit` |\n| Astronomical | `ly`/`light_year` |\n| Astronomical | `pc`/`parsec` |\n\n_Note that all dimensions support integer values._" }, "response": [] }, { "name": "Distance converter", "request": { "method": "POST", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"value\": 100,\r\n \"from\": \"km\",\r\n \"to\": \"mi\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/physics/distance", "host": [ "{{Hostname}}" ], "path": [ "v1", "physics", "distance" ] }, "description": "# 🧮 Distance converter\n\nThis endpoint provides a distance converter supporting metric, imperial, nautical and astronomical systems.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| value | Integer | Yes | | Value to be converter. | |\n| from | String | Yes | | Original unit. | See the supported units table below. |\n| to | String | Yes | | Target unit. | See the supported units table below. |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `POST` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the formula result:\n\n``` json\n{\n \"result\": 62.13711922373339\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for a request with an invalid unit, containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_INPUT\",\n \"message\": \"unknown unit \\\"mil\\\"\"\n}\n\n ```\n\n#### Supported units and systems\n\n| System | Unit |\n| --- | --- |\n| Metric/SI | `nm` |\n| Metric/SI | `um`/`µm` |\n| Metric/SI | `mm` |\n| Metric/SI | `cm` |\n| Metric/SI | `dm` |\n| Metric/SI | `m`/`metre` |\n| Metric/SI | `km` |\n| Imperial/US | `in`/`inch` |\n| Imperial/US | `ft`/`foot`/`feet` |\n| Imperial/US | `yd`/`yard` |\n| Imperial/US | `mi`/`mile` |\n| Imperial/US | `league` |\n| Imperial/US | `furlong` |\n| Imperial/US | `chain` |\n| Imperial/US | `rod` |\n| Imperial/US | `cubit` |\n| Nautical | `nmi`/`nautical_mile` |\n| Nautical | `fathom`/`ftm` |\n| Nautical | `cable` |\n| Astronomical | `au`/`astronomical_unit` |\n| Astronomical | `ly`/`light_year` |\n| Astronomical | `pc`/`parsec` |\n\n_Note that all dimensions support integer values._" }, "response": [] }, { "name": "Speed converter", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/physics/speed?value=100&from=km/h&to=mi/h", "host": [ "{{Hostname}}" ], "path": [ "v1", "physics", "speed" ], "query": [ { "key": "value", "value": "100", "description": "The value to be converted." }, { "key": "from", "value": "km/h", "description": "The original unit." }, { "key": "to", "value": "mi/h", "description": "The target unit." } ] }, "description": "# 🧮 Speed converter\n\nThis endpoint provides a speed converter supporting metric, imperial, nautical and physics systems.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| value | Integer | Yes | | Value to be converter. | |\n| from | String | Yes | | Original unit. | See the supported units table below. |\n| to | String | Yes | | Target unit. | See the supported units table below. |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `GET` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the formula result:\n\n``` json\n{\n \"result\": 62.13711922373339\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for a request with an invalid unit, containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_INPUT\",\n \"message\": \"unknown unit \\\"mil\\\"\"\n}\n\n ```\n\n#### Supported units and systems\n\n| System | Unit |\n| --- | --- |\n| Metric | `m/s` or `mps` |\n| Metric | `km/s` |\n| Metric | `km/h` or `kph` |\n| Metric | `cm/s` |\n| Metric | `mm/s` |\n| Imperial | `mph` or `mi/h` |\n| Imperial | `ft/s` or `fps` |\n| Imperial | `mi/s` |\n| Imperial | `in/s` |\n| Nautical | `knot`, `knots`, `kn` or `kt` |\n| Physics | `mach` |\n| Physics | `c` or `speed_of_light` |\n| Physics | `speed_of_sound` |\n\n_Note that all dimensions support integer values._" }, "response": [] }, { "name": "Speed converter", "request": { "method": "POST", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"value\": 100,\r\n \"from\": \"km/h\",\r\n \"to\": \"mi/h\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/physics/speed", "host": [ "{{Hostname}}" ], "path": [ "v1", "physics", "speed" ] }, "description": "# 🧮 Speed converter\n\nThis endpoint provides a speed converter supporting metric, imperial, nautical and physics systems.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| value | Integer | Yes | | Value to be converter. | |\n| from | String | Yes | | Original unit. | See the supported units table below. |\n| to | String | Yes | | Target unit. | See the supported units table below. |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `POST` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the formula result:\n\n``` json\n{\n \"result\": 62.13711922373339\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for a request with an invalid unit, containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_INPUT\",\n \"message\": \"unknown unit \\\"mil\\\"\"\n}\n\n ```\n\n#### Supported units and systems\n\n| System | Unit |\n| --- | --- |\n| Metric | `m/s` or `mps` |\n| Metric | `km/s` |\n| Metric | `km/h` or `kph` |\n| Metric | `cm/s` |\n| Metric | `mm/s` |\n| Imperial | `mph` or `mi/h` |\n| Imperial | `ft/s` or `fps` |\n| Imperial | `mi/s` |\n| Imperial | `in/s` |\n| Nautical | `knot`, `knots`, `kn` or `kt` |\n| Physics | `mach` |\n| Physics | `c` or `speed_of_light` |\n| Physics | `speed_of_sound` |\n\n_Note that all dimensions support integer values._" }, "response": [] }, { "name": "Temperature converter", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/physics/temperature?value=100&from=c&to=f", "host": [ "{{Hostname}}" ], "path": [ "v1", "physics", "temperature" ], "query": [ { "key": "value", "value": "100", "description": "The value to be converted." }, { "key": "from", "value": "c", "description": "The original unit." }, { "key": "to", "value": "f", "description": "The target unit." } ] }, "description": "# 🧮 Temperature converter\n\nThis endpoint provides a temperature converter supporting Celsius, Fahrenheit, Kelvin, Rankine, Réaumur, Rømer, Delisle and Newton systems.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| value | Integer or Float | Yes | | Value to be converter. | |\n| from | String | Yes | | Original unit. | See the supported units table below. |\n| to | String | Yes | | Target unit. | See the supported units table below. |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `GET` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the formula result:\n\n``` json\n{\n \"result\": 211.99999999999994\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for a request with an invalid unit, containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_INPUT\",\n \"message\": \"unknown unit \\\"ce\\\"\"\n}\n\n ```\n\n#### Supported units and systems\n\n| System | Unit |\n| --- | --- |\n| Celsius | `c`, `celsius` or `centigrade` |\n| Fahrenheit | `f` or `fahrenheit` |\n| Kelvin | `k` or `kelvin` |\n| Rankine | `r` or `rankine` |\n| Réaumur | `re`, `reaumur` or `réaumur` |\n| Rømer | `ro`, `rø`, `romer` or `rømer` |\n| Delisle | `de` or `delisle` |\n| Newton | `n` or `newton` |\n\n_Note that all units support integer and float values._" }, "response": [] }, { "name": "Temperature converter", "request": { "method": "POST", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"value\": 100,\r\n \"from\": \"c\",\r\n \"to\": \"f\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/physics/temperature", "host": [ "{{Hostname}}" ], "path": [ "v1", "physics", "temperature" ] }, "description": "# 🧮 Temperature converter\n\nThis endpoint provides a temperature converter supporting Celsius, Fahrenheit, Kelvin, Rankine, Réaumur, Rømer, Delisle and Newton systems.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| value | Integer or Float | Yes | | Value to be converter. | |\n| from | String | Yes | | Original unit. | See the supported units table below. |\n| to | String | Yes | | Target unit. | See the supported units table below. |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `POST` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the formula result:\n\n``` json\n{\n \"result\": 211.99999999999994\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for a request with an invalid unit, containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_INPUT\",\n \"message\": \"unknown unit \\\"ce\\\"\"\n}\n\n ```\n\n#### Supported units and systems\n\n| System | Unit |\n| --- | --- |\n| Celsius | `c`, `celsius` or `centigrade` |\n| Fahrenheit | `f` or `fahrenheit` |\n| Kelvin | `k` or `kelvin` |\n| Rankine | `r` or `rankine` |\n| Réaumur | `re`, `reaumur` or `réaumur` |\n| Rømer | `ro`, `rø`, `romer` or `rømer` |\n| Delisle | `de` or `delisle` |\n| Newton | `n` or `newton` |\n\n_Note that all units support integer and float values._" }, "response": [] } ], "description": "# 🍎 Physics\n\nThis directory contains the endpoints related to physics operations, such as distance, speed and temperature conversions." }, { "name": "Phone numbers", "item": [ { "name": "Phone number validation", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/phones/validate?phone=+551122222222&country=BR", "host": [ "{{Hostname}}" ], "path": [ "v1", "phones", "validate" ], "query": [ { "key": "phone", "value": "+551122222222", "description": "Phone number." }, { "key": "country", "value": "BR", "description": "Country two-letter ISO code. Defaults to US." } ] }, "description": "# 📞 Phone number validation\n\nThis endpoint provides a phone number validation, providing a result informing if the provided phone number has a valid format. Supports the following countries: USA (US), Brazil (BR), Canada (CA), United Kingdom (UK), Germany (DE), Italy (IT), Spain (ES), Portugal (PT) and France (FR).\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| phone | String | Yes | | Phone number. | Can be formatted (e.g. `+55 11 2222-2222` - or digits only - e.g. `551122222222`) |\n| country | String | No | US | Two-letter ISO country code. | |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `GET`request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the validation status and the phone number in E164, national and international formats, alongside an type enumerator (`LANDLINE`, `MOBILE` or `UNKNOWN`):\n\n##### Valid phone number:\n\n``` json\n{\n \"valid\": true,\n \"e164\": \"+551122222222\",\n \"formatted_national\": \"(11) 2222-2222\",\n \"formatted_international\": \"+55 11 2222-2222\",\n \"type\": \"LANDLINE\"\n}\n\n ```\n\n##### Invalid phone number:\n\n``` json\n{\n \"valid\": false\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for request without informing the phone number containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_INPUT\",\n \"message\": \"phone parameter is required\"\n}\n\n ```\n\n### Supported countries\n\nSupportes countries are:\n\n- Brazil (BR)\n \n- United States of America (US)\n \n- United Kingdom (UK)\n \n- Germany (DE)\n \n- Canada (CA)\n \n- France (FR)\n \n- Spain (ES)\n \n- Portugal (PT)\n \n- Italy (IT)\n \n\nNon-supported countries will return invalid phone number results.\n\n### Notes\n\nThis endpoint does not validate if a phone is active or if it's registered, only if is a valid format." }, "response": [] }, { "name": "Phone number validation", "request": { "method": "POST", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"phone\": \"+551122222222\",\r\n \"country\": \"BR\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/phones/validate", "host": [ "{{Hostname}}" ], "path": [ "v1", "phones", "validate" ] }, "description": "# 📞 Phone number validation\n\nThis endpoint provides a phone number validation, providing a result informing if the provided phone number has a valid format. Supports the following countries: USA (US), Brazil (BR), Canada (CA), United Kingdom (UK), Germany (DE), Italy (IT), Spain (ES), Portugal (PT) and France (FR).\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| phone | String | Yes | | Phone number. | Can be formatted (e.g. `+55 11 2222-2222` - or digits only - e.g. `551122222222`) |\n| country | String | No | US | Two-letter ISO country code. | |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `POST`request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the validation status and the phone number in E164, national and international formats, alongside an type enumerator (`LANDLINE`, `MOBILE` or `UNKNOWN`):\n\n##### Valid phone number:\n\n``` json\n{\n \"valid\": true,\n \"e164\": \"+551122222222\",\n \"formatted_national\": \"(11) 2222-2222\",\n \"formatted_international\": \"+55 11 2222-2222\",\n \"type\": \"LANDLINE\"\n}\n\n ```\n\n##### Invalid phone number:\n\n``` json\n{\n \"valid\": false\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for request without informing the phone number containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_INPUT\",\n \"message\": \"phone parameter is required\"\n}\n\n ```\n\n### Supported countries\n\nSupportes countries are:\n\n- Brazil (BR)\n \n- United States of America (US)\n \n- United Kingdom (UK)\n \n- Germany (DE)\n \n- Canada (CA)\n \n- France (FR)\n \n- Spain (ES)\n \n- Portugal (PT)\n \n- Italy (IT)\n \n\nNon-supported countries will return invalid phone number results.\n\n### Notes\n\nThis endpoint does not validate if a phone is active or if it's registered, only if is a valid format." }, "response": [] } ], "description": "# 📞 Phone numbers\n\nThis directory contains the endpoints related to phone number operations, such as validation accordinly to several formats, including Brazil, USA, Canada, United Kingdom, Germany, France, Italy, Portugal and Spain." }, { "name": "Vehicles", "item": [ { "name": "Plate validation", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/vehicles/plates/validate?plate=ABC0D12&country=BR", "host": [ "{{Hostname}}" ], "path": [ "v1", "vehicles", "plates", "validate" ], "query": [ { "key": "plate", "value": "ABC0D12", "description": "Vehicle plate number." }, { "key": "country", "value": "BR" } ] }, "description": "# 🚗 Vehicle plate validation\n\nThis endpoint provides a vehicle plate validation, supporting several countries, including the USA (US), Brazil (BR), Argentina (AR), Uruguay (UY), Paraguay (PY), Germany (DE), France (FR), Chile (CH), Bolivia (BO), Italy (IT), Spain (ES), Portugal (PT), United Kingdom (UK), Netherlands (NL), Poland (PL), Sweden (SE) and Switzerland (CH).\n\nFor South American countries, both Mercosul and the previous national plate formats are supported. In this scenarios, the format can return `MERCOSUL` or `NATIONAL`.\n\nFor France and Spain, both `MODERN` and `LEGACY` formates are supported.\n\nFor the UK, the format can be either `MODERN`, `PREFIX` or `SUFFIX`.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| plate | String | Yes | | Vehicle plate value. | Can be formatted (e.g. `ABC-0D12` - or digits only - e.g. `ABC0D12`) |\n| country | String | No | US | Two-letter ISO country code. | |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `GET` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the calendar days, weeks and months:\n\n#### With country argument:\n\n``` json\n{\n \"valid\": true,\n \"format\": \"MERCOSUL\",\n \"normalized\": \"ABC0D12\"\n}\n\n ```\n\n#### Without country argument:\n\n``` json\n{\n \"valid\": true,\n \"country\": \"US\",\n \"normalized\": \"ABC0D12\"\n}\n\n ```\n\n#### Notes\n\nThe `format` result argument will be provided only if multiple formats are supported by the requested `country`.\n\nThe `country` will be provided only if it's not explicitly set in the request.\n\nThe `normalized` result will be provided if the provided plate is not already normalized (e.g. if the passed plate is `ABC-0D12` for Brazilian Mercosul, the result will include the normalized plate as `ABC0D12`, as the official format does not include the dash).\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for a not supported country code, containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_INPUT\",\n \"message\": \"unsupported country code\"\n}\n\n ```" }, "response": [] }, { "name": "Plate validation", "request": { "method": "POST", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"plate\": \"ABC0D12\",\r\n \"country\": \"BR\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/vehicles/plates/validate", "host": [ "{{Hostname}}" ], "path": [ "v1", "vehicles", "plates", "validate" ] }, "description": "# 🚗 Vehicle plate validation\n\nThis endpoint provides a vehicle plate validation, supporting several countries, including the USA (US), Brazil (BR), Argentina (AR), Uruguay (UY), Paraguay (PY), Germany (DE), France (FR), Chile (CH), Bolivia (BO), Italy (IT), Spain (ES), Portugal (PT), UK (UK), Netherlands (NL), Poland (PL), Sweden (SE) and Switzerland (CH).\n\nFor South American countries, both Mercosul and the previous national plate formats are supported. In this scenarios, the format can return `MERCOSUL` or `NATIONAL`.\n\nFor France and Spain, both `MODERN` and `LEGACY` formates are supported.\n\nFor the UK, the format can be either `MODERN`, `PREFIX` or `SUFFIX`.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| plate | String | Yes | | Vehicle plate value. | Can be formatted (e.g. `ABC-0D12` - or digits only - e.g. `ABC0D12`) |\n| country | String | No | US | Two-letter ISO country code. | |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `POST` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the calendar days, weeks and months:\n\n#### With country argument:\n\n``` json\n{\n \"valid\": true,\n \"format\": \"MERCOSUL\",\n \"normalized\": \"ABC0D12\"\n}\n\n ```\n\n#### Without country argument:\n\n``` json\n{\n \"valid\": true,\n \"country\": \"US\",\n \"normalized\": \"ABC0D12\"\n}\n\n ```\n\n#### Notes\n\nThe `format` result argument will be provided only if multiple formats are supported by the requested `country`.\n\nThe `country` will be provided only if it's not explicitly set in the request.\n\nThe `normalized` result will be provided if the provided plate is not already normalized (e.g. if the passed plate is `ABC-0D12` for Brazilian Mercosul, the result will include the normalized plate as `ABC0D12`, as the official format does not include the dash).\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for a not supported country code, containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_INPUT\",\n \"message\": \"unsupported country code\"\n}\n\n ```" }, "response": [] }, { "name": "VIN validation", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/vehicles/vin/validate?vin=1HGCM82633A004352", "host": [ "{{Hostname}}" ], "path": [ "v1", "vehicles", "vin", "validate" ], "query": [ { "key": "vin", "value": "1HGCM82633A004352", "description": "VIN number." } ] }, "description": "# 🚗 VIN validation\n\nThis endpoint provides a VIN (Vehicle Identification Number) validation and normalization.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| vin | String | Yes | | VIN number. | |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `GET` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the validation status, WMI (World Manufacturer Identified), region and possible model years:\n\n``` json\n{\n \"valid\": true,\n \"wmi\": \"1HG\",\n \"region\": \"North America\",\n \"model_years\": [\n 2003\n ]\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for a request without a VIN number, containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_INPUT\",\n \"message\": \"vin is required\"\n}\n\n ```" }, "response": [] }, { "name": "VIN validation", "request": { "method": "POST", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"vin\": \"1HGCM82633A004352\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/vehicles/vin/validate", "host": [ "{{Hostname}}" ], "path": [ "v1", "vehicles", "vin", "validate" ] }, "description": "# 🚗 VIN validation\n\nThis endpoint provides a VIN (Vehicle Identification Number) validation and normalization.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| vin | String | Yes | | VIN number. | |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `POST` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the validation status, WMI (World Manufacturer Identified), region and possible model years:\n\n``` json\n{\n \"valid\": true,\n \"wmi\": \"1HG\",\n \"region\": \"North America\",\n \"model_years\": [\n 2003\n ]\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for a request without a VIN number, containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_INPUT\",\n \"message\": \"vin is required\"\n}\n\n ```" }, "response": [] } ], "description": "# 🚗 Vehicles\n\nThis directory contains the endpoints related to vehicle information, such as plate validation for multiple regions." }, { "name": "Documents", "item": [ { "name": "Brazil", "item": [ { "name": "CPF validation", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/documents/cpf/validate?cpf=123.456.789-09&return_format=false", "host": [ "{{Hostname}}" ], "path": [ "v1", "documents", "cpf", "validate" ], "query": [ { "key": "cpf", "value": "123.456.789-09", "description": "The CPF value. With out without the mask." }, { "key": "return_format", "value": "false", "description": "If the formatted (or digits only - the opposite of your argument) shall be returned in the response." } ] }, "description": "# 🪪 CPF validation\n\nThis endpoint provides a CPF (Cadastro de Pessoas Físicas) validation, providing a result informing if the provided CPF has a valid format and returning the formatted result, if applicable.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| cpf | String | Yes | | CNPJ value. | Can be formatted (e.g. `123.456.789-09` - or digits only - e.g. `12345678909`) |\n| return_format | Boolean | No | false | If true, will return the formatted value of the CPF digits only. | Returns the opposite format of the input. |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `GET`request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the validation status and the :\n\n##### With formatted input:\n\n``` json\n{\n \"valid\": true,\n \"digits\": \"12345678909\"\n}\n\n ```\n\n##### With digits-only input:\n\n``` json\n{\n \"valid\": true,\n \"formatted\": \"123.456.789-09\"\n}\n\n ```\n\n##### Invalid CPF:\n\n``` json\n{\n \"valid\": false\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for request without informing the CPF containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_INPUT\",\n \"message\": \"cpf parameter is required\"\n}\n\n ```\n\n### Notes\n\nThis endpoint does not validate if a CPF is active or if it does have a person linked to it, only if is a valid CPF format accordingly to the Brazilian guidelines." }, "response": [] }, { "name": "CPF validation", "request": { "method": "POST", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"cpf\": \"123.456.789-09\",\r\n \"return_format\": false\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/documents/cpf/validate", "host": [ "{{Hostname}}" ], "path": [ "v1", "documents", "cpf", "validate" ] }, "description": "# 🪪 CPF validation\n\nThis endpoint provides a CPF (Cadastro de Pessoas Físicas) validation, providing a result informing if the provided CPF has a valid format and returning the formatted result, if applicable.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| cpf | String | Yes | | CNPJ value. | Can be formatted (e.g. `123.456.789-09` - or digits only - e.g. `12345678909`) |\n| return_format | Boolean | No | false | If true, will return the formatted value of the CPF digits only. | Returns the opposite format of the input. |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `POST`request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the validation status and the :\n\n##### With formatted input:\n\n``` json\n{\n \"valid\": true,\n \"digits\": \"12345678909\"\n}\n\n ```\n\n##### With digits-only input:\n\n``` json\n{\n \"valid\": true,\n \"formatted\": \"123.456.789-09\"\n}\n\n ```\n\n##### Invalid CPF:\n\n``` json\n{\n \"valid\": false\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for request without informing the CPF containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_INPUT\",\n \"message\": \"cpf parameter is required\"\n}\n\n ```\n\n### Notes\n\nThis endpoint does not validate if a CPF is active or if it does have a person linked to it, only if is a valid CPF format accordingly to the Brazilian guidelines." }, "response": [] }, { "name": "CNPJ validation", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/documents/cnpj/validate?cnpj=00.000.000/0000-00&return_format=false", "host": [ "{{Hostname}}" ], "path": [ "v1", "documents", "cnpj", "validate" ], "query": [ { "key": "cnpj", "value": "00.000.000/0000-00", "description": "The CNPJ value. With out without the mask." }, { "key": "return_format", "value": "false", "description": "If the formatted (or digits only - the opposite of your argument) shall be returned in the response." } ] }, "description": "# 🪪 CNPJ validation\n\nThis endpoint provides a CNPJ (Cadastro Nacional de Pessoas Jurídicas) validation, providing a result informing if the provided CNPJ has a valid format and returning the formatted result, if applicable.\n\nThis endpoints support both the digits-only CNPJ and the newer alphanumeric CNPJ, introduced in 2026.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| cnpj | String | Yes | | CNPJ value. | Can be formatted (e.g. `00.000.000/0000-00` - or digits only - e.g. `00000000000000`) |\n| return_format | Boolean | No | false | If true, will return the formatted value of the CNPJ digits only. | Returns the opposite format of the input. |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `GET`request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the validation status and the :\n\n##### With formatted input:\n\n``` json\n{\n \"valid\": true,\n \"digits\": \"00000000000000\"\n}\n\n ```\n\n##### With digits-only input:\n\n``` json\n{\n \"valid\": true,\n \"formatted\": \"00.000.000/0000-00\"\n}\n\n ```\n\n##### Invalid CNPJ:\n\n``` json\n{\n \"valid\": false\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for request without informing the CNPJ containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_INPUT\",\n \"message\": \"cnpj parameter is required\"\n}\n\n ```\n\n### Notes\n\nThis endpoint does not validate if a CNPJ is active or if it does have a company linked to it, only if is a valid CNPJ format accordingly to the Brazilian guidelines." }, "response": [] }, { "name": "CNPJ validation", "request": { "method": "POST", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"cnpj\": \"00.000.000/0000-00\",\r\n \"return_format\": false\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/documents/cnpj/validate", "host": [ "{{Hostname}}" ], "path": [ "v1", "documents", "cnpj", "validate" ] }, "description": "# 🪪 CNPJ validation\n\nThis endpoint provides a CNPJ (Cadastro Nacional de Pessoas Jurídicas) validation, providing a result informing if the provided CNPJ has a valid format and returning the formatted result, if applicable.\n\nThis endpoints support both the digits-only CNPJ and the newer alphanumeric CNPJ, introduced in 2026.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| cnpj | String | Yes | | CNPJ value. | Can be formatted (e.g. `00.000.000/0000-00` - or digits only - e.g. `00000000000000`) |\n| return_format | Boolean | No | false | If true, will return the formatted value of the CNPJ digits only. | Returns the opposite format of the input. |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `POST`request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the validation status and the :\n\n##### With formatted input:\n\n``` json\n{\n \"valid\": true,\n \"digits\": \"00000000000000\"\n}\n\n ```\n\n##### With digits-only input:\n\n``` json\n{\n \"valid\": true,\n \"formatted\": \"00.000.000/0000-00\"\n}\n\n ```\n\n##### Invalid CNPJ:\n\n``` json\n{\n \"valid\": false\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for request without informing the CNPJ containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_INPUT\",\n \"message\": \"cnpj parameter is required\"\n}\n\n ```\n\n### Notes\n\nThis endpoint does not validate if a CNPJ is active or if it does have a company linked to it, only if is a valid CNPJ format accordingly to the Brazilian guidelines." }, "response": [] }, { "name": "PIS/Pasep validation", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/documents/pis/validate?pis=000.00000.00-0&return_format=false", "host": [ "{{Hostname}}" ], "path": [ "v1", "documents", "pis", "validate" ], "query": [ { "key": "pis", "value": "000.00000.00-0", "description": "The PIS/Pasep value. With out without the mask." }, { "key": "return_format", "value": "false", "description": "If the formatted (or digits only - the opposite of your argument) shall be returned in the response." } ] }, "description": "# 🪪 PIS/Pasep validation\n\nThis endpoint provides a PIS/Pasep (Programa de Integração Social / Programa de Formação do Patrimônio do Servidor Público) validation, providing a result informing if the provided PIS/Pasep has a valid format and returning the formatted result, if applicable.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| pis | String | Yes | | PIS/Pasep value. | Can be formatted (e.g. `000.00000.00-0` - or digits only - e.g. `00000000000`) |\n| return_format | Boolean | No | false | If true, will return the formatted value of the PIS/Pasep or digits only. | Returns the opposite format of the input. |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `GET`request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the validation status and the :\n\n##### With formatted input:\n\n``` json\n{\n \"valid\": true,\n \"digits\": \"00000000000\"\n}\n\n ```\n\n##### With digits-only input:\n\n``` json\n{\n \"valid\": true,\n \"formatted\": \"000.00000.00-0\"\n}\n\n ```\n\n##### Invalid PIS/Pasep:\n\n``` json\n{\n \"valid\": false\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for request without informing the PIS/Pasep containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_INPUT\",\n \"message\": \"pis parameter is required\"\n}\n\n ```\n\n### Notes\n\nThis endpoint does not validate if a PIS/Pasep is active or if it does have a person linked to it, only if is a valid PIS/Pasep format accordingly to the Brazilian guidelines." }, "response": [] }, { "name": "PIS/Pasep validation", "request": { "method": "POST", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"pis\": \"000.00000.00-0\",\r\n \"return_format\": false\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/documents/pis/validate", "host": [ "{{Hostname}}" ], "path": [ "v1", "documents", "pis", "validate" ] }, "description": "# 🪪 PIS/Pasep validation\n\nThis endpoint provides a PIS/Pasep (Programa de Integração Social / Programa de Formação do Patrimônio do Servidor Público) validation, providing a result informing if the provided PIS/Pasep has a valid format and returning the formatted result, if applicable.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| pis | String | Yes | | PIS/Pasep value. | Can be formatted (e.g. `000.00000.00-0` - or digits only - e.g. `00000000000`) |\n| return_format | Boolean | No | false | If true, will return the formatted value of the PIS/Pasep or digits only. | Returns the opposite format of the input. |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `POST`request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the validation status and the :\n\n##### With formatted input:\n\n``` json\n{\n \"valid\": true,\n \"digits\": \"00000000000\"\n}\n\n ```\n\n##### With digits-only input:\n\n``` json\n{\n \"valid\": true,\n \"formatted\": \"000.00000.00-0\"\n}\n\n ```\n\n##### Invalid PIS/Pasep:\n\n``` json\n{\n \"valid\": false\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for request without informing the PIS/Pasep containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_INPUT\",\n \"message\": \"pis parameter is required\"\n}\n\n ```\n\n### Notes\n\nThis endpoint does not validate if a PIS/Pasep is active or if it does have a person linked to it, only if is a valid PIS/Pasep format accordingly to the Brazilian guidelines." }, "response": [] } ], "description": "# 🪪 Brazilian documents\n\nThis directory contains the endpoints related to Brazilian document operations, such as CPF, CNPJ and PIS/Pasep." }, { "name": "USA", "item": [ { "name": "SSN validation", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/documents/ssn/validate?ssn=000-00-0000&return_format=false", "host": [ "{{Hostname}}" ], "path": [ "v1", "documents", "ssn", "validate" ], "query": [ { "key": "ssn", "value": "000-00-0000", "description": "The SSN value. With out without the dashes." }, { "key": "return_format", "value": "false", "description": "If the formatted (or digits only - the opposite of your argument) shall be returned in the response." } ] }, "description": "# 🪪 SSN validation\n\nThis endpoint provides a SSN (Social Security Number) validation, providing a result informing if the provided SSN has a valid format and returning the formatted result, if applicable.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| ssn | String | Yes | | SSN value. | Can be formatted (e.g. `000-00-0000` - or digits only - e.g. `000000000`) |\n| return_format | Boolean | No | false | If true, will return the formatted value of the SSN or digits only. | Returns the opposite format of the input. |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `GET`request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the validation status and the :\n\n##### With formatted input:\n\n``` json\n{\n \"valid\": true,\n \"digits\": \"000000000\"\n}\n\n ```\n\n##### With digits-only input:\n\n``` json\n{\n \"valid\": true,\n \"formatted\": \"000-00-0000\"\n}\n\n ```\n\n##### Invalid SSN:\n\n``` json\n{\n \"valid\": false\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for request without informing the SSN containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_INPUT\",\n \"message\": \"ssn parameter is required\"\n}\n\n ```\n\n### Notes\n\nThis endpoint does not validate if a SSN is active or if it does have a person linked to it, only if is a valid SSN format accordingly to the US guidelines." }, "response": [] }, { "name": "SSN validation", "request": { "method": "POST", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"ssn\": \"000-00-0000\",\r\n \"return_format\": false\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/documents/ssn/validate", "host": [ "{{Hostname}}" ], "path": [ "v1", "documents", "ssn", "validate" ] }, "description": "# 🪪 SSN validation\n\nThis endpoint provides a SSN (Social Security Number) validation, providing a result informing if the provided SSN has a valid format and returning the formatted result, if applicable.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| ssn | String | Yes | | SSN value. | Can be formatted (e.g. `000-00-0000` - or digits only - e.g. `000000000`) |\n| return_format | Boolean | No | false | If true, will return the formatted value of the SSN or digits only. | Returns the opposite format of the input. |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `POST`request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the validation status and the :\n\n##### With formatted input:\n\n``` json\n{\n \"valid\": true,\n \"digits\": \"000000000\"\n}\n\n ```\n\n##### With digits-only input:\n\n``` json\n{\n \"valid\": true,\n \"formatted\": \"000-00-0000\"\n}\n\n ```\n\n##### Invalid SSN:\n\n``` json\n{\n \"valid\": false\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for request without informing the SSN containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_INPUT\",\n \"message\": \"ssn parameter is required\"\n}\n\n ```\n\n### Notes\n\nThis endpoint does not validate if a SSN is active or if it does have a person linked to it, only if is a valid SSN format accordingly to the US guidelines." }, "response": [] }, { "name": "EIN validation", "request": { "method": "POST", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"ein\": \"00-0000000\",\r\n \"return_format\": false\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/documents/ein/validate", "host": [ "{{Hostname}}" ], "path": [ "v1", "documents", "ein", "validate" ] }, "description": "# 🪪 EIN validation\n\nThis endpoint provides a EIN (Employer Identification Number) validation, providing a result informing if the provided EIN has a valid format and returning the formatted result, if applicable.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| ein | String | Yes | | EIN value. | Can be formatted (e.g. `00-0000000` - or digits only - e.g. `000000000`) |\n| return_format | Boolean | No | false | If true, will return the formatted value of the EIN or digits only. | Returns the opposite format of the input. |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `POST` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the validation status and the :\n\n##### With formatted input:\n\n``` json\n{\n \"valid\": true,\n \"digits\": \"000000000\"\n}\n\n ```\n\n##### With digits-only input:\n\n``` json\n{\n \"valid\": true,\n \"formatted\": \"00-0000000\"\n}\n\n ```\n\n##### Invalid EIN:\n\n``` json\n{\n \"valid\": false\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for request without informing the EIN containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_INPUT\",\n \"message\": \"ein parameter is required\"\n}\n\n ```\n\n### Notes\n\nThis endpoint does not validate if a EIN is active or if it does have a company linked to it, only if is a valid EIN format accordingly to the US guidelines." }, "response": [] }, { "name": "EIN validation", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/documents/ein/validate?ein=00-0000000&return_format=false", "host": [ "{{Hostname}}" ], "path": [ "v1", "documents", "ein", "validate" ], "query": [ { "key": "ein", "value": "00-0000000", "description": "The EIN value. With out without the dash." }, { "key": "return_format", "value": "false", "description": "If the formatted (or digits only - the opposite of your argument) shall be returned in the response." } ] }, "description": "# 🪪 EIN validation\n\nThis endpoint provides a EIN (Employer Identification Number) validation, providing a result informing if the provided EIN has a valid format and returning the formatted result, if applicable.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| ein | String | Yes | | EIN value. | Can be formatted (e.g. `00-0000000` - or digits only - e.g. `000000000`) |\n| return_format | Boolean | No | false | If true, will return the formatted value of the EIN or digits only. | Returns the opposite format of the input. |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `GET` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the validation status and the :\n\n##### With formatted input:\n\n``` json\n{\n \"valid\": true,\n \"digits\": \"000000000\"\n}\n\n ```\n\n##### With digits-only input:\n\n``` json\n{\n \"valid\": true,\n \"formatted\": \"00-0000000\"\n}\n\n ```\n\n##### Invalid EIN:\n\n``` json\n{\n \"valid\": false\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for request without informing the EIN containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_INPUT\",\n \"message\": \"ein parameter is required\"\n}\n\n ```\n\n### Notes\n\nThis endpoint does not validate if a EIN is active or if it does have a company linked to it, only if is a valid EIN format accordingly to the US guidelines." }, "response": [] } ], "description": "# 🪪 USA documents\n\nThis directory contains the endpoints related to American document operations, such as SSN and EIN." }, { "name": "International", "item": [ { "name": "DUNS validation", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/documents/duns/validate?duns=00-000-0000&return_format=false", "host": [ "{{Hostname}}" ], "path": [ "v1", "documents", "duns", "validate" ], "query": [ { "key": "duns", "value": "00-000-0000", "description": "D-U-N-S number." }, { "key": "return_format", "value": "false", "description": "If the formatted (or digits only - the opposite of your argument) shall be returned in the response." } ] }, "description": "# 🪪 D-U-N-S validation\n\nThis endpoint provides a D-U-N-S (Data Universal Numbering System) validation, providing a result informing if the provided SSN has a valid format and returning the formatted result, if applicable.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| duns | String | Yes | | DUNS value. | Can be formatted (e.g. `00-000-0000` - or digits only - e.g. `00-000-0000`) |\n| return_format | Boolean | No | false | If true, will return the formatted value of the DUNS or digits only. | Returns the opposite format of the input. |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `GET`request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the\n\n##### With formatted input:\n\n``` json\n{\n \"valid\": true,\n \"digits\": \"000000000\"\n}\n\n ```\n\n##### With digits-only input:\n\n``` json\n{\n \"valid\": true,\n \"formatted\": \"00-000-0000\"\n}\n\n ```\n\n##### Invalid DUNS:\n\n``` json\n{\n \"valid\": false\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for request without informing the DUNS containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_INPUT\",\n \"message\": \"dunsparameter is required\"\n}\n\n ```\n\n### Notes\n\nThis endpoint does not validate if a DUNS is active or if it does have a company linked to it, only if is a valid DUNS format accordingly to its guidelines." }, "response": [] }, { "name": "DUNS validation", "request": { "method": "POST", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"duns\": \"00-000-0000\",\r\n \"return_format\": false\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/documents/duns/validate", "host": [ "{{Hostname}}" ], "path": [ "v1", "documents", "duns", "validate" ] }, "description": "# 🪪 D-U-N-S validation\n\nThis endpoint provides a D-U-N-S (Data Universal Numbering System) validation, providing a result informing if the provided SSN has a valid format and returning the formatted result, if applicable.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| duns | String | Yes | | DUNS value. | Can be formatted (e.g. `00-000-0000` - or digits only - e.g. `00-000-0000`) |\n| return_format | Boolean | No | false | If true, will return the formatted value of the DUNS or digits only. | Returns the opposite format of the input. |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `POST`request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, giving the\n\n##### With formatted input:\n\n``` json\n{\n \"valid\": true,\n \"digits\": \"000000000\"\n}\n\n ```\n\n##### With digits-only input:\n\n``` json\n{\n \"valid\": true,\n \"formatted\": \"00-000-0000\"\n}\n\n ```\n\n##### Invalid DUNS:\n\n``` json\n{\n \"valid\": false\n}\n\n ```\n\n#### Error responses\n\nError responses will provide a `4xx` response code, like `400 Bad Request` for request without informing the DUNS containing an error code enumerator and a human-readable message:\n\n``` json\n{\n \"code\": \"INVALID_INPUT\",\n \"message\": \"dunsparameter is required\"\n}\n\n ```\n\n### Notes\n\nThis endpoint does not validate if a DUNS is active or if it does have a company linked to it, only if is a valid DUNS format accordingly to its guidelines." }, "response": [] } ], "description": "# 🪪 International documents\n\nThis directory contains the endpoints related to international document operations, such as DUNS." } ], "description": "# 🪪 Documents\n\nThis directory contains the endpoints related to document operations, such as CPF, CNPJ, SSN and EIN validations, supporting common Brazilian and American formats." }, { "name": "Health check", "item": [ { "name": "Health check status", "request": { "method": "GET", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "url": { "raw": "{{Hostname}}/health", "host": [ "{{Hostname}}" ], "path": [ "health" ] }, "description": "# 🩺 Health check\n\nThis endpoint provides a health check, returning `200 OK` for successful responses, with no body." }, "response": [] } ], "description": "# 🩺 Health check\n\nThis folder contain the health-related endpoints, which can be used to verify if the API service is available." }, { "name": "Networking", "item": [ { "name": "Known ports", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/net/ports?page=1&per_page=10", "host": [ "{{Hostname}}" ], "path": [ "v1", "net", "ports" ], "query": [ { "key": "page", "value": "1", "description": "The page number to be returned." }, { "key": "per_page", "value": "10", "description": "Results per page." } ] }, "description": "# 🌐 Well known ports\n\nThis endpoint provides a list of well known ports uses.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| page | Integer | No | 1 | Page number | |\n| per_page | Integer | No | 10 | Results per page | Maximum of 100 |\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, with the page number, per page results, and a port object containing the port number, status, and an assignment object with its service, protocol, description, list of plataforms and category. Besides that, the total results and total pages will also be returned:\n\n``` json\n{\n \"page\": 1,\n \"per_page\": 2,\n \"ports\": [\n {\n \"port\": 20,\n \"status\": \"WELL-KNOWN\",\n \"assignment\": {\n \"service\": \"FTP-DATA\",\n \"protocol\": \"TCP\",\n \"description\": \"File Transfer Protocol (Data)\",\n \"platforms\": [\n \"ALL\"\n ],\n \"category\": \"FILE-TRANSFER\"\n }\n },\n {\n \"port\": 21,\n \"status\": \"WELL-KNOWN\",\n \"assignment\": {\n \"service\": \"FTP\",\n \"protocol\": \"TCP\",\n \"description\": \"File Transfer Protocol\",\n \"platforms\": [\n \"ALL\"\n ],\n \"category\": \"FILE-TRANSFER\",\n \"security_note\": \"Unencrypted - consider SFTP or FTPS\"\n }\n }\n ],\n \"total\": 43,\n \"total_pages\": 22\n}\n\n ```\n\nPossible values for these enumerators are:\n\n1. `status`: `WELL-KNOWN` (port range 0-1023), `REGISTERED` (port range 1024-49151) and `DYNAMIC` (port range 49152-65535);\n \n2. `service`: `FTP-DATA`, `FTP`, `SSH`, `TELNET`, `SMTP`, `DHCP`, `HTTP`, `POP3`, `RPC`, `NETBIOS`, `IMAP`, `SNMP`, `LDAP`, `HTTPS`, `SMB`, `SMTPS`, `SYSLOG`, `IMAPS`, `POP3S`, `MSSQL`, `ORACLE`, `MYSQL`, `RDP`, `POSTGRESQL`, `AMQP`, `MDNS`, `REDIS`, `HTTP-ALT`, `JUPYTER`, `ELASTICSEARCH`, `MONGODB`, `VNC`, `EXPRESS`, `ANGULAR`, `FLASK` and `SONARQUBE`;\n \n3. `protocol`: `TCP`, `UDP` and `TCP/UDP`;\n \n4. `platforms`: `ALL`, `WINDOWS` and `MACOS`;\n \n5. `category`: `WEB`, `DATABASE`, `MAIL`, `FILE-TRANSFER`, `REMOTE-ACCESS`, `MESSAGING`, `SECURITY`, `SYSTEM`, `GAME` and `OTHER`.\n \n\n#### Error responses\n\nThis endpoint has no error returns." }, "response": [] }, { "name": "Port information", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/net/ports/{{port}}", "host": [ "{{Hostname}}" ], "path": [ "v1", "net", "ports", "{{port}}" ] }, "description": "# 🌐 Port information\n\nThis endpoint provides a well known information for given port.\n\n### Variables\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| port | Integer | Yes | | Port number. | This is provided in the URL path itself. |\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, with the page number, per page results, and a port object containing the port number, status, and an assignment object with its service, protocol, description, list of plataforms and category. Besides that, the total results and total pages will also be returned:\n\n``` json\n{\n \"port\": 22,\n \"reserved\": true,\n \"status\": \"WELL-KNOWN\",\n \"assignments\": [\n {\n \"service\": \"SSH\",\n \"protocol\": \"TCP\",\n \"description\": \"Secure Shell\",\n \"platforms\": [\n \"ALL\"\n ],\n \"category\": \"REMOTE-ACCESS\"\n }\n ]\n}\n\n ```\n\nPossible values for these enumerators are:\n\n1. `status`: `WELL-KNOWN` (port range 0-1023), `REGISTERED` (port range 1024-49151) and `DYNAMIC` (port range 49152-65535);\n \n2. `service`: `FTP-DATA`, `FTP`, `SSH`, `TELNET`, `SMTP`, `DHCP`, `HTTP`, `POP3`, `RPC`, `NETBIOS`, `IMAP`, `SNMP`, `LDAP`, `HTTPS`, `SMB`, `SMTPS`, `SYSLOG`, `IMAPS`, `POP3S`, `MSSQL`, `ORACLE`, `MYSQL`, `RDP`, `POSTGRESQL`, `AMQP`, `MDNS`, `REDIS`, `HTTP-ALT`, `JUPYTER`, `ELASTICSEARCH`, `MONGODB`, `VNC`, `EXPRESS`, `ANGULAR`, `FLASK` and `SONARQUBE`;\n \n3. `protocol`: `TCP`, `UDP` and `TCP/UDP`;\n \n4. `platforms`: `ALL`, `WINDOWS` and `MACOS`;\n \n5. `category`: `WEB`, `DATABASE`, `MAIL`, `FILE-TRANSFER`, `REMOTE-ACCESS`, `MESSAGING`, `SECURITY`, `SYSTEM`, `GAME` and `OTHER`.\n \n\n#### Error responses\n\nThis endpoint has no error returns." }, "response": [] }, { "name": "URL validation", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/net/url/validate?url=https://google.com", "host": [ "{{Hostname}}" ], "path": [ "v1", "net", "url", "validate" ], "query": [ { "key": "url", "value": "https://google.com", "description": "The URL to validate" } ] }, "description": "# 🌐 URL verification\n\nThis endpoint validates a provided URL.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| url | String | Yes | | The URL to validate. | |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `GET` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, validation status:\n\n``` json\n{\n \"valid\": true\n}\n\n\n ```\n\n#### Error responses\n\nThis endpoint has no error returns." }, "response": [] }, { "name": "URL validation", "request": { "method": "POST", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"url\": \"http://google.com\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/net/url/validate", "host": [ "{{Hostname}}" ], "path": [ "v1", "net", "url", "validate" ] }, "description": "# 🌐 URL verification\n\nThis endpoint validates a provided URL.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| url | String | Yes | | The URL to validate. | |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `POST` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, validation status:\n\n``` json\n{\n \"valid\": true\n}\n\n ```\n\n#### Error responses\n\nThis endpoint has no error returns." }, "response": [] }, { "name": "IP validation", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/net/ip/validate?ip=192.168.1.1", "host": [ "{{Hostname}}" ], "path": [ "v1", "net", "ip", "validate" ], "query": [ { "key": "ip", "value": "192.168.1.1", "description": "The IP address to validate" } ] }, "description": "# 🌐 IP address verification\n\nThis endpoint validates a provided IPv4 or IPv6 address and return information to it.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| ip | String | Yes | | The IPv4 or IPv6 address to validate. | |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `GET` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, validation status alongside its information:\n\n``` json\n{\n \"valid\": true,\n \"version\": \"IPv4\",\n \"classification\": {\n \"scope\": \"private\",\n \"is_private\": true,\n \"is_public\": false,\n \"is_loopback\": false,\n \"is_link_local\": false,\n \"is_multicast\": false,\n \"is_broadcast\": false,\n \"is_documentation\": false,\n \"is_reserved\": false,\n \"is_unspecified\": false\n },\n \"representation\": {\n \"canonical\": \"192.168.1.1\",\n \"reverse_dns\": \"1.1.168.192.in-addr.arpa\",\n \"binary\": \"11000000.10101000.00000001.00000001\",\n \"hex\": \"C0A80101\",\n \"integer\": \"3232235777\"\n }\n}\n\n ```\n\n_Note that the scope can be_ `_public_` _or_ `_private_`_, and the version can be_ `_IPv4_` _or_ `_IPv6_`_._\n\n#### Error responses\n\nThis endpoint has no error returns." }, "response": [] }, { "name": "IP validation", "request": { "method": "POST", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"ip\": \"192.168.1.1\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/net/ip/validate", "host": [ "{{Hostname}}" ], "path": [ "v1", "net", "ip", "validate" ] }, "description": "# 🌐 IP address verification\n\nThis endpoint validates a provided IPv4 or IPv6 address and return information to it.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| ip | String | Yes | | The IPv4 or IPv6 address to validate. | |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `POST` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, validation status alongside its information:\n\n``` json\n{\n \"valid\": true,\n \"version\": \"IPv4\",\n \"classification\": {\n \"scope\": \"private\",\n \"is_private\": true,\n \"is_public\": false,\n \"is_loopback\": false,\n \"is_link_local\": false,\n \"is_multicast\": false,\n \"is_broadcast\": false,\n \"is_documentation\": false,\n \"is_reserved\": false,\n \"is_unspecified\": false\n },\n \"representation\": {\n \"canonical\": \"192.168.1.1\",\n \"reverse_dns\": \"1.1.168.192.in-addr.arpa\",\n \"binary\": \"11000000.10101000.00000001.00000001\",\n \"hex\": \"C0A80101\",\n \"integer\": \"3232235777\"\n }\n}\n\n ```\n\n_Note that the scope can be_ `_public_` _or_ `_private_`_, and the version can be_ `_IPv4_` _or_ `_IPv6_`_._\n\n#### Error responses\n\nThis endpoint has no error returns." }, "response": [] }, { "name": "CIDR validation", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/net/ip/cidr?cidr=192.168.1.0/24", "host": [ "{{Hostname}}" ], "path": [ "v1", "net", "ip", "cidr" ], "query": [ { "key": "cidr", "value": "192.168.1.0/24", "description": "The CIDR to be validated." } ] }, "description": "# 🌐 CIDR verification\n\nThis endpoint validates a provided CIDR and return information from it.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| cidr | String | Yes | | The CIDR to validate. | |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `GET` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, validation status alongside its information:\n\n``` json\n{\n \"valid\": true,\n \"network\": \"192.168.1.0\",\n \"broadcast\": \"192.168.1.255\",\n \"mask\": \"255.255.255.0\",\n \"prefix_length\": 24,\n \"host_count\": 254,\n \"usable_range\": {\n \"first\": \"192.168.1.1\",\n \"last\": \"192.168.1.254\"\n },\n \"classification\": {\n \"scope\": \"private\",\n \"is_private\": true,\n \"is_public\": false,\n \"is_loopback\": false,\n \"is_link_local\": false,\n \"is_multicast\": false,\n \"is_broadcast\": false,\n \"is_documentation\": false,\n \"is_reserved\": false,\n \"is_unspecified\": false\n }\n}\n\n ```\n\n_Note that the scope can be_ `public` _or_ `private`_, and the version can be_ `IPv4` _or_ `IPv6`_._\n\n#### Error responses\n\nThis endpoint has no error returns." }, "response": [] }, { "name": "CIDR validation", "request": { "method": "POST", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"cidr\": \"192.168.1.0/24\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/net/ip/cidr", "host": [ "{{Hostname}}" ], "path": [ "v1", "net", "ip", "cidr" ] }, "description": "# 🌐 CIDR verification\n\nThis endpoint validates a provided CIDR and return information from it.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| cidr | String | Yes | | The CIDR to validate. | |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `POST` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, validation status alongside its information:\n\n``` json\n{\n \"valid\": true,\n \"network\": \"192.168.1.0\",\n \"broadcast\": \"192.168.1.255\",\n \"mask\": \"255.255.255.0\",\n \"prefix_length\": 24,\n \"host_count\": 254,\n \"usable_range\": {\n \"first\": \"192.168.1.1\",\n \"last\": \"192.168.1.254\"\n },\n \"classification\": {\n \"scope\": \"private\",\n \"is_private\": true,\n \"is_public\": false,\n \"is_loopback\": false,\n \"is_link_local\": false,\n \"is_multicast\": false,\n \"is_broadcast\": false,\n \"is_documentation\": false,\n \"is_reserved\": false,\n \"is_unspecified\": false\n }\n}\n\n ```\n\n_Note that the scope can be_ `public` _or_ `private`_, and the version can be_ `IPv4` _or_ `IPv6`_._\n\n#### Error responses\n\nThis endpoint has no error returns." }, "response": [] }, { "name": "CIDR IP range validation", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/net/ip/contains?cidr=192.168.1.0/24&ip=192.168.1.1", "host": [ "{{Hostname}}" ], "path": [ "v1", "net", "ip", "contains" ], "query": [ { "key": "cidr", "value": "192.168.1.0/24", "description": "The CIDR to be validated." }, { "key": "ip", "value": "192.168.1.1", "description": "The IP address to be validated if withing the CIDR range." } ] }, "description": "# 🌐 CIDR IP range validation\n\nThis endpoint validates if a provided IP address is within a CIDR range.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| cidr | String | Yes | | The CIDR to validate. | |\n| ip | String | Yes | | The IP address to be validated if within the CIDR range. | |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `GET` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, validation status:\n\n``` json\n{\n \"contains\": true\n}\n\n ```\n\n#### Error responses\n\nThis endpoint has no error returns." }, "response": [] }, { "name": "CIDR IP range validation Copy", "request": { "method": "POST", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"cidr\": \"192.168.1.0/24\",\r\n \"ip\": \"192.168.1.1\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/net/ip/contains", "host": [ "{{Hostname}}" ], "path": [ "v1", "net", "ip", "contains" ] }, "description": "# 🌐 CIDR IP range validation\n\nThis endpoint validates if a provided IP address is within a CIDR range.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| cidr | String | Yes | | The CIDR to validate. | |\n| ip | String | Yes | | The IP address to be validated if within the CIDR range. | |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `POST` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, validation status:\n\n``` json\n{\n \"contains\": true\n}\n\n ```\n\n#### Error responses\n\nThis endpoint has no error returns." }, "response": [] } ], "description": "# 🌐 Networking & web\n\nThis directory contains the endpoints related to network and web-related operations, such as IPv4 and IPv6 validation." }, { "name": "Operating systems", "item": [ { "name": "Path characters", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/os/path-chars?os=all&character=/", "host": [ "{{Hostname}}" ], "path": [ "v1", "os", "path-chars" ], "query": [ { "key": "os", "value": "all", "description": "Operating system to check." }, { "key": "character", "value": "/", "description": "Character to check." } ] }, "description": "# 🖥️ Path character verification\n\nThis endpoint validates if a character is accepted or not in a file path for an operating system, supporting Microsoft Windows, Apple macOS and Linux distributions.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| os | String | No | all | The operating system to check. | Can be `all`, `windows`, `macos` or `linux`. |\n| character | String | No | | The character to check. | If not set, the endpoint will return all invalid characters for given OS. |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `GET` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, with the validation for the requested OS (or all) and the character information:\n\n##### With character specified:\n\n``` json\n{\n \"character\": \"/\",\n \"platforms\": {\n \"linux\": {\n \"invalid_in_filenames\": true,\n \"invalid_in_paths\": false\n },\n \"macos\": {\n \"invalid_in_filenames\": true,\n \"invalid_in_paths\": false\n },\n \"windows\": {\n \"invalid_in_filenames\": true,\n \"invalid_in_paths\": false\n }\n }\n}\n\n ```\n\n##### Without specifying a character:\n\n``` json\n{\n \"platforms\": {\n \"linux\": {\n \"invalid_in_filenames\": [\n \"/\",\"\"\n ],\n \"invalid_in_paths\": [\"\"\n ,\n \"reserved_names\": [],\n \"max_path_length\": 4096,\n \"max_filename_length\": 255,\n \"case_sensitive\": true,\n \"path_separator\": \"/\",\n \"notes\": [\n \"Almost any byte except / and null is valid\",\n \"Hidden files begin with a dot (.) by convention\"\n ]\n },\n \"macos\": {\n \"invalid_in_filenames\": [\n \"/\",\n \":\",\"\"\n ],\n \"invalid_in_paths\": [\"\"\n ],\n \"reserved_names\": [],\n \"max_path_length\": 1024,\n \"max_filename_length\": 255,\n \"case_sensitive\": false,\n \"case_sensitive_note\": \"Default HFS+/APFS is case-insensitive but case-preserving; case-sensitive variant exists\",\n \"path_separator\": \"/\",\n \"notes\": [\n \"Colon (:) is the historical Mac path separator and is mapped to / in Finder displays\"\n ]\n },\n \"windows\": {\n \"invalid_in_filenames\": [\n \"\\\\\",\n \"/\",\n \":\",\n \"*\",\n \"?\",\n \"\\\"\",\n \"<\",\n \">\",\n \"|\"\n ],\n \"invalid_in_paths\": [\n \"*\",\n \"?\",\n \"\\\"\",\n \"<\",\n \">\",\n \"|\"\n ],\n \"reserved_names\": [\n \"CON\",\n \"PRN\",\n \"AUX\",\n \"NUL\",\n \"COM0\",\n \"COM1\",\n \"COM2\",\n \"COM3\",\n \"COM4\",\n \"COM5\",\n \"COM6\",\n \"COM7\",\n \"COM8\",\n \"COM9\",\n \"LPT0\",\n \"LPT1\",\n \"LPT2\",\n \"LPT3\",\n \"LPT4\",\n \"LPT5\",\n \"LPT6\",\n \"LPT7\",\n \"LPT8\",\n \"LPT9\"\n ],\n \"reserved_names_note\": \"These names are reserved regardless of extension (e.g. NUL.txt is also invalid)\",\n \"max_path_length\": 260,\n \"max_path_length_note\": \"Can be extended to 32767 with LongPathsEnabled registry key on Windows 10+\",\n \"max_filename_length\": 255,\n \"case_sensitive\": false,\n \"path_separator\": \"\\\\\",\n \"also_accepts_separator\": \"/\",\n \"notes\": [\n \"Trailing spaces and dots in filenames are silently stripped\",\n \"Leading/trailing spaces in path segments are invalid\"\n ]\n }\n }\n}\n\n ```\n\n#### Error responses\n\nThis endpoint has no error returns." }, "response": [] }, { "name": "Path characters", "request": { "method": "POST", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"os\": \"all\",\r\n \"character\": \"/\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/os/path-chars", "host": [ "{{Hostname}}" ], "path": [ "v1", "os", "path-chars" ] }, "description": "# 🖥️ Path character verification\n\nThis endpoint validates if a character is accepted or not in a file path for an operating system, supporting Microsoft Windows, Apple macOS and Linux distributions.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| os | String | No | all | The operating system to check. | Can be `all`, `windows`, `macos` or `linux`. |\n| character | String | No | | The character to check. | If not set, the endpoint will return all invalid characters for given OS. |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `POST` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, with the validation for the requested OS (or all) and the character information:\n\n##### With character specified:\n\n``` json\n{\n \"character\": \"/\",\n \"platforms\": {\n \"linux\": {\n \"invalid_in_filenames\": true,\n \"invalid_in_paths\": false\n },\n \"macos\": {\n \"invalid_in_filenames\": true,\n \"invalid_in_paths\": false\n },\n \"windows\": {\n \"invalid_in_filenames\": true,\n \"invalid_in_paths\": false\n }\n }\n}\n\n ```\n\n##### Without specifying a character:\n\n``` json\n{\n \"platforms\": {\n \"linux\": {\n \"invalid_in_filenames\": [\n \"/\",\"\"\n ],\n \"invalid_in_paths\": [\"\"\n ,\n \"reserved_names\": [],\n \"max_path_length\": 4096,\n \"max_filename_length\": 255,\n \"case_sensitive\": true,\n \"path_separator\": \"/\",\n \"notes\": [\n \"Almost any byte except / and null is valid\",\n \"Hidden files begin with a dot (.) by convention\"\n ]\n },\n \"macos\": {\n \"invalid_in_filenames\": [\n \"/\",\n \":\",\"\"\n ],\n \"invalid_in_paths\": [\"\"\n ],\n \"reserved_names\": [],\n \"max_path_length\": 1024,\n \"max_filename_length\": 255,\n \"case_sensitive\": false,\n \"case_sensitive_note\": \"Default HFS+/APFS is case-insensitive but case-preserving; case-sensitive variant exists\",\n \"path_separator\": \"/\",\n \"notes\": [\n \"Colon (:) is the historical Mac path separator and is mapped to / in Finder displays\"\n ]\n },\n \"windows\": {\n \"invalid_in_filenames\": [\n \"\\\\\",\n \"/\",\n \":\",\n \"*\",\n \"?\",\n \"\\\"\",\n \"<\",\n \">\",\n \"|\"\n ],\n \"invalid_in_paths\": [\n \"*\",\n \"?\",\n \"\\\"\",\n \"<\",\n \">\",\n \"|\"\n ],\n \"reserved_names\": [\n \"CON\",\n \"PRN\",\n \"AUX\",\n \"NUL\",\n \"COM0\",\n \"COM1\",\n \"COM2\",\n \"COM3\",\n \"COM4\",\n \"COM5\",\n \"COM6\",\n \"COM7\",\n \"COM8\",\n \"COM9\",\n \"LPT0\",\n \"LPT1\",\n \"LPT2\",\n \"LPT3\",\n \"LPT4\",\n \"LPT5\",\n \"LPT6\",\n \"LPT7\",\n \"LPT8\",\n \"LPT9\"\n ],\n \"reserved_names_note\": \"These names are reserved regardless of extension (e.g. NUL.txt is also invalid)\",\n \"max_path_length\": 260,\n \"max_path_length_note\": \"Can be extended to 32767 with LongPathsEnabled registry key on Windows 10+\",\n \"max_filename_length\": 255,\n \"case_sensitive\": false,\n \"path_separator\": \"\\\\\",\n \"also_accepts_separator\": \"/\",\n \"notes\": [\n \"Trailing spaces and dots in filenames are silently stripped\",\n \"Leading/trailing spaces in path segments are invalid\"\n ]\n }\n }\n}\n\n ```\n\n#### Error responses\n\nThis endpoint has no error returns." }, "response": [] }, { "name": "Path validation", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/os/path-chars/validate?path=/toolset/api>&os=windows&type=path", "host": [ "{{Hostname}}" ], "path": [ "v1", "os", "path-chars", "validate" ], "query": [ { "key": "path", "value": "/toolset/api>", "description": "Path to validate." }, { "key": "os", "value": "windows", "description": "Operating system to check." }, { "key": "type", "value": "path", "description": "Whether the path point to a file or not." } ] }, "description": "# 🖥️ Path verification\n\nThis endpoint validates a provided file path for Microsoft Windows, Apple macOS and/or Linux-based systems.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| path | String | Yes | | The path to validate. | |\n| os | String | No | all | The operating system to check. | Can be `all`, `windows`, `macos` or `linux`. |\n| type | String | No | path | If the provided path relate to a file name or not. | Can be `path` or `filename`. |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `GET` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, with the validation for the requested path, including the platform, all the detected violations in the path (if any) and if the path has a reserved name:\n\n##### Without specifying a platform\n\n``` json\n{\n \"linux\": {\n \"valid\": true,\n \"violations\": [],\n \"is_reserved_name\": false\n },\n \"macos\": {\n \"valid\": true,\n \"violations\": [],\n \"is_reserved_name\": false\n },\n \"windows\": {\n \"valid\": false,\n \"violations\": [\n {\n \"character\": \">\",\n \"position\": 12\n }\n ],\n \"is_reserved_name\": false\n }\n}\n\n ```\n\n##### Specifying a platform\n\n``` json\n{\n \"windows\": {\n \"valid\": false,\n \"violations\": [\n {\n \"character\": \">\",\n \"position\": 12\n }\n ],\n \"is_reserved_name\": false\n }\n}\n\n ```\n\n#### Error responses\n\nThis endpoint has no error returns." }, "response": [] }, { "name": "Path validation", "request": { "method": "POST", "header": [ { "key": "X-RapidAPI-Host", "value": "{{RapidApiHost}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"path\": \"/toolset/api>\",\r\n \"os\": \"windows\",\r\n \"type\": \"path\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{Hostname}}/v1/os/path-chars/validate", "host": [ "{{Hostname}}" ], "path": [ "v1", "os", "path-chars", "validate" ] }, "description": "# 🖥️ Path verification\n\nThis endpoint validates a provided file path for Microsoft Windows, Apple macOS and/or Linux-based systems.\n\n### Arguments\n\n| **Name** | **Type** | **Required** | **Default value** | **Description** | **More information** |\n| --- | --- | --- | --- | --- | --- |\n| path | String | Yes | | The path to validate. | |\n| os | String | No | all | The operating system to check. | Can be `all`, `windows`, `macos` or `linux`. |\n| type | String | No | path | If the provided path relate to a file name or not. | Can be `path` or `filename`. |\n\n### Verb\n\nThis endpoint accepts both `GET` and `POST` verbs. This variation demonstrates the `POST` request.\n\n### Result\n\nThe successful result will return a `200 OK` response, with the following JSON body, with the validation for the requested path, including the platform, all the detected violations in the path (if any) and if the path has a reserved name:\n\n##### Without specifying a platform\n\n``` json\n{\n \"linux\": {\n \"valid\": true,\n \"violations\": [],\n \"is_reserved_name\": false\n },\n \"macos\": {\n \"valid\": true,\n \"violations\": [],\n \"is_reserved_name\": false\n },\n \"windows\": {\n \"valid\": false,\n \"violations\": [\n {\n \"character\": \">\",\n \"position\": 12\n }\n ],\n \"is_reserved_name\": false\n }\n}\n\n ```\n\n##### Specifying a platform\n\n``` json\n{\n \"windows\": {\n \"valid\": false,\n \"violations\": [\n {\n \"character\": \">\",\n \"position\": 12\n }\n ],\n \"is_reserved_name\": false\n }\n}\n\n ```\n\n#### Error responses\n\nThis endpoint has no error returns." }, "response": [] } ], "description": "# 🖥️ Operating systems\n\nThis directory contains the endpoints related to operating systems, such as path rules and validations." } ], "auth": { "type": "apikey", "apikey": [ { "key": "value", "value": "{{RapidApiKey}}", "type": "string" }, { "key": "key", "value": "X-RapidAPI-Key", "type": "string" } ] }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "packages": {}, "requests": {}, "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "packages": {}, "requests": {}, "exec": [ "" ] } } ], "variable": [ { "key": "RapidApiKey", "value": "", "description": "Your RapidAPI key." }, { "key": "RapidApiHost", "value": "", "description": "The RapidAPI hostname used." }, { "key": "Hostname", "value": "http://localhost:8080", "description": "The API hostname." } ] }