@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
@returns(200)
@errors {401}

@endpoint GET /numbers/fact
@required {number: int(integer)}
@returns(200)
@errors {401}

@endpoint GET /numbers/random
@optional {min: int(integer), max: int(integer), total: int(integer)}
@returns(200)
@errors {401}

@endpoint GET /numbers/ordinal
@optional {number: int(integer)}
@returns(200)
@errors {401}

@endpoint GET /numbers/cardinal
@optional {number: int(integer), language: str(string)}
@returns(200)
@errors {401}

@endpoint GET /numbers/currency
@optional {number: int(integer), language: str(string)}
@returns(200)
@errors {401}

@endpoint GET /numbers/numeral/egyptian
@optional {number: int(integer)}
@returns(200)
@errors {401}

@endpoint GET /numbers/numeral/chinese
@optional {number: int(integer)}
@returns(200)
@errors {401}

@endpoint GET /numbers/numeral/roman
@optional {number: int(integer)}
@returns(200)
@errors {401}

@endpoint GET /numbers/base/binary
@required {number: int(integer)}
@optional {from: int(integer)}
@returns(200)
@errors {401}

@endpoint GET /numbers/base/octal
@required {number: int(integer)}
@optional {from: int(integer)}
@returns(200)
@errors {401}

@endpoint GET /numbers/base/hex
@required {number: int(integer)}
@optional {from: int(integer)}
@returns(200)
@errors {401}

@endpoint GET /numbers/base
@required {number: int(integer), to: int(integer)}
@optional {from: int(integer)}
@returns(200)
@errors {401}

@endpoint GET /numbers/pi
@optional {from: int(integer), to: int(integer)}
@returns(200)
@errors {401}

@endpoint GET /numbers/prime/is-prime
@optional {number: int(integer)}
@returns(200)
@errors {401}

@endpoint GET /numbers/prime/is-mersenne-prime
@optional {number: int(integer)}
@returns(200)
@errors {401}

@endpoint GET /numbers/prime/is-fermat-prime
@optional {number: int(integer)}
@returns(200)
@errors {401}

@endpoint GET /numbers/prime/is-pell-prime
@optional {number: int(integer)}
@returns(200)
@errors {401}

@endpoint GET /numbers/prime/is-partition-prime
@optional {number: int(integer)}
@returns(200)
@errors {401}

@endpoint GET /numbers/prime/is-fibonacci-prime
@optional {number: int(integer)}
@returns(200)
@errors {401}

@endpoint GET /numbers/prime/factors
@optional {number: int(integer)}
@returns(200)
@errors {401}

@endpoint GET /numbers/is-palindrome
@optional {number: int(integer)}
@returns(200)
@errors {401}

@endpoint GET /numbers/is-triangle
@optional {number: int(integer)}
@returns(200)
@errors {401}

@endpoint GET /numbers/is-cube
@optional {number: int(integer)}
@returns(200)
@errors {401}

@endpoint GET /numbers/is-square
@optional {number: int(integer)}
@returns(200)
@errors {401}

@endpoint GET /numbers/prime/is-perfect
@optional {number: int(integer)}
@returns(200)
@errors {401}

@end