@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Numbers API
@base https://api.math.tools
@version 1.5
@auth ApiKey X-Mathtools-Api-Secret in header
@endpoints 26
@hint download_for_search
@toc numbers(26)

@endpoint GET /numbers/nod
@desc Get the number of the day for current day
@returns(200) 200 Success response
@errors {401: 401 Unauthorized response}

@endpoint GET /numbers/fact
@desc Get a random fact about a number
@required {number: int(integer) # Number value}
@returns(200) 200 Success response
@errors {401: 401 Unauthorized response}

@endpoint GET /numbers/random
@desc Generate random number(s)
@optional {min: int(integer) # Minimum Number value in the range, max: int(integer) # Maximum Number value, total: int(integer) # Total number of random numbers to generate. Defaults to 1}
@returns(200) 200 Success response
@errors {401: 401 Unauthorized response}

@endpoint GET /numbers/ordinal
@desc Get the ordinal of the given number
@optional {number: int(integer) # Number value}
@returns(200) 200 Success response
@errors {401: 401 Unauthorized response}

@endpoint GET /numbers/cardinal
@desc Get the cardinal of the given number
@optional {number: int(integer) # Number value, language: str(string) # Language to use}
@returns(200) 200 Success response
@errors {401: 401 Unauthorized response}

@endpoint GET /numbers/currency
@desc Spells out the number as a currency
@optional {number: int(integer) # Number to spell, language: str(string) # Language to use}
@returns(200) 200 Success response
@errors {401: 401 Unauthorized response}

@endpoint GET /numbers/numeral/egyptian
@desc Convert base 10 representation of a given number to egyptian numeral.
@optional {number: int(integer) # Number to convert}
@returns(200) 200 Success response
@errors {401: 401 Unauthorized response}

@endpoint GET /numbers/numeral/chinese
@desc Convert base 10 representation of a given number to chinese numeral.
@optional {number: int(integer) # Number to convert}
@returns(200) 200 Success response
@errors {401: 401 Unauthorized response}

@endpoint GET /numbers/numeral/roman
@desc Convert base 10 representation of a given number to roman numeral.
@optional {number: int(integer) # Number to convert}
@returns(200) 200 Success response
@errors {401: 401 Unauthorized response}

@endpoint GET /numbers/base/binary
@desc Convert a given number to binary
@required {number: int(integer) # Number to convert to binary}
@optional {from: int(integer) # Base of the supplied number (Optional base 10 assumed by default)}
@returns(200) 200 success response
@errors {401: 401 Unauthorized response}

@endpoint GET /numbers/base/octal
@desc Convert a given number to octal
@required {number: int(integer) # Number to convert to octal}
@optional {from: int(integer) # Base of the supplied number (Optional base 10 assumed by default)}
@returns(200) 200 success response
@errors {401: 401 Unauthorized response}

@endpoint GET /numbers/base/hex
@desc Convert a given number to hexadecimal
@required {number: int(integer) # Number to convert to hex}
@optional {from: int(integer) # Base of the supplied number (Optional base 10 assumed by default)}
@returns(200) 200 success response
@errors {401: 401 Unauthorized response}

@endpoint GET /numbers/base
@desc Convert a given number from one base to another base
@required {number: int(integer) # Number to convert to the target base, to: int(integer) # Target base to convert to}
@optional {from: int(integer) # Base of the supplied number (Optional base 10 assumed by default)}
@returns(200) 200 success response
@errors {401: 401 Unauthorized response}

@endpoint GET /numbers/pi
@desc Get digits of pi (Ï€)
@optional {from: int(integer) # Optional start position, to: int(integer) # Optional start position}
@returns(200) 200 Success response
@errors {401: 401 Unauthorized response}

@endpoint GET /numbers/prime/is-prime
@desc Checks whether a given number is a known prime number or not.
@optional {number: int(integer) # Number to check}
@returns(200) 200 Success response
@errors {401: 401 Unauthorized response}

@endpoint GET /numbers/prime/is-mersenne-prime
@desc Checks whether a given number is a known mersenne prime number or not.
@optional {number: int(integer) # Number to check}
@returns(200) 200 Success response
@errors {401: 401 Unauthorized response}

@endpoint GET /numbers/prime/is-fermat-prime
@desc Checks whether a given number is a known fermat prime number or not.
@optional {number: int(integer) # Number to check}
@returns(200) 200 Success response
@errors {401: 401 Unauthorized response}

@endpoint GET /numbers/prime/is-pell-prime
@desc Checks whether a given number is a known pell prime number or not.
@optional {number: int(integer) # Number to check}
@returns(200) 200 Success response
@errors {401: 401 Unauthorized response}

@endpoint GET /numbers/prime/is-partition-prime
@desc Checks whether a given number is a known partition prime number or not.
@optional {number: int(integer) # Number to check}
@returns(200) 200 Success response
@errors {401: 401 Unauthorized response}

@endpoint GET /numbers/prime/is-fibonacci-prime
@desc Checks whether a given number is a known fibonacci prime number or not.
@optional {number: int(integer) # Number to check}
@returns(200) 200 Success response
@errors {401: 401 Unauthorized response}

@endpoint GET /numbers/prime/factors
@desc Get the prime factors of a given number.
@optional {number: int(integer) # Number to get the factors}
@returns(200) 200 Success response
@errors {401: 401 Unauthorized response}

@endpoint GET /numbers/is-palindrome
@desc Checks whether a given number is a palindrome number or not.
@optional {number: int(integer) # Number to check}
@returns(200) 200 Success response
@errors {401: 401 Unauthorized response}

@endpoint GET /numbers/is-triangle
@desc Checks whether a given number is a triangle number or not.
@optional {number: int(integer) # Number to check}
@returns(200) 200 Success response
@errors {401: 401 Unauthorized response}

@endpoint GET /numbers/is-cube
@desc Checks whether a given number is a cube number or not.
@optional {number: int(integer) # Number to check}
@returns(200) 200 Success response
@errors {401: 401 Unauthorized response}

@endpoint GET /numbers/is-square
@desc Checks whether a given number is a square number or not.
@optional {number: int(integer) # Number to check}
@returns(200) 200 Success response
@errors {401: 401 Unauthorized response}

@endpoint GET /numbers/prime/is-perfect
@desc Checks whether a given number is a perfect number or not.
@optional {number: int(integer) # Number to check}
@returns(200) 200 Success response
@errors {401: 401 Unauthorized response}

@end