openapi: 3.0.1
info:
  title: Randommer API
  version: v1
  x-apisguru-categories:
    - developer_tools
  x-origin:
    - format: openapi
      url: https://randommer.io/api/docs/v1/swagger.json
      version: "3.0"
  x-providerName: randommer.io
paths:
  /api/Card:
    get:
      parameters:
        - description: ""
          in: query
          name: type
          schema:
            type: string
        - description: Enter your key
          in: header
          name: X-Api-Key
          schema:
            type: string
      responses:
        "200":
          description: Success
      summary: Get Card
      tags:
        - Card
  /api/Card/Types:
    get:
      parameters:
        - description: Enter your key
          in: header
          name: X-Api-Key
          schema:
            type: string
      responses:
        "200":
          description: Success
      summary: Get available card types
      tags:
        - Card
  /api/Finance/Countries:
    get:
      parameters:
        - description: Enter your key
          in: header
          name: X-Api-Key
          schema:
            type: string
      responses:
        "200":
          description: Success
      summary: Get available countries
      tags:
        - Finance
  /api/Finance/CryptoAddress:
    get:
      parameters:
        - description: ""
          in: query
          name: cryptoType
          schema:
            maxLength: 100
            type: string
        - description: Enter your key
          in: header
          name: X-Api-Key
          schema:
            type: string
      responses:
        "200":
          description: Success
      summary: Get crypto address
      tags:
        - Finance
  /api/Finance/CryptoAddress/Types:
    get:
      parameters:
        - description: Enter your key
          in: header
          name: X-Api-Key
          schema:
            type: string
      responses:
        "200":
          description: Success
      summary: Get available crypto types
      tags:
        - Finance
  "/api/Finance/Iban/{countryCode}":
    get:
      parameters:
        - description: ""
          in: path
          name: countryCode
          required: true
          schema:
            maxLength: 2
            type: string
        - description: Enter your key
          in: header
          name: X-Api-Key
          schema:
            type: string
      responses:
        "200":
          description: Success
      summary: Get IBAN by countryCode
      tags:
        - Finance
  /api/Finance/Vat/Validator:
    post:
      parameters:
        - in: query
          name: country
          required: true
          schema:
            type: string
        - in: query
          name: vat
          required: true
          schema:
            type: string
        - description: Enter your key
          in: header
          name: X-Api-Key
          schema:
            type: string
      responses:
        "200":
          description: Success
      tags:
        - Finance
  /api/Misc/Cultures:
    get:
      parameters:
        - description: Enter your key
          in: header
          name: X-Api-Key
          schema:
            type: string
      responses:
        "200":
          description: Success
      tags:
        - Misc
  /api/Misc/Random-Address:
    get:
      parameters:
        - in: query
          name: number
          required: true
          schema:
            format: int32
            maximum: 1000
            minimum: 1
            type: integer
        - in: query
          name: culture
          schema:
            default: en
            maxLength: 100
            type: string
        - description: Enter your key
          in: header
          name: X-Api-Key
          schema:
            type: string
      responses:
        "200":
          description: Success
      tags:
        - Misc
  /api/Name:
    get:
      parameters:
        - description: ""
          in: query
          name: nameType
          required: true
          schema:
            $ref: "#/components/schemas/NameType"
        - description: ""
          in: query
          name: quantity
          required: true
          schema:
            format: int32
            maximum: 5000
            minimum: 1
            type: integer
        - description: Enter your key
          in: header
          name: X-Api-Key
          schema:
            type: string
      responses:
        "200":
          description: Success
      summary: Get name
      tags:
        - Name
  /api/Name/BrandName:
    post:
      parameters:
        - description: ""
          in: query
          name: startingWords
          required: true
          schema:
            maxLength: 100
            type: string
        - description: Enter your key
          in: header
          name: X-Api-Key
          schema:
            type: string
      responses:
        "200":
          description: Success
      summary: Generate brand name suggestions
      tags:
        - Name
  /api/Name/BusinessName:
    post:
      parameters:
        - description: ""
          in: query
          name: number
          required: true
          schema:
            format: int32
            maximum: 1000
            minimum: 1
            type: integer
        - description: ""
          in: query
          name: cultureCode
          schema:
            default: en_US
            type: string
        - description: Enter your key
          in: header
          name: X-Api-Key
          schema:
            type: string
      responses:
        "200":
          description: Success
      summary: Get business names for a specific culture
      tags:
        - Name
  /api/Name/Cultures:
    get:
      parameters:
        - description: Enter your key
          in: header
          name: X-Api-Key
          schema:
            type: string
      responses:
        "200":
          description: Success
      summary: Get available cultures
      tags:
        - Name
  /api/Name/Suggestions:
    get:
      parameters:
        - description: ""
          in: query
          name: startingWords
          required: true
          schema:
            maxLength: 100
            type: string
        - description: Enter your key
          in: header
          name: X-Api-Key
          schema:
            type: string
      responses:
        "200":
          description: Success
      summary: Get business name suggestions
      tags:
        - Name
  /api/Phone/Countries:
    get:
      parameters:
        - description: Enter your key
          in: header
          name: X-Api-Key
          schema:
            type: string
      responses:
        "200":
          description: Success
      summary: Get available countries
      tags:
        - Phone
  /api/Phone/Generate:
    get:
      parameters:
        - description: ""
          in: query
          name: CountryCode
          required: true
          schema:
            maxLength: 2
            type: string
        - description: ""
          in: query
          name: Quantity
          required: true
          schema:
            format: int32
            maximum: 1000
            minimum: 1
            type: integer
        - description: Enter your key
          in: header
          name: X-Api-Key
          schema:
            type: string
      responses:
        "200":
          description: Success
      summary: Get bulk telephone numbers for a country
      tags:
        - Phone
  /api/Phone/IMEI:
    get:
      parameters:
        - description: ""
          in: query
          name: Quantity
          required: true
          schema:
            format: int32
            maximum: 1000
            minimum: 1
            type: integer
        - description: Enter your key
          in: header
          name: X-Api-Key
          schema:
            type: string
      responses:
        "200":
          description: Success
      summary: Get bulk imeis
      tags:
        - Phone
  /api/Phone/Validate:
    get:
      parameters:
        - description: ""
          in: query
          name: telephone
          required: true
          schema:
            maxLength: 25
            type: string
        - description: ""
          in: query
          name: CountryCode
          schema:
            maxLength: 2
            type: string
        - description: Enter your key
          in: header
          name: X-Api-Key
          schema:
            type: string
      responses:
        "200":
          description: Success
      summary: Validate a phone number
      tags:
        - Phone
  /api/SocialNumber:
    get:
      parameters:
        - description: Enter your key
          in: header
          name: X-Api-Key
          schema:
            type: string
      responses:
        "200":
          description: Success
      summary: Generate a social security number
      tags:
        - SocialNumber
    post:
      parameters:
        - in: query
          name: idType
          required: true
          schema:
            $ref: "#/components/schemas/IdType"
        - description: Enter your key
          in: header
          name: X-Api-Key
          schema:
            type: string
      requestBody:
        content:
          application/*+json:
            schema:
              $ref: "#/components/schemas/NumberValidation"
          application/json:
            schema:
              $ref: "#/components/schemas/NumberValidation"
          application/json-patch+json:
            schema:
              $ref: "#/components/schemas/NumberValidation"
          text/json:
            schema:
              $ref: "#/components/schemas/NumberValidation"
        required: true
      responses:
        "200":
          description: Success
      summary: Validate VAT/identity numbers
      tags:
        - SocialNumber
  /api/Text/Humanize:
    post:
      parameters:
        - description: Enter your key
          in: header
          name: X-Api-Key
          schema:
            type: string
      requestBody:
        content:
          application/*+json:
            schema:
              $ref: "#/components/schemas/TextDto"
          application/json:
            schema:
              $ref: "#/components/schemas/TextDto"
          application/json-patch+json:
            schema:
              $ref: "#/components/schemas/TextDto"
          text/json:
            schema:
              $ref: "#/components/schemas/TextDto"
        description: ""
        required: true
      responses:
        "200":
          description: Success
      summary: Humanize text
      tags:
        - Text
  /api/Text/LoremIpsum:
    get:
      parameters:
        - description: ""
          in: query
          name: loremType
          required: true
          schema:
            $ref: "#/components/schemas/LoremType"
        - description: ""
          in: query
          name: type
          required: true
          schema:
            $ref: "#/components/schemas/TextType"
        - description: ""
          in: query
          name: number
          required: true
          schema:
            format: int32
            maximum: 2147483647
            minimum: 1
            type: integer
        - description: Enter your key
          in: header
          name: X-Api-Key
          schema:
            type: string
      responses:
        "200":
          description: Success
      summary: Generate lorem ipsum
      tags:
        - Text
  /api/Text/Password:
    get:
      parameters:
        - description: ""
          in: query
          name: length
          required: true
          schema:
            format: int32
            maximum: 250
            minimum: 3
            type: integer
        - description: ""
          in: query
          name: hasDigits
          required: true
          schema:
            type: boolean
        - description: ""
          in: query
          name: hasUppercase
          required: true
          schema:
            type: boolean
        - description: ""
          in: query
          name: hasSpecial
          required: true
          schema:
            type: boolean
        - description: Enter your key
          in: header
          name: X-Api-Key
          schema:
            type: string
      responses:
        "200":
          description: Success
      summary: Generate password
      tags:
        - Text
  /api/Text/Review:
    post:
      parameters:
        - description: ""
          in: query
          name: product
          required: true
          schema:
            maxLength: 50
            type: string
        - description: ""
          in: query
          name: quantity
          required: true
          schema:
            format: int32
            maximum: 500
            minimum: 1
            type: integer
        - description: Enter your key
          in: header
          name: X-Api-Key
          schema:
            type: string
      responses:
        "200":
          description: Success
      summary: Get reviews (max quantity=500)
      tags:
        - Text
  /api/Text/Transform:
    post:
      parameters:
        - description: ""
          in: query
          name: textActionType
          required: true
          schema:
            $ref: "#/components/schemas/TextActionType"
        - description: ""
          in: query
          name: caseType
          schema:
            $ref: "#/components/schemas/CaseType"
        - description: ""
          in: query
          name: find
          schema:
            type: string
        - description: ""
          in: query
          name: replace
          schema:
            type: string
        - description: Enter your key
          in: header
          name: X-Api-Key
          schema:
            type: string
      requestBody:
        content:
          application/*+json:
            schema:
              $ref: "#/components/schemas/TextDto"
          application/json:
            schema:
              $ref: "#/components/schemas/TextDto"
          application/json-patch+json:
            schema:
              $ref: "#/components/schemas/TextDto"
          text/json:
            schema:
              $ref: "#/components/schemas/TextDto"
        description: ""
        required: true
      responses:
        "200":
          description: Success
      summary: Transform text
      tags:
        - Text
components:
  schemas:
    CaseType:
      enum:
        - LowerCase
        - UpperCase
        - SentenceCase
        - TitleCase
      type: string
    IdType:
      enum:
        - VAT
        - SSN
      type: string
    LoremType:
      enum:
        - normal
        - business
      type: string
    NameType:
      enum:
        - firstname
        - surname
        - fullname
      type: string
    NumberValidation:
      additionalProperties: false
      properties:
        country:
          maxLength: 2
          minLength: 1
          type: string
        number:
          maxLength: 100
          minLength: 1
          type: string
      required:
        - country
        - number
      type: object
    TextActionType:
      enum:
        - Transform
        - Replace
      type: string
    TextDto:
      additionalProperties: false
      properties:
        text:
          nullable: true
          type: string
      type: object
    TextType:
      enum:
        - paragraphs
        - words
      type: string
