api-ninjas-com Sales Tax Calculator by API Ninjas API

openapi: 3.2.0
info:
  title: Sales Tax Calculator by API Ninjas API
  description: 'Combined OpenAPI specification for every API Ninjas endpoint. Requests go to https://api.api-ninjas.com with an `X-Api-Key` header; get a free key at https://api-ninjas.com/register. Human-readable docs: https://api-ninjas.com/api. Index for LLMs: https://api-ninjas.com/llms.txt.'
  version: 1.0.0
  contact:
    name: API Ninjas
    url: https://api-ninjas.com
  license:
    name: Proprietary
servers:
- url: https://api.api-ninjas.com
  description: API Ninjas Production
security:
- ApiKeyAuth: []
tags:
- name: Sales Tax Calculator by API Ninjas
  description: The Sales Tax Calculator API provides accurate and detailed sales tax calculations for any purchase amount in the United States, including tax breakdowns and total amounts.
paths:
  /v1/salestaxcalculator:
    get:
      summary: Calculates sales tax for a given amount and location
      description: Calculates US sales tax on a purchase amount for a location given by ZIP code or by city and state, returning the tax breakdown and total. Requires `amount`.
      operationId: calculateSalesTax
      security:
      - ApiKeyAuth: []
      parameters:
      - name: amount
        in: query
        required: true
        schema:
          type: number
          format: float
        description: Purchase amount to calculate tax on.
      - name: zip_code
        in: query
        required: false
        schema:
          type: string
        description: Valid US ZIP code.
      - name: street_address
        in: query
        required: false
        schema:
          type: string
        description: Street address (e.g. 9641 Sunset Blvd). Used together with city and state for the most accurate lookup.
      - name: city
        in: query
        required: false
        schema:
          type: string
        description: City name.
      - name: state
        in: query
        required: false
        schema:
          type: string
        description: State name.
      responses:
        '200':
          description: Successful response with sales tax details.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SalesTaxCalculatorResponse'
        '400':
          description: Bad Request - Invalid request format or parameters.
        '401':
          description: Unauthorized - API key missing or invalid.
        '500':
          description: Internal Server Error - An error occurred on the server.
      tags:
      - Sales Tax Calculator by API Ninjas
components:
  schemas:
    SalesTaxCalculatorResponse:
      type: object
      properties:
        street_address:
          type: string
          description: The street address from the request. Only returned when the street_address parameter is provided.
        zip_code:
          type: string
          description: The ZIP code for which tax information is returned.
        pre_tax_amount:
          type: string
          description: The purchase amount the tax was calculated on.
        state_rate:
          type: number
          description: State sales tax rate as a decimal.
        city_rate:
          type:
          - number
          - 'null'
          description: City sales tax rate as a decimal.
        county_rate:
          type:
          - number
          - 'null'
          description: County sales tax rate as a decimal.
        additional_rate:
          type:
          - number
          - 'null'
          description: Additional special district sales tax rate as a decimal.
        total_rate:
          type:
          - number
          - 'null'
          description: Total combined sales tax rate of state, county, city, and additional rates as a decimal.
        state_tax:
          type: number
          description: The calculated state sales tax amount.
        city_tax:
          type:
          - number
          - 'null'
          description: The calculated city sales tax amount.
        county_tax:
          type:
          - number
          - 'null'
          description: The calculated county sales tax amount.
        additional_tax:
          type:
          - number
          - 'null'
          description: The calculated additional special district sales tax amount.
        total_tax:
          type:
          - number
          - 'null'
          description: The total calculated sales tax amount.
        total_price:
          type:
          - number
          - 'null'
          description: The total amount including tax.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
externalDocs:
  description: API Ninjas documentation
  url: https://api-ninjas.com/api