@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Randommer API
@version v1
@auth ApiKey X-Api-Key in header
@common_fields {X-Api-Key: str # Enter your key}
@endpoints 25
@hint download_for_search
@toc api(25)

@endpoint GET /api/Card
@desc Get Card
@optional {type: str}
@returns(200) OK

@endpoint GET /api/Card/Types
@desc Get available card types
@returns(200) OK

@endpoint GET /api/Finance/CryptoAddress/Types
@desc Get available crypto types
@returns(200) OK

@endpoint GET /api/Finance/CryptoAddress
@desc Get crypto address
@optional {cryptoType: str}
@returns(200) OK

@endpoint GET /api/Finance/Iban/{countryCode}
@desc Get IBAN by countryCode
@required {countryCode: str}
@returns(200) OK

@endpoint GET /api/Finance/Countries
@desc Get available countries
@returns(200) OK

@endpoint POST /api/Finance/Vat/Validator
@required {country: str, vat: str}
@returns(200) OK

@endpoint GET /api/Misc/Cultures
@returns(200) OK

@endpoint GET /api/Misc/Random-Address
@required {number: int(int32)}
@optional {culture: str=en}
@returns(200) OK

@endpoint GET /api/Name
@desc Get name
@required {nameType: str, quantity: int(int32)}
@returns(200) OK

@endpoint GET /api/Name/Suggestions
@desc Get business name suggestions
@required {startingWords: str}
@returns(200) OK

@endpoint GET /api/Name/Cultures
@desc Get available cultures
@returns(200) OK

@endpoint POST /api/Name/BusinessName
@desc Get business names for a specific culture
@required {number: int(int32)}
@optional {cultureCode: str=en_US}
@returns(200) OK

@endpoint POST /api/Name/BrandName
@desc Generate brand name suggestions
@required {startingWords: str}
@returns(200) OK

@endpoint GET /api/Phone/Generate
@desc Get bulk telephone numbers for a country
@required {CountryCode: str, Quantity: int(int32)}
@returns(200) OK

@endpoint GET /api/Phone/IMEI
@desc Get bulk imeis
@required {Quantity: int(int32)}
@returns(200) OK

@endpoint GET /api/Phone/Validate
@desc Validate a phone number
@required {telephone: str}
@optional {CountryCode: str}
@returns(200) OK

@endpoint GET /api/Phone/Countries
@desc Get available countries
@returns(200) OK

@endpoint GET /api/SocialNumber
@desc Generate a social security number
@returns(200) OK

@endpoint POST /api/SocialNumber
@desc Validate VAT/identity numbers
@required {idType: str, number: str, country: str}
@returns(200) OK

@endpoint GET /api/Text/LoremIpsum
@desc Generate lorem ipsum
@required {loremType: str, type: str, number: int(int32)}
@returns(200) OK

@endpoint GET /api/Text/Password
@desc Generate password
@required {length: int(int32), hasDigits: bool, hasUppercase: bool, hasSpecial: bool}
@returns(200) OK

@endpoint POST /api/Text/Humanize
@desc Humanize text
@optional {text: str}
@returns(200) OK

@endpoint POST /api/Text/Transform
@desc Transform text
@required {textActionType: str}
@optional {caseType: str, find: str, replace: str, text: str}
@returns(200) OK

@endpoint POST /api/Text/Review
@desc Get reviews (max quantity=500)
@required {product: str, quantity: int(int32)}
@returns(200) OK

@end