Apptigent PowerTools
Apptigent PowerTools Professional is a powerful suite of essential utilities for enterprise workflow, forms and cloud applications. Manipulate text, modify collections, format dates and times, convert currency, perform advanced mathematical calculations, shorten URL's, encode strings, convert text to speech, translate content into multiple languages, and more. PowerTools is the ultimate process automation toolkit for Microsoft Power Platform.
This connector is available in the following products and regions:
Service | Class | Regions |
---|---|---|
Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Contact | |
---|---|
Name | Customer Support |
URL | https://www.apptigent.com/help/ |
support@apptigent.com |
Connector Metadata | |
---|---|
Publisher | Apptigent |
Website | https://www.apptigent.com |
Privacy policy | https://www.apptigent.com/help/privacy-policy/ |
Categories | Productivity |
Create user-driven solutions that solve everyday business problems in a fraction of the time with the ultimate toolkit for Power Platform professionals. Redact a sensitive document, localize currencies and dates, translate text into multiple languages, perform advanced calculations, convert text to speech and more with only a few clicks. PowerTools PRO eliminates the need for complex expression syntax and formulas, putting the power to build advanced solutions back in the hands of business users. Increase productivity, reduce delivery time and accelerate adoption with a powerful set of utilities designed to supercharge no-code apps, forms and workflows.
Prerequisites
Create an account and subscribe to PowerTools Professional Edition. Plans start at only $49 a month and scale to fit every budget. Learn more at https://portal.apptigent.com.
How to get credentials
Generate an API key by following these simple steps:
- Open https://portal.apptigent.com in your browser, click "Create an account" and follow the prompts.
- Login with your new credentials and select the "Apps" link from the main menu.
- Click the "Create new App" button.
- Enter a Title and optional description (such as "Power Automate App") then click "Submit".
- Upon successful submission, the App details page will be shown with your new credentials. Click the "Show" checkbox next to the Client ID field and copy the value - this is the key you will use in the "API Key" field to authorize a new connector.
- Browse to "API Products", select "PowerTools Professional", then click Subscribe under any paid plan (contact support for Enterprise and custom billing arrangements).
- Select the app name created in Step 4 and click "Subscribe" to finish.
Known issues and limitations
Professional Edition plans range from 100 - 5,000 action calls per day. Visit our Subscriptions page at https://www.apptigent.com/solutions/power-tools/subscription-plans/ to learn more about plan limits.
** SPECIAL OFFER FOR MICROSOFT MVP's **
Once registered, select the drop-down menu next to your user name and click "My Organization". Edit the organization name and add your MVP ID. Then navigate to subscriptions and select the "MVP" plan for a FREE PRO 100 subscription. You will receive an email confirming your benefit within 48 hours. You may then begin using your app Client ID in your Power Platform subscriptions (NOTE: for personal use only, not valid for customer, client or commercial purposes).
Creating a connection
The connector supports the following authentication types:
Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
Name | Type | Description | Required |
---|---|---|---|
License Key | securestring | The PowerTools License Key | True |
Throttling Limits
Name | Calls | Renewal Period |
---|---|---|
API calls per connection | 100 | 60 seconds |
Actions
Collections - Add to collection |
Add an item to a collection |
Collections - Collection to JSON |
Convert a collection to a named JSON object |
Collections - Collection to XML |
Convert a collection to an XML string |
Collections - Contains number |
Determine if a collection contains a specific number |
Collections - Contains string |
Determine if any items in a collection contain a specific string |
Collections - Count collection |
Count a collection of items |
Collections - Ends with string |
Determine if any items in a collection end with a specific string |
Collections - Filter collection |
Filter a collection of strings by keyword |
Collections - Join Collection |
Join a collection of strings |
Collections - Remove duplicates from collection |
Remove duplicate items from a collection |
Collections - Remove from collection |
Remove an item from a collection |
Collections - Replace values in collection |
Replace whole or partial strings in a collection |
Collections - Sort collection |
Sort a collection of strings |
Collections - Split collection |
Split a collection of items by matching value or index |
Collections - Starts with string |
Determine if any items in a collection start with a specific string |
Currency - Convert currency |
Calculate monetary value in a different currency |
Currency - Format currency |
Apply currency symbol to a numeric value |
Data - CSV to JSON |
Convert a CSV string to a JSON array |
Data - CSV to XML |
Convert a CSV string to an XML string |
Data - Filter CSV |
Filter a comma-delimited string using field names and/or regular expressions |
Data - Format JSON |
Format a string of JSON data |
Data - JSON to CSV |
Convert a JSON array to CSV string |
Data - JSON to HTML Table |
Convert a JSON array to an HTML table |
Data - JSON to XML |
Convert a JSON object to an XML string |
Data - Query JSON |
Query a JSON object using a JSONPath expression |
Data - Query XML |
Query an XML string using an XPath expression |
Data - Validate JSON |
Determine if a JSON string represents a valid data object |
Data - XML to JSON |
Convert an XML string to a JSON object |
Date |
Calculate the difference between two dates |
Date |
Create a date/time string in a specific format |
Date |
Retrieve useful date and time information, such as day of year, total seconds and ticks |
Date |
Convert date and time from one time zone to another |
Files - Composite Image |
Insert a foreground image in front of a background image |
Files - Compress File |
Compress a file (20MB max) |
Files - Convert Image |
Convert an image from one format to another |
Files - Crop Image |
Crop an image |
Files - File to string |
Convert a file to a Base64 string |
Files - Flip Image |
Flip an image (horizontal or vertical) |
Files - Generate QR code |
Generate a QR code image |
Files - Image Metadata |
Retrieve EXIF metadata from an image |
Files - Moderate Image |
Scan image for adult or obscene content |
Files - Reduce Image Quality |
Reduce the quality of an image |
Files - Remove Image Metadata |
Remove the EXIF and IPTC profile data from an image |
Files - Resize Image |
Resize an image |
Files - Rotate Image |
Rotate an image by specified number of degrees |
Files - Watermark Image |
Add watermark text to an image |
Finance - Market index |
Get current and historical market index information |
Finance - Stock prices |
Get current and historical stock price information |
Maps - IP Location |
Physical location of an IP address |
Maps - Map Coordinates |
Retrieve the approximate latitude/longitude matching a full or partial address |
Maps - Map Image |
Generate a map image from an address |
Maps - Map Timezone |
Get timezone information from an address |
Math - Calculate Absolute |
Calculate the absolute value of a number |
Math - Calculate Addition |
Calculate the sum of two numbers |
Math - Calculate average |
Calculate the average of two or more numbers |
Math - Calculate Cosine |
Calculate the cosine value of an angle |
Math - Calculate Division |
Calculate the quotient of two numbers |
Math - Calculate Logarithm |
Calculate the logarithm of a number |
Math - Calculate median |
Calculate the median of two or more numbers |
Math - Calculate minimum or maximum |
Calculate the minimum or maximum value in a sequence of numbers |
Math - Calculate Modulo |
Calculate the remainder of dividing two numbers |
Math - Calculate Multiplication |
Calculate the product of two numbers |
Math - Calculate Nth Root |
Calculate the n-th root of a number |
Math - Calculate power |
Raise number to a specified power |
Math - Calculate Sine |
Calculate the sine value of an angle |
Math - Calculate Square Root |
Calculate the square root of a number |
Math - Calculate standard deviation |
Calculate the standard deviation of two or more numbers |
Math - Calculate Subtraction |
Calculate the difference between two numbers |
Math - Calculate sum |
Calculate the sum of two or more numbers |
Math - Calculate Tangent |
Calculate the tangent value of an angle |
Math - Calculate variance |
Calculate the statistical variance of two or more numbers |
Math - Convert angle |
Convert value from one angle measurement to another |
Math - Convert area |
Convert value from one area measurement to another |
Math - Convert distance |
Convert value from one distance measurement to another |
Math - Convert duration |
Convert value from one duration measurement to another |
Math - Convert energy |
Convert value from one energy measurement to another |
Math - Convert power |
Convert value from one power measurement to another |
Math - Convert speed |
Convert value from one speed measurement to another |
Math - Convert temperature |
Convert value from one temperature measurement to another |
Math - Convert volume |
Convert value from one volume measurement to another |
Math - Convert weight |
Convert value from one weight measurement to another |
Math - Random number |
Generate a random number within a specified range |
Math - Round number |
Round a numeric value up or down |
Text - Autocorrect (Beta) |
Automatically correct text (1024 char max) |
Text - Compare strings |
Perform a comparison of two strings |
Text - Contains string |
Determine if a string contains another string |
Text - Convert case |
Convert string to upper, lower or title case |
Text - Decode string |
Decode a string encoded with Base64 encoding |
Text - Decode URL |
Decode an encoded URL |
Text - Detect Personal Data (Beta) |
Detect personal information (PII) in text (1024 char max) |
Text - Encode string |
Encode a string using Base64 encoding |
Text - Encode URL |
Generate an encoded string from a complex hyperlink |
Text - Generate GUID |
Generate a globally unique identifier |
Text - Generate hash |
Generate a hash value from a string |
Text - Generate password |
Generate a strong password |
Text - Join strings |
Join a collection of strings |
Text - Moderate Content (Beta) |
Scan text for explicit, suggestive or obscene content (English only) |
Text - Parse string |
Extract values from a string of text using Regular Expressions |
Text - Redact string |
Redact a strng containing sensitive content |
Text - Replace string |
Replace one value with another in a string |
Text - Shorten hyperlink |
Generate a simple, short URL from a complex URL |
Text - Speech to Text |
Convert audio file to text (1MB compressed, 10MB uncompressed limit) |
Text - Speech to Text (V2) |
Convert audio file to text (1MB compressed, 10MB uncompressed limit) |
Text - Split string |
Split a string based upon one or more characters |
Text - String to File |
Convert text string to file |
Text - Text to Speech |
Convert text to an audio file using AI-driven speech synthesis. |
Text - Translate string |
Translate a string into a different language |
Text - Trim string |
Trim leading or trailing whitespace from a string |
Text - Validate email |
Determine if an email address is valid |
Text - Verify hash |
Verify a hashed value against the original source string |
Weather - Activity Forecast |
Get current weather-related activity forecast near an address or location |
Weather - Daily Forecast |
Get daily weather forecast near an address or location |
Weather - Hourly Forecast |
Get hourly weather forecast near an address or location |
Weather - Weather Conditions |
Get current weather conditions near an address or location |
Collections - Add to collection
Add an item to a collection
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Collection
|
input | True | array of string |
Collection of values or objects to modify |
Item
|
item | string |
Item (for multiple items, leave blank and use Items) |
|
Items
|
items | array of string |
Items (Collection, for a single item leave blank and use Item) |
|
Index
|
index | string |
Index position for operation (leave blank to specify end of collection) |
Returns
Collections - Collection to JSON
Convert a collection to a named JSON object
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Values
|
input | True | array of string |
Collection containing strings to convert |
Name
|
name | True | string |
Collection name |
Returns
- Body
- outputString
Collections - Collection to XML
Convert a collection to an XML string
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Values
|
input | True | array of string |
Collection containing strings to convert |
Root Node Name
|
root | True | string |
Name of root XML node |
Child Node Name
|
child | True | string |
Name of child XML node(s) |
Returns
- Body
- outputString
Collections - Contains number
Determine if a collection contains a specific number
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Values
|
input | True | array of number |
Collection of strings to search |
Number
|
match | True | number |
Number to match |
Number Type
|
type | string |
Type of number - integer or decimal |
Returns
Collections - Contains string
Determine if any items in a collection contain a specific string
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Values
|
input | True | array of string |
Collection of strings to search |
Text
|
match | True | string |
Text to match |
Trim
|
trim | string |
Trim white space from comparison string |
|
Ignore Case
|
ignorecase | string |
Ignore case when performing comparison |
Returns
Collections - Count collection
Count a collection of items
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Collection
|
input | True | array of string |
Collection of items to count |
Returns
- Body
- outputNumber
Collections - Ends with string
Determine if any items in a collection end with a specific string
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Values
|
input | True | array of string |
Collection of strings to search |
Text
|
match | True | string |
Text to match |
Trim
|
trim | string |
Trim white space from comparison string |
|
Ignore Case
|
ignorecase | string |
Ignore case when performing comparison |
Returns
Collections - Filter collection
Filter a collection of strings by keyword
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Collection
|
input | True | array of string |
Collection of strings to filter |
Match
|
match | True | string |
Match type |
Keywords
|
keywords | True | string |
Keywords (separate multiple values with commas) |
Returns
Collections - Join Collection
Join a collection of strings
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Values
|
input | True | array of string |
Collection containing strings to join |
Separator
|
separator | string |
Separator character for string result |
Returns
- Body
- outputString
Collections - Remove duplicates from collection
Remove duplicate items from a collection
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Collection
|
input | True | array of string |
Collection of items to de-duplicate |
Returns
Collections - Remove from collection
Remove an item from a collection
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Collection
|
input | True | array of string |
Collection of values or objects to modify |
Item
|
item | string |
Item (for multiple items, leave blank and use Items) |
|
Items
|
items | array of string |
Items (Collection, for a single item leave blank and use Item) |
|
Index
|
index | string |
Index position for operation (leave blank to specify end of collection) |
Returns
Collections - Replace values in collection
Replace whole or partial strings in a collection
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Collection
|
input | True | array of string |
Collection of strings |
Match value
|
match | True | string |
Match value |
Replacement value
|
replacement | True | string |
Replacement value |
Ignore case
|
ignoreCase | True | string |
Ignore case |
Returns
Collections - Sort collection
Sort a collection of strings
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Collection
|
input | True | array of string |
Collection of strings to sort |
Order
|
order | True | string |
Sort order |
Returns
Collections - Split collection
Split a collection of items by matching value or index
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Collection
|
input | True | array of string |
Collection of items to split |
Match Value
|
match | string |
String to match (explicit, case-insensitive, leave empty to use Index) |
|
Index
|
index | string |
Index location to split (leave empty to use Match value) |
Returns
Collections - Starts with string
Determine if any items in a collection start with a specific string
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Values
|
input | True | array of string |
Collection of strings to search |
Text
|
match | True | string |
Text to match |
Trim
|
trim | string |
Trim white space from comparison string |
|
Ignore Case
|
ignorecase | string |
Ignore case when performing comparison |
Returns
Currency - Convert currency
Calculate monetary value in a different currency
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Value
|
input | True | number |
Amount to convert |
Source currency
|
source | True | string | |
Target currency
|
target | True | string |
Returns
- Body
- outputNumber
Currency - Format currency
Apply currency symbol to a numeric value
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Value
|
input | True | number |
Amount to format |
Target currency
|
target | True | string |
Returns
- Body
- outputString
Data - CSV to JSON
Convert a CSV string to a JSON array
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Value
|
input | True | string |
CSV string |
Header
|
header | True | boolean |
Include header row |
Returns
- Body
- outputString
Data - CSV to XML
Convert a CSV string to an XML string
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Value
|
input | True | string |
Comma-delimited string |
Root node name
|
root | True | string |
Name of the root XML node |
Rows node name
|
rows | True | string |
XML node name for each row |
Returns
- Body
- outputString
Data - Filter CSV
Filter a comma-delimited string using field names and/or regular expressions
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Input
|
input | True | string |
Comma-delimited string with headers |
Field name
|
field | string |
Optional - Name of field to return |
|
Regular Expression
|
regex | string |
Optional - Regular expression string (Microsoft .NET syntax) |
Returns
Data - Format JSON
Format a string of JSON data
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Source
|
source | True | string |
String variable or text value |
Returns
- Body
- outputString
Data - JSON to CSV
Convert a JSON array to CSV string
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Value
|
input | True | string |
JSON array object |
Header
|
header | True | boolean |
Include header row |
Omit Columns
|
omit | string |
Columns to omit (comma separated) |
|
Order
|
order | string |
Column order (comma separated) |
Returns
- Body
- outputString
Data - JSON to HTML Table
Convert a JSON array to an HTML table
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Value
|
input | True | string |
JSON array object |
Header
|
header | True | boolean |
Include header row |
Alternate Header
|
alternate | string |
Alternate header row markup |
|
Table Attributes
|
attributes | string |
Optional table attributes (single quoted values) |
|
Omit Columns
|
omit | string |
Columns to omit (comma separated) |
|
Order
|
order | string |
Column order (comma separated) |
Returns
- Body
- outputString
Data - JSON to XML
Convert a JSON object to an XML string
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Value
|
input | True | string |
JSON array object |
Root Name
|
root | True | string |
Name of root node |
Returns
- Body
- outputString
Data - Query JSON
Query a JSON object using a JSONPath expression
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Value
|
input | True | string |
XML or JSON string |
Query
|
query | True | string |
XPath or JSONPath query |
Returns
- Body
- outputString
Data - Query XML
Query an XML string using an XPath expression
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Value
|
input | True | string |
XML or JSON string |
Query
|
query | True | string |
XPath or JSONPath query |
Returns
- Body
- outputString
Data - Validate JSON
Determine if a JSON string represents a valid data object
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Source
|
source | True | string |
String variable or text value |
Returns
- Body
- outputValidateJson
Data - XML to JSON
Convert an XML string to a JSON object
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Value
|
input | True | string |
XML string |
Returns
- Body
- outputString
DateTime - DateTime difference
Calculate the difference between two dates
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
First date/time value
|
dateTime1 | True | string |
First date/time value |
Second date/time value
|
dateTime2 | True | string |
Second date/time value |
Returns
- Body
- outputDateDifference
DateTime - Format date and time
Create a date/time string in a specific format
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Value
|
input | True | string |
Source date and time |
Culture
|
culture | True | string |
Language culture |
Format
|
format | True | string |
Output format |
Returns
- Body
- outputString
DateTime - Get date and time information
Retrieve useful date and time information, such as day of year, total seconds and ticks
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Value
|
input | True | string |
Source date and time |
Culture
|
culture | True | string |
Language culture |
Returns
- Body
- outputDateInfo
DateTime - Get world time
Convert date and time from one time zone to another
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Value
|
input | True | string |
Source date and time |
Source Time Zone
|
source | True | string | |
Target Time Zone
|
target | True | string | |
Format
|
format | string |
Display format (defaults to 'yyyy-MM-dd HH:mm:ss') |
Returns
- Body
- outputString
Files - Composite Image
Insert a foreground image in front of a background image
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Position
|
position | True | string |
Foreground image position |
Horizontal Position
|
horizontal | number |
Horizontal foreground 'x' axis value for custom position |
|
Vertical Position (Optional)
|
vertical | number |
Vertical foreground 'y' axis value for custom position |
|
Foreground Opacity
|
opacity | True | number |
Opacity of foreground image (percentage) |
File name (optional)
|
filename | string |
Omit to use background image name. Must include image format extension. |
|
Background Image
|
background | True | file |
Background image file |
Foreground Image
|
foreground | True | file |
Foreground image file |
Files - Compress File
Compress a file (20MB max)
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Compression Format
|
format | True | string |
File format of the compressed result |
File Name
|
filename | string |
Name of the compressed file |
|
Source File
|
file | True | file |
Source file to compress |
Returns
- response
- file
Files - Convert Image
Convert an image from one format to another
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File Format
|
format | True | string |
Output file format |
Source File
|
file | True | file |
Source image file |
Returns
- response
- file
Files - Crop Image
Crop an image
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Position
|
position | True | string |
Crop start position (use negative values to reverse crop area) |
Width
|
Width | True | number |
Width (X-axis right, negative to reverse) |
Height
|
Height | True | number |
Height (Y-axis down, negative to reverse) |
File
|
file | True | file |
Source image file |
Returns
- response
- file
Files - File to string
Convert a file to a Base64 string
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File
|
file | True | file |
Source file (10MB limit) |
Returns
- Body
- outputString
Files - Flip Image
Flip an image (horizontal or vertical)
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Orientation
|
orientation | True | string |
Horizontal or Vertical |
File
|
file | True | file |
Source image file |
Returns
- response
- file
Files - Generate QR code
Generate a QR code image
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Value
|
input | True | string |
Text value(s) (vertical bar delimited by type) |
Type
|
payload | True | string |
Payload type |
Returns
- response
- file
Files - Image Metadata
Retrieve EXIF metadata from an image
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File
|
file | True | file |
Source file (10MB limit) |
Returns
- Body
- outputImageMetadata
Files - Moderate Image
Scan image for adult or obscene content
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File
|
file | True | file |
Source file (4MB limit) |
Returns
Files - Reduce Image Quality
Reduce the quality of an image
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Quality
|
quality | number |
Quality value between 1 (lowest quality) and 100 (highest quality) |
|
File
|
file | True | file |
Source image file (PNG, GIF, JPG/JPEG, BMP) |
Returns
- response
- file
Files - Remove Image Metadata
Remove the EXIF and IPTC profile data from an image
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File
|
file | True | file |
Source image file (PNG, GIF, JPG/JPEG, BMP) |
Returns
- response
- file
Files - Resize Image
Resize an image
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Resampling Algorithm
|
algorithm | True | string |
Optimize output quality of the target image |
Units
|
units | True | string |
Image adjustment units |
Height
|
height | number |
Image height (pixels or percent) |
|
Width
|
width | number |
Image width (pixels or percent) |
|
File
|
file | True | file |
Source image file |
Returns
- response
- file
Files - Rotate Image
Rotate an image by specified number of degrees
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Degrees
|
degrees | True | string |
Number of degrees |
File
|
file | True | file |
Source image file |
Returns
- response
- file
Files - Watermark Image
Add watermark text to an image
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Text
|
text | True | string |
Watermark text |
Font
|
font | True | string |
Text font |
Font Size
|
size | True | number |
Font size (points) |
Text Color
|
color | True | string |
Text color hex value |
Horizontal
|
horizontal | True | string |
Horizontal alignment |
Vertical
|
vertical | True | string |
Vertical alignment |
Source File
|
file | True | file |
Source image file |
Returns
- response
- file
Finance - Market index
Get current and historical market index information
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Index
|
symbol | True | string |
Market index |
Date
|
date | string |
Date (yyyy-MM-dd, leave empty for last trading day) |
Returns
- Body
- outputMarketIndex
Finance - Stock prices
Get current and historical stock price information
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Symbols
|
symbols | True | string |
Stock ticker symbols (comma-separated, max 20) |
Date
|
date | string |
Date (yyyy-MM-dd, leave empty for latest) |
|
Exchange
|
exchange | string |
Stock exchange |
Returns
- Body
- outputStockPrice
Maps - IP Location
Physical location of an IP address
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Source
|
source | True | string |
IP Address |
Returns
- Body
- outputIPLocation
Maps - Map Coordinates
Retrieve the approximate latitude/longitude matching a full or partial address
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Address
|
source | True | string |
Full or partial address |
Returns
- Body
- outputMapCoordinates
Maps - Map Image
Generate a map image from an address
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Address
|
source | True | string |
Full or partial address |
Zoom
|
zoom | True | number |
Map image zoom level |
Height
|
height | True | number |
Image height |
Width
|
width | True | number |
Image width |
Returns
- response
- file
Maps - Map Timezone
Get timezone information from an address
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Address
|
source | True | string |
Full or partial address |
Returns
- Body
- outputTimezoneInfo
Math - Calculate Absolute
Calculate the absolute value of a number
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Value
|
input | True | number |
Numeric value to calculate |
Decimal Places
|
decimals | True | number |
Round to number of decimal places |
Returns
- Body
- outputNumber
Math - Calculate Addition
Calculate the sum of two numbers
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Primary Value
|
input | True | number |
Numeric value |
Secondary Value
|
value | True | number |
Addend, subtrahend, factor, divisor or radicand |
Decimal Places
|
decimals | True | number |
Round to number of decimal places |
Returns
- Body
- outputNumber
Math - Calculate average
Calculate the average of two or more numbers
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Values
|
input | True | array of number |
Collection of values to calculate |
Decimal Places
|
decimals | True | number |
Round to number of decimal places |
Returns
- Body
- outputNumber
Math - Calculate Cosine
Calculate the cosine value of an angle
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Value
|
input | True | number |
Numeric value to calculate |
Decimal Places
|
decimals | True | number |
Round to number of decimal places |
Returns
- Body
- outputNumber
Math - Calculate Division
Calculate the quotient of two numbers
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Primary Value
|
input | True | number |
Numeric value |
Secondary Value
|
value | True | number |
Addend, subtrahend, factor, divisor or radicand |
Decimal Places
|
decimals | True | number |
Round to number of decimal places |
Returns
- Body
- outputNumber
Math - Calculate Logarithm
Calculate the logarithm of a number
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Value
|
input | True | number |
Numeric value to calculate |
Decimal Places
|
decimals | True | number |
Round to number of decimal places |
Returns
- Body
- outputNumber
Math - Calculate median
Calculate the median of two or more numbers
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Values
|
input | True | array of number |
Collection of values to calculate |
Decimal Places
|
decimals | True | number |
Round to number of decimal places |
Returns
- Body
- outputNumber
Math - Calculate minimum or maximum
Calculate the minimum or maximum value in a sequence of numbers
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Values
|
input | True | array of number |
Collection of values to calculate |
Min or Max
|
type | True | string |
Minimum or Maximum |
Returns
- Body
- outputNumber
Math - Calculate Modulo
Calculate the remainder of dividing two numbers
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Primary Value
|
input | True | number |
Numeric value |
Secondary Value
|
value | True | number |
Addend, subtrahend, factor, divisor or radicand |
Decimal Places
|
decimals | True | number |
Round to number of decimal places |
Returns
- Body
- outputNumber
Math - Calculate Multiplication
Calculate the product of two numbers
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Primary Value
|
input | True | number |
Numeric value |
Secondary Value
|
value | True | number |
Addend, subtrahend, factor, divisor or radicand |
Decimal Places
|
decimals | True | number |
Round to number of decimal places |
Returns
- Body
- outputNumber
Math - Calculate Nth Root
Calculate the n-th root of a number
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Primary Value
|
input | True | number |
Numeric value |
Secondary Value
|
value | True | number |
Addend, subtrahend, factor, divisor or radicand |
Decimal Places
|
decimals | True | number |
Round to number of decimal places |
Returns
- Body
- outputNumber
Math - Calculate power
Raise number to a specified power
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Number
|
input | True | number |
Number to raise |
Power
|
power | True | number |
Power |
Decimal Places
|
decimals | True | number |
Round to number of decimal places |
Returns
- Body
- outputNumber
Math - Calculate Sine
Calculate the sine value of an angle
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Value
|
input | True | number |
Numeric value to calculate |
Decimal Places
|
decimals | True | number |
Round to number of decimal places |
Returns
- Body
- outputNumber
Math - Calculate Square Root
Calculate the square root of a number
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Value
|
input | True | number |
Numeric value to calculate |
Decimal Places
|
decimals | True | number |
Round to number of decimal places |
Returns
- Body
- outputNumber
Math - Calculate standard deviation
Calculate the standard deviation of two or more numbers
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Values
|
input | True | array of number |
Collection of values to calculate |
Decimal Places
|
decimals | True | number |
Round to number of decimal places |
Returns
- Body
- outputNumber
Math - Calculate Subtraction
Calculate the difference between two numbers
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Primary Value
|
input | True | number |
Numeric value |
Secondary Value
|
value | True | number |
Addend, subtrahend, factor, divisor or radicand |
Decimal Places
|
decimals | True | number |
Round to number of decimal places |
Returns
- Body
- outputNumber
Math - Calculate sum
Calculate the sum of two or more numbers
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Values
|
input | True | array of number |
Collection of values to calculate |
Decimal Places
|
decimals | True | number |
Round to number of decimal places |
Returns
- Body
- outputNumber
Math - Calculate Tangent
Calculate the tangent value of an angle
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Value
|
input | True | number |
Numeric value to calculate |
Decimal Places
|
decimals | True | number |
Round to number of decimal places |
Returns
- Body
- outputNumber
Math - Calculate variance
Calculate the statistical variance of two or more numbers
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Values
|
input | True | array of number |
Collection of values to calculate |
Decimal Places
|
decimals | True | number |
Round to number of decimal places |
Returns
- Body
- outputNumber
Math - Convert angle
Convert value from one angle measurement to another
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Measurement value
|
input | True | number | |
Source measurement
|
source | True | string | |
Target measurement
|
target | True | string |
Returns
- Body
- outputNumber
Math - Convert area
Convert value from one area measurement to another
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Measurement value
|
input | True | number | |
Source measurement
|
source | True | string | |
Target measurement
|
target | True | string |
Returns
- Body
- outputNumber
Math - Convert distance
Convert value from one distance measurement to another
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Measurement value
|
input | True | number | |
Source measurement
|
source | True | string | |
Target measurement
|
target | True | string |
Returns
- Body
- outputNumber
Math - Convert duration
Convert value from one duration measurement to another
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Measurement value
|
input | True | number | |
Source measurement
|
source | True | string | |
Target measurement
|
target | True | string |
Returns
- Body
- outputNumber
Math - Convert energy
Convert value from one energy measurement to another
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Measurement value
|
input | True | number | |
Source measurement
|
source | True | string | |
Target measurement
|
target | True | string |
Returns
- Body
- outputNumber
Math - Convert power
Convert value from one power measurement to another
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Measurement value
|
input | True | number | |
Source measurement
|
source | True | string | |
Target measurement
|
target | True | string |
Returns
- Body
- outputNumber
Math - Convert speed
Convert value from one speed measurement to another
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Measurement value
|
input | True | number | |
Source measurement
|
source | True | string | |
Target measurement
|
target | True | string |
Returns
- Body
- outputNumber
Math - Convert temperature
Convert value from one temperature measurement to another
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Measurement value
|
input | True | number | |
Source measurement
|
source | True | string | |
Target measurement
|
target | True | string |
Returns
- Body
- outputNumber
Math - Convert volume
Convert value from one volume measurement to another
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Measurement value
|
input | True | number | |
Source measurement
|
source | True | string | |
Target measurement
|
target | True | string |
Returns
- Body
- outputNumber
Math - Convert weight
Convert value from one weight measurement to another
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Measurement value
|
input | True | number | |
Source measurement
|
source | True | string | |
Target measurement
|
target | True | string |
Returns
- Body
- outputNumber
Math - Random number
Generate a random number within a specified range
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Start
|
start | True | number |
Start of range |
End
|
end | True | number |
End of range |
Returns
- Body
- outputNumber
Math - Round number
Round a numeric value up or down
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Value
|
input | True | number |
Numeric value to calculate |
Decimal Places
|
decimals | True | number |
Round to number of decimal places |
Returns
- Body
- outputNumber
Text - Autocorrect (Beta)
Automatically correct text (1024 char max)
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Input
|
input | True | string |
String variable or text value |
Returns
- Body
- outputString
Text - Compare strings
Perform a comparison of two strings
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Source
|
input | True | string |
Original string |
Target
|
compare | True | string |
Comparison string |
Lowercase
|
lower | True | string |
Convert strings to lowercase before comparison |
Trim
|
trim | True | string |
Trim strings before comparison |
Returns
- Body
- outputString
Text - Contains string
Determine if a string contains another string
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Value
|
find | True | string |
Text to match |
Target
|
input | True | string |
Text to search |
Lowercase
|
lower | True | string |
Convert strings to lowercase |
Returns
- Body
- outputString
Text - Convert case
Convert string to upper, lower or title case
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Value
|
input | True | string |
String containing the text to convert |
Case
|
alphacase | True | string |
Case of conversion result |
Returns
- Body
- outputString
Text - Decode string
Decode a string encoded with Base64 encoding
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Source
|
source | True | string |
string variable or text value |
Returns
- Body
- outputString
Text - Decode URL
Decode an encoded URL
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Source
|
source | True | string |
String variable or text value |
Returns
- Body
- outputString
Text - Detect Personal Data (Beta)
Detect personal information (PII) in text (1024 char max)
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Input
|
input | True | string |
String variable or text value |
Returns
- Body
- outputPersonalData
Text - Encode string
Encode a string using Base64 encoding
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Source
|
source | True | string |
String variable or text value |
Returns
- Body
- outputString
Text - Encode URL
Generate an encoded string from a complex hyperlink
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Source
|
source | True | string |
String variable or text value |
Returns
- Body
- outputString
Text - Generate GUID
Generate a globally unique identifier
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Uppercase
|
uppercase | True | string |
All uppercase alpha characters |
Returns
- Body
- outputString
Text - Generate hash
Generate a hash value from a string
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Input
|
input | True | string |
Hash source string |
Algorithm
|
algorithm | True | string |
Hash algorithm |
Returns
- Body
- outputString
Text - Generate password
Generate a strong password
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Length
|
length | True | number |
Number of characters |
Lowercase
|
lowercase | True | boolean |
Include lowercase characters |
Uppercase
|
uppercase | True | boolean |
Include uppercase characters |
Numeric
|
numeric | True | boolean |
Include single-digit numbers |
Special Characters
|
special | True | boolean |
Include non-alphanumeric characters |
Returns
- Body
- outputString
Text - Join strings
Join a collection of strings
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Values
|
input | True | array of string |
Collection of strings to be joined |
Separator
|
separator | True | string |
Separator character |
Lowercase
|
lower | True | string |
Convert strings in collection to lowercase |
Trim
|
trim | True | string |
Trim strings in collection |
Returns
- Body
- outputString
Text - Moderate Content (Beta)
Scan text for explicit, suggestive or obscene content (English only)
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Input
|
input | True | string |
String variable or text value |
Returns
Text - Parse string
Extract values from a string of text using Regular Expressions
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Input
|
input | True | string |
String containing the text to be parsed |
Regular Expression
|
regex | True | string |
Regular expression string (Microsoft .NET syntax) |
Returns
Text - Redact string
Redact a strng containing sensitive content
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Source String
|
source | True | string |
String containing the complete text |
Value
|
value | string |
Individual string to redact |
|
-OR- Values Collection
|
values | array of string |
Collection of strings to redact |
|
-OR- Regular Expression
|
regex | string |
Regular expression pattern for matching strings |
Returns
- Body
- outputString
Text - Replace string
Replace one value with another in a string
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Source
|
source | True | string |
String containing the text to be replaced |
Value
|
value | True | string |
Text to replace |
Replacement
|
replacement | True | string |
Replacement text |
Returns
- Body
- outputString
Text - Shorten hyperlink
Generate a simple, short URL from a complex URL
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Source
|
source | True | string |
String variable or text value |
Returns
- Body
- outputString
Text - Speech to Text
Convert audio file to text (1MB compressed, 10MB uncompressed limit)
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Language
|
language | True | string |
Language of audio input |
File
|
file | True | file |
Source audio file (WAV, MP3, AAC, M4A) |
Returns
- Body
- outputString
Text - Speech to Text (V2)
Convert audio file to text (1MB compressed, 10MB uncompressed limit)
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Language
|
language | True | string |
Language of audio input |
Timestamps
|
timestamps | True | string |
Include auto-generated timestamps in output |
File
|
file | True | file |
Source audio file (WAV, MP3, AAC, M4A) |
Returns
- Body
- outputString
Text - Split string
Split a string based upon one or more characters
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Value
|
input | True | string |
Text to split |
Character(s)
|
characters | True | string |
One or more characters that will be used to split the text |
Returns
- Body
- outputStringArray
Text - String to File
Convert text string to file
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Value
|
input | True | string |
Text string (body of file) |
Extension
|
extension | True | string |
File extension |
Filename
|
filename | True | string |
Name of file (without extension) |
Returns
- response
- file
Text - Text to Speech
Convert text to an audio file using AI-driven speech synthesis.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Text
|
text | True | string |
Text to convert (10,000 characters max) |
Text or file type
|
type | True | string |
Text or file type |
Voice
|
voice | True | string |
Voice locale (must match language of input text) |
Returns
- response
- file
Text - Translate string
Translate a string into a different language
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Value
|
input | True | string |
String containing the text to be translated |
Language
|
language | True | string |
Translation language |
Returns
- Body
- outputString
Text - Trim string
Trim leading or trailing whitespace from a string
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Source
|
source | True | string |
String containing the text to be trimmed |
Type
|
type | True | string |
Type of white space to remove |
Returns
- Body
- outputString
Text - Validate email
Determine if an email address is valid
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Source
|
source | True | string |
String variable or text value |
Returns
- Body
- outputString
Text - Verify hash
Verify a hashed value against the original source string
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Input
|
input | True | string |
Original source string |
Algorithm
|
algorithm | True | string |
Hash algorithm |
Hash
|
hash | True | string |
Hashed result |
Returns
- Body
- outputBoolean
Weather - Activity Forecast
Get current weather-related activity forecast near an address or location
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Address
|
source | True | string |
Full or partial address |
Activity
|
activity | True | string |
Weather-related activity |
Returns
Weather - Daily Forecast
Get daily weather forecast near an address or location
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Address
|
source | True | string |
Full or partial address |
Units
|
units | True | string |
Units |
Duration
|
duration | True | number |
Duration |
Returns
- Body
- outputDailyForecast
Weather - Hourly Forecast
Get hourly weather forecast near an address or location
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Address
|
source | True | string |
Full or partial address |
Units
|
units | True | string |
Units |
Duration
|
duration | True | number |
Duration |
Returns
- Body
- outputHourlyForecast
Weather - Weather Conditions
Get current weather conditions near an address or location
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Address
|
source | True | string |
Full or partial address |
Units
|
units | True | string |
Units |
Returns
Definitions
outputStringArray
Name | Path | Type | Description |
---|---|---|---|
data
|
data | array of string |
data |
outputDateInfo
Name | Path | Type | Description |
---|---|---|---|
DayOfYear
|
DayOfYear | number |
Day of the year |
DayOfWeek
|
DayOfWeek | number |
Day of the week |
WeekOfYear
|
WeekOfYear | number |
Week of the year |
SecondsInDay
|
SecondsInDay | number |
Seconds in the day |
MinutesInDay
|
MinutesInDay | number |
Minutes in the day |
Ticks
|
Ticks | number |
Tick count |
outputDateDifference
Name | Path | Type | Description |
---|---|---|---|
Years
|
years | number |
Years |
Months
|
months | number |
Months |
Days
|
days | number |
Days |
Hours
|
hours | number |
Hours |
Minutes
|
minutes | number |
Minutes |
Milliseconds
|
milliseconds | number |
Milliseconds |
Total Years
|
totalYears | double |
Total Years |
Total Months
|
totalMonths | double |
Total Months |
Total Days
|
totalDays | double |
Total Days |
Total Hours
|
totalHours | double |
Total Hours |
Total Minutes
|
totalMinutes | double |
Total Minutes |
Total Seconds
|
totalSeconds | double |
Total Seconds |
Total Milliseconds
|
totalMilliseconds | double |
Total Milliseconds |
Ticks
|
ticks | number |
Ticks |
outputCollectionNumber
Name | Path | Type | Description |
---|---|---|---|
Success
|
status | boolean |
Success |
First Value
|
item | number |
First Value |
All Values
|
items | array of number |
All Values |
outputCollectionResult
Name | Path | Type | Description |
---|---|---|---|
Modified collection result
|
result | array of string |
Modified collection result |
outputCollectionString
Name | Path | Type | Description |
---|---|---|---|
Success
|
status | boolean |
Success |
First Value
|
item | string |
First Value |
All Values
|
items | array of string |
All Values |
outputMultiCollection
Name | Path | Type | Description |
---|---|---|---|
First collection result
|
result1 | array of string |
First collection result |
Second collection result
|
result2 | array of string |
Second collection result |
outputString
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | string |
Result |
outputNumber
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | number |
Result |
outputBoolean
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | boolean |
Result |
outputStockPrice
Name | Path | Type | Description |
---|---|---|---|
Stock price information
|
result | array of object |
Stock price information |
Date
|
result.date | string |
Date |
Symbol
|
result.symbol | string |
Ticker symbol |
Exchange
|
result.exchange | string |
Stock exchange |
Open
|
result.open | number |
Open |
High
|
result.high | number |
High |
Low
|
result.low | number |
Low |
Close
|
result.close | number |
Close |
Volume
|
result.volume | number |
Volume |
outputMarketIndex
Name | Path | Type | Description |
---|---|---|---|
Date
|
date | string |
Date |
Symbol
|
symbol | string |
Index symbol |
Exchange
|
exchange | string |
Market exchange |
Open
|
open | number |
Open value |
High
|
high | number |
High value |
Low
|
low | number |
Low value |
Close
|
close | number |
Close value |
Volume
|
volume | number |
Trading volume |
Adjusted Open
|
adj_open | number |
Adjusted open value |
Adjusted High
|
adj_high | number |
Adjusted high value |
Adjusted Low
|
adj_low | number |
Adjusted low value |
Adjusted Close
|
adj_close | number |
Adjusted close value |
Adjusted Volume
|
adj_volume | number |
Adjusted trading volume |
outputIPLocation
Name | Path | Type | Description |
---|---|---|---|
Country Name
|
countryName | string |
Country Name |
Country Code
|
countryCode | string |
Country Code |
Region
|
region | string |
Region |
Locale
|
locale | string |
Locale |
outputMapCoordinates
Name | Path | Type | Description |
---|---|---|---|
Latitude
|
latitude | number |
Latitude |
Longitude
|
longitude | number |
Longitude |
outputTimezoneInfo
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | string |
Timezone ID |
Country Name
|
countryName | string |
Full country name |
Country Code
|
countryCode | string |
Two-letter country code |
Short Name
|
shortName | string |
Short timezone name |
Standard Name
|
standardName | string |
Standard timezone name |
DST Name
|
dstName | string |
Daylight Savings timezone name |
Standard Offset
|
standardOffset | string |
Standard timezone offset from GMT |
DST Offset
|
dstOffset | string |
Daylight savings timezone offset from GMT |
DST Start
|
dstStart | string |
Daylight savings time start date |
DST End
|
dstEnd | string |
Daylight savings time end date |
Sunrise
|
sunrise | string |
Time of sunrise in target timezone |
Sunset
|
sunset | string |
Time of sunset in target timezone |
outputWeatherConditions
Name | Path | Type | Description |
---|---|---|---|
Description
|
description | string |
Description |
Precipitation
|
precipitation | boolean |
Precipitation |
Accumulated Precipitation
|
accumulatedPrecipitation | string |
Accumulated precipitation (24 hours) |
Temperature
|
temperature | number |
Temperature |
Wind Chill
|
windChill | number |
Wind Chill |
Humidity
|
humidity | number |
Relative humidity |
Dew Point
|
dewPoint | number |
Dew point |
Wind Direction
|
windDirection | string |
Wind direction |
DST Start
|
dstStart | string |
Daylight savings time start date |
Wind Speed
|
windSpeed | string |
Wind speed |
Wind Gust
|
windGust | string |
Wind gusts (max) |
UV Index
|
uvIndex | number |
UV Index |
UV Level
|
uvDescription | string |
UV Level |
Visibility
|
visibility | string |
Visbility |
Cloud Cover
|
cloudCover | number |
Cloud cover |
Ceiling
|
ceiling | string |
Ceiling |
Pressure
|
pressure | string |
Barometric pressure |
Pressure Trend
|
pressureTendency | string |
Barometric pressure trend |
outputDailyForecast
Name | Path | Type | Description |
---|---|---|---|
Daily weather forecast
|
result | array of object |
Daily weather forecast |
Date
|
result.date | string |
Date |
Low
|
result.low | string |
Low temperature |
High
|
result.high | string |
High temperature |
Sunlight Hours
|
result.sunlight | number |
Hours of Sunlight |
Air Quality
|
result.airQuality | string |
Relative air quality |
Description
|
result.description | string |
Description |
Precipitation
|
result.precipitation | boolean |
Observable precipitation |
Precipitiation probability
|
result.precipitationProbability | number |
Chance of precipitiation |
Precipitation type
|
result.precipitationType | string |
Type of precipitation |
Precipitation hours
|
result.hoursPrecipitation | number |
Hours of precipitation |
Rain probability
|
result.rainProbability | number |
Probability of rain |
Snow probability
|
result.snowProbability | number |
Probability of snow |
Ice probability
|
result.iceProbability | number |
Probability of ice |
Thunderstorm probability
|
result.thunderstormProbability | number |
Probability of thunderstorms |
Wind direction
|
result.windDirection | string |
Wind direction |
Wind speed
|
result.windSpeed | string |
Wind speed |
Wind gust
|
result.windGust | string |
Wind gust |
Total rain
|
result.totalRain | string |
Total rain |
Total snow
|
result.totalSnow | string |
Total snow |
Total ice
|
result.totalIce | string |
Total ice |
Cloud cover
|
result.cloudCover | number |
Cloud cover |
outputHourlyForecast
Name | Path | Type | Description |
---|---|---|---|
Daily weather forecast
|
result | array of object |
Daily weather forecast |
Date
|
result.date | string |
Date |
Description
|
result.description | string |
Description |
Temperature
|
result.temperature | string |
Temperature |
Dew Point
|
result.dewPoint | string |
Dew point |
Relative humidity
|
result.relativeHumidity | number |
Relative humidity |
Visibility
|
result.visibility | string |
Visibility |
UV Index
|
result.uvIndex | string |
UV Index |
Precipitation
|
result.precipitation | boolean |
Observable precipitation |
Precipitiation probability
|
result.precipitationProbability | number |
Chance of precipitiation |
Rain probability
|
result.rainProbability | number |
Probability of rain |
Snow probability
|
result.snowProbability | number |
Probability of snow |
Ice probability
|
result.iceProbability | number |
Probability of ice |
Wind direction
|
result.windDirection | string |
Wind direction |
Wind speed
|
result.windSpeed | string |
Wind speed |
Wind gust
|
result.windGust | string |
Wind gust |
Total rain
|
result.totalRain | string |
Total rain |
Total snow
|
result.totalSnow | string |
Total snow |
Total ice
|
result.totalIce | string |
Total ice |
Ceiling
|
result.ceiling | string |
Ceiling |
Cloud cover
|
result.cloudCover | number |
Cloud cover |
outputActivityForecast
Name | Path | Type | Description |
---|---|---|---|
Current activity forecast
|
result | array of object |
Current weather-related activity forecast |
Name
|
result.name | string |
Name |
Date
|
result.date | string |
Date |
Quality
|
result.quality | string |
Quality of weather for specified activity |
Rating
|
result.rating | number |
General quality rating |
Description
|
result.description | string |
Description |
outputImageMetadata
Name | Path | Type | Description |
---|---|---|---|
Image EXIF Metadata
|
result | array of object |
Image EXIF Metadata |
Aperture Value
|
result.apertureValue | string |
Aperture Value |
Artist
|
result.artist | string |
Artist |
Background Color
|
result.backgroundColor | string |
Background Color |
Bits Per Sample
|
result.bitsPerSample | string |
Bits Per Sample |
Brightness Value
|
result.brightnessValue | string |
Brightness Value |
Camera Elevation Angle
|
result.cameraElevationAngle | string |
Camera Elevation Angle |
Clip Path
|
result.clipPath | string |
Clip Path |
Color Map
|
result.colorMap | string |
Color Map |
Color Space
|
result.colorSpace | string |
Color Space |
Color Type
|
result.colorType | string |
Color Type |
Compressed Bits Per Pixel
|
result.compressedBitsPerPixel | string |
Compressed Bits Per Pixel |
Compression Type
|
result.compression | string |
Compression Type |
Contrast
|
result.contrast | string |
Contrast |
Copyright
|
result.copyright | string |
Copyright |
Custom Rendered
|
result.customRendered | string |
Custom Rendered |
Date/Time
|
result.dateTime | string |
Date/Time |
DateTime Digitized
|
result.dateTimeDigitized | string |
DateTime Digitized |
DateTime Original
|
result.dateTimeOriginal | string |
DateTime Original |
Decode
|
result.decode | string |
Decode |
Default Image Color
|
result.defaultImageColor | string |
Default Image Color |
Device Setting Description
|
result.deviceSettingDescription | string |
Device Setting Description |
Digital Zoom Ratio
|
result.digitalZoomRatio | string |
Digital Zoom Ratio |
Document Name
|
result.documentName | string |
Document Name |
ExifVersion
|
result.exifVersion | string |
ExifVersion |
Exposure Bias Value
|
result.exposureBiasValue | string |
Exposure Bias Value |
Exposure Index
|
result.exposureIndex | string |
Exposure Index |
Exposure Mode
|
result.exposureMode | string |
Exposure Mode |
Exposure Time
|
result.exposureTime | string |
Exposure Time |
Extra Samples
|
result.extraSamples | string |
Extra Samples |
File Source
|
result.fileSource | string |
File Source |
Fill Order
|
result.fillOrder | string |
Fill Order |
Flash
|
result.flash | string |
Flash |
Flash Energy
|
result.flashEnergy | string |
Flash Energy |
F Number
|
result.fNumber | string |
F Number |
Focal Length
|
result.focalLength | string |
Focal Length |
Gain Control
|
result.gainControl | string |
Gain Control |
GPS Altitude
|
result.gpsAltitude | string |
GPS Altitude |
GPS Altitude Ref
|
result.gpsAltitudeRef | string |
GPS Altitude Ref |
GPS Area Information
|
result.gpsAreaInformation | string |
GPS Area Information |
GPS Date Stamp
|
result.gpsDateStamp | string |
GPS Date Stamp |
GPS Differential
|
result.gpsDifferential | string |
GPS Differential |
GPS Latitude
|
result.gpsLatitude | string |
GPS Latitude |
GPS Longitude
|
result.gpsLongitude | string |
GPS Longitude |
GPS Speed
|
result.gpsSpeed | string |
GPS Speed |
GPS Status
|
result.gpsStatus | string |
GPS Status |
GPS Track
|
result.gpsTrack | string |
GPS Track |
Host Computer
|
result.hostComputer | string |
Host Computer |
Image Description
|
result.imageDescription | string |
Image Description |
Image History
|
result.imageHistory | string |
Image History |
Image ID
|
result.imageID | string |
Image ID |
Image Height
|
result.imageHeight | string |
Image Height |
Image Length
|
result.imageLength | string |
Image Length |
Image Number
|
result.imageNumber | string |
Image Number |
Image Width
|
result.imageWidth | string |
Image Width |
ISO Speed
|
result.isoSpeed | string |
ISO Speed |
JPEG Interchange Format
|
result.jpegInterchangeFormat | string |
JPEG Interchange Format |
Max Aperture Value
|
result.maxApertureValue | string |
Max Aperture Value |
Max Sample Value
|
result.maxSampleValue | string |
Max Sample Value |
Metering Mode
|
result.meteringMode | string |
Metering Mode |
Model
|
result.model | string |
Model |
Model Number
|
result.modelNumber | string |
Model Number |
Orientation
|
result.orientation | string |
Orientation |
Owner Name
|
result.ownerName | string |
Owner Name |
Pixel Scale
|
result.pixelScale | string |
Pixel Scale |
Primary Chromaticities
|
result.primaryChromaticities | string |
Primary Chromaticities |
Profile Type
|
result.profileType | string |
Profile Type |
Rating
|
result.rating | string |
Rating |
Resolution Units
|
result.resolutionUnit | string |
Resolution Units |
Sample Format
|
result.sampleFormat | string |
Sample Format |
Scene Type
|
result.sceneType | string |
Scene Type |
Security Classification
|
result.securityClassification | string |
Security Classification |
Sensing Method
|
result.sensingMethod | string |
Sensing Method |
Serial Number
|
result.serialNumber | string |
Serial Number |
Sharpness
|
result.sharpness | string |
Sharpness |
Shutter Speed Value
|
result.shutterSpeedValue | string |
Shutter Speed Value |
Software
|
result.software | string |
Software |
User Comment
|
result.userComment | string |
User Comment |
Version
|
result.version | string |
Version |
WhiteBalance
|
result.whiteBalance | string |
WhiteBalance |
White Point
|
result.whitePoint | string |
White Point |
White Point X
|
result.whitePointX | string |
White Point X |
White Point Y
|
result.whitePointY | string |
White Point Y |
X Resolution
|
result.xResolution | string |
X Resolution |
Y Resolution
|
result.yResolution | string |
Y Resolution |
outputPersonalData
Name | Path | Type | Description |
---|---|---|---|
Email addresses
|
array of object |
Email addresses |
|
Value type
|
email.type | string |
Type |
Detected value
|
email.text | string |
Text |
Index
|
email.index | number |
Location of detected value |
Addresses
|
address | array of object |
Addresses |
Value type
|
address.type | string |
Type |
Detected value
|
address.text | string |
Text |
Index
|
address.index | number |
Location of detected value |
Phone numbers
|
phone | array of object |
Phone numbers |
Value type
|
phone.type | string |
Type |
Detected value
|
phone.text | string |
Text |
Index
|
phone.index | number |
Location of detected value |
IP addresses
|
ip | array of object |
IP addresses |
Value type
|
ip.type | string |
Type |
Detected value
|
ip.text | string |
Text |
Index
|
ip.index | number |
Location of detected value |
Social Security numbers (US)
|
ssn | array of object |
Social Security numbers (US) |
Value type
|
ssn.type | string |
Type |
Detected value
|
ssn.text | string |
Text |
Index
|
ssn.index | number |
Location of detected value |
outputImageEvaluation
Name | Path | Type | Description |
---|---|---|---|
Adult
|
adult | boolean |
Potentially adult content found |
Adult score
|
adultScore | number |
Adult content score |
Obscene
|
obscene | boolean |
Potentially obscene content found |
Obscene score
|
obsceneScore | number |
Obscene content score |
Result
|
result | boolean |
Image evaluation returned a successful result |
outputValidateJson
Name | Path | Type | Description |
---|---|---|---|
Valid
|
isValid | boolean |
Valid or invalid JSON input |
Message
|
message | string |
Error message if JSON input is not valid |
outputModerateContent
Name | Path | Type | Description |
---|---|---|---|
Explicit
|
explicitContent | boolean |
Potentially explicit content found |
Explicit score
|
explicitScore | number |
Explicit content score |
Suggestive
|
suggestiveContent | boolean |
Potentially suggestive content found |
Suggestive score
|
suggestiveScore | number |
Suggestive content score |
Obscene
|
obscene | boolean |
Potentially obscene content found |
Obscene score
|
obsceneScore | number |
Obscene content score |
Discovered terms
|
terms | array of string |
Discovered terms |
file
This is the basic data type 'file'.