Codequiry Auth API

Validate credentials and read account/quota.

GitHub OpenAPI

Operations 5

GET /auth/validate Validate API key #
POST /auth/validate Validate API key (POST) #
GET /account Get account & quota #
POST /account Get account & quota (POST) #
GET /status Service status #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/codequiry-com:codequiry-com-auth-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

codequiry-com-auth-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Codequiry Com Auth API
  version: 1.0.0
  contact:
    name: Codequiry Support
    url: https://codequiry.com/contact
  license:
    name: Proprietary
    url: https://codequiry.com/terms-of-service
  description: 'Operations tagged Auth across 2 of this provider''s published API definitions: codequiry-com-openapi-original.json, codequiry-com-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://codequiry.com/api/v1
  description: Production
security:
- apikey: []
tags:
- name: Auth
  description: Validate credentials and read account/quota.
paths:
  /auth/validate:
    get:
      tags:
      - Auth
      operationId: validateApiKeyGet
      summary: Validate API key
      description: Confirms the supplied `apikey` header is valid and returns the owning account.
      responses:
        '200':
          description: Key is valid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyValidation'
        '401':
          $ref: '#/components/responses/InvalidKey'
        '402':
          $ref: '#/components/responses/BillingSuspended'
        '429':
          $ref: '#/components/responses/RateLimited'
    post:
      tags:
      - Auth
      operationId: validateApiKeyPost
      summary: Validate API key (POST)
      description: Identical to the GET form.
      responses:
        '200':
          description: Key is valid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyValidation'
        '401':
          $ref: '#/components/responses/InvalidKey'
        '402':
          $ref: '#/components/responses/BillingSuspended'
        '429':
          $ref: '#/components/responses/RateLimited'
    servers:
    - url: https://codequiry.com/api/v1
      description: Production
  /account:
    get:
      tags:
      - Auth
      operationId: getAccount
      summary: Get account & quota
      description: Returns the authenticated user's profile, plan, and remaining check quota.
      responses:
        '200':
          description: Account info
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Account'
        '401':
          $ref: '#/components/responses/InvalidKey'
        '402':
          $ref: '#/components/responses/BillingSuspended'
        '429':
          $ref: '#/components/responses/RateLimited'
    post:
      tags:
      - Auth
      operationId: getAccountPost
      summary: Get account & quota (POST)
      responses:
        '200':
          description: Account info
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Account'
        '401':
          $ref: '#/components/responses/InvalidKey'
        '402':
          $ref: '#/components/responses/BillingSuspended'
        '429':
          $ref: '#/components/responses/RateLimited'
    servers:
    - url: https://codequiry.com/api/v1
      description: Production
  /status:
    get:
      tags:
      - Auth
      operationId: getStatus
      summary: Service status
      description: Whether the checking engine (core) and its live-progress stream are up, from a one-minute cache shared with the dashboard's status badge. Poll this rather than the engine host itself; it costs one upstream probe a minute however many clients ask.
      responses:
        '200':
          description: Engine status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EngineStatus'
        '401':
          $ref: '#/components/responses/InvalidKey'
        '402':
          $ref: '#/components/responses/BillingSuspended'
        '429':
          $ref: '#/components/responses/RateLimited'
    servers:
    - url: https://codequiry.com/api/v1
      description: Production
components:
  schemas:
    EngineStatus:
      type: object
      properties:
        online:
          type: boolean
          example: true
          description: true only when both core and stream are up.
        core:
          type: object
          properties:
            online:
              type: boolean
              example: true
        stream:
          type: object
          properties:
            online:
              type: boolean
              example: true
            subscribers:
              type: integer
              nullable: true
              example: 3
        latency_ms:
          type: integer
          example: 412
        cached_at:
          type: string
          example: '2026-08-21T11:40:00+00:00'
        stale:
          type: boolean
          example: false
          description: Present when a probe was already running and the last known answer was served instead.
    Error:
      type: object
      properties:
        error:
          type: string
          example: Invalid check_id provided.
    KeyValidation:
      type: object
      properties:
        valid:
          type: boolean
          example: true
        user_id:
          type: integer
          example: 20481
        email:
          type: string
          example: d.whitfield@university.edu
        name:
          type: string
          example: Dana Whitfield
    Account:
      type: object
      properties:
        id:
          type: integer
          example: 20481
        name:
          type: string
          example: Dana Whitfield
        email:
          type: string
          example: d.whitfield@university.edu
        quota:
          type: object
          properties:
            remaining:
              type: integer
              example: 842
            total:
              type: integer
              example: 1000
            unlimited:
              type: boolean
              example: false
            checks_remaining:
              type: integer
              example: 842
            reset_date:
              type: string
              nullable: true
              example: '2026-09-01 00:00:00'
        submissions:
          type: integer
          example: 1364
        is_pro:
          type: boolean
          example: true
        plan_id:
          type: integer
          nullable: true
          example: 2
        edu_verified:
          type: boolean
          example: true
  responses:
    BillingSuspended:
      description: The account is suspended for an unpaid invoice. Every endpoint returns this until the invoice is paid from the billing dashboard; it is not retryable and the request was not performed.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
              invoice:
                type: string
                nullable: true
                description: Stripe invoice id of the unpaid invoice.
          example:
            error: Account suspended due to an unpaid invoice. Pay the outstanding invoice from your billing dashboard to restore API access.
            invoice: in_1QxYz...
    InvalidKey:
      description: Missing or invalid API key. The API key is checked before any endpoint logic runs, so this is returned for every operation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            missing:
              summary: No apikey header
              value:
                error: No API Key (apikey) provided in header request
            invalid:
              summary: Unknown or malformed key
              value:
                error: Unauthorized, make sure your API Key is valid an associated with an account. Create an account at codequiry.com
    RateLimited:
      description: 'Rate limit exceeded: more than 60 requests in one minute from this IP. Retry after the number of seconds in the Retry-After header. Successful responses carry X-RateLimit-Limit and X-RateLimit-Remaining too, so you can pace a client without waiting to be refused.'
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
        X-RateLimit-Limit:
          description: Always 60.
          schema:
            type: integer
        X-RateLimit-Remaining:
          description: Calls left in the window (0 here).
          schema:
            type: integer
        X-RateLimit-Reset:
          description: Unix timestamp when the window reopens. Sent only on 429.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    apikey:
      type: apiKey
      in: header
      name: apikey
      description: Your 64-character API key from the Codequiry dashboard.
x-refined-from:
- codequiry-com-openapi-original.json
- codequiry-com-openapi.yml