api-ninjas-com Places API

openapi: 3.2.0
info:
  title: Ninjas Places 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: Places
paths:
  /v1/county:
    get:
      tags:
      - Places
      summary: Get County Information
      description: Returns details for one or more counties matching the input parameters.
      operationId: getCounty
      parameters:
      - name: county
        in: query
        description: Full name of the county to search.
        required: false
        schema:
          type: string
      - name: zipcode
        in: query
        description: 5-digit ZIP code to search.
        required: false
        schema:
          type: string
      - name: state
        in: query
        description: 2-letter state code (case-insensitive).
        required: false
        schema:
          type: string
      - name: limit
        in: query
        description: Number of results to return. Must be between 1 and 30. Default is 1.
        required: false
        schema:
          type: integer
          default: 1
          minimum: 1
          maximum: 30
      - name: offset
        in: query
        description: Number of results to offset for pagination. Default is 0.
        required: false
        schema:
          type: integer
          default: 0
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CountyResponse'
        '400':
          $ref: '#/components/responses/CountyOpenapi_BadRequest'
        '401':
          $ref: '#/components/responses/CountyOpenapi_Unauthorized'
        '500':
          $ref: '#/components/responses/CountyOpenapi_InternalServerError'
      security:
      - ApiKeyAuth: []
  /v1/unemployment:
    get:
      tags:
      - Places
      summary: Get unemployment data for a given country
      description: Returns national unemployment rates, optionally filtered by `country` and `year`. Omit both to retrieve the latest figures across countries.
      operationId: getUnemploymentData
      parameters:
      - $ref: '#/components/parameters/UnemploymentOpenapi_country'
      - $ref: '#/components/parameters/UnemploymentOpenapi_year'
      responses:
        '200':
          description: Successful response with unemployment data.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnemploymentResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnemploymentOpenapi_Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnemploymentOpenapi_Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnemploymentOpenapi_Error'
      security:
      - ApiKeyAuth: []
components:
  schemas:
    CountyResponse:
      type: array
      items:
        type: object
        properties:
          county_name:
            type: string
          county_fips:
            type: string
          state_code:
            type: string
          state_name:
            type: string
          latitude:
            type: string
          longitude:
            type: string
          timezone:
            type: string
          zip_codes:
            type: array
            items:
              type: string
          population:
            type: integer
          median_age:
            type: number
    UnemploymentResponse:
      type: array
      items:
        type: object
        properties:
          country:
            type: string
            example: CAN
          year:
            type: integer
            example: 1980
          unemployment_rate:
            type: number
            example: 7.5
    UnemploymentOpenapi_Error:
      type: object
      properties:
        message:
          type: string
        status:
          type: integer
  parameters:
    UnemploymentOpenapi_country:
      in: query
      name: country
      schema:
        type: string
      required: false
      description: Country name (case-insensitive) or 2-letter ISO-3166 alpha-2 code of the country. E.g. 'Canada' or 'CA'.
    UnemploymentOpenapi_year:
      in: query
      name: year
      schema:
        type: integer
      required: false
      description: Year for which to retrieve unemployment data.
  responses:
    CountyOpenapi_Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
    CountyOpenapi_InternalServerError:
      description: Internal Server Error
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
    CountyOpenapi_BadRequest:
      description: Bad Request
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
externalDocs:
  description: API Ninjas documentation
  url: https://api-ninjas.com/api