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/ntropy:ntropy-categories-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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Reference Categories API
  version: 1.0.0
servers:
- url: https://api.ntropy.com
  description: Production server (uses live data).
tags:
- name: Categories
paths:
  /v3/categories/{id}:
    post:
      operationId: custom-categories-post-v-3-categories-id-post
      summary: Set a custom set of categories
      description: Sets a custom set of categories. Transactions that don't match a category will be categorized `not enough information` regardless of whether it is present in the set.
      tags:
      - Categories
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: X-Api-Key
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Custom categories successfully set.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomCategorySet'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomCategorySet'
    get:
      operationId: get-category-set-v-3-categories-id-get
      summary: Retrieve category set
      description: Retrieves the set of categories. Category sets are different per account holder type.
      tags:
      - Categories
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: X-Api-Key
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Category set for the selected type of account holder
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Categories_get_category_set_v3_categories__id__get_Response_200'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v3/categories/{id}/reset:
    post:
      operationId: delete-custom-category-set-v-3-categories-id-reset-post
      summary: Reset category set to original values
      description: Resets the set of categories of the specified account holder type to the original values.
      tags:
      - Categories
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: X-Api-Key
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/V3CategoriesIdResetPostResponsesContentApplicationJsonSchema'
                - type: 'null'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    CustomCategorySet:
      type: object
      properties:
        incoming:
          type: array
          items:
            type: string
        outgoing:
          type: array
          items:
            type: string
      required:
      - incoming
      - outgoing
      title: CustomCategorySet
    Categories_get_category_set_v3_categories__id__get_Response_200:
      oneOf:
      - $ref: '#/components/schemas/CategorySet'
      - type: object
        additionalProperties:
          description: Any type
      title: Categories_get_category_set_v3_categories__id__get_Response_200
    HTTPValidationError:
      type: object
      properties:
        detail:
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
      title: HTTPValidationError
    ValidationError:
      type: object
      properties:
        loc:
          type: array
          items:
            $ref: '#/components/schemas/ValidationErrorLocItems'
        msg:
          type: string
        type:
          type: string
      required:
      - loc
      - msg
      - type
      title: ValidationError
    V3CategoriesIdResetPostResponsesContentApplicationJsonSchema:
      oneOf:
      - $ref: '#/components/schemas/CategorySet'
      - type: object
        additionalProperties:
          description: Any type
      title: V3CategoriesIdResetPostResponsesContentApplicationJsonSchema
    CategorySet:
      type: object
      properties:
        incoming:
          type: array
          items:
            type: string
        outgoing:
          type: array
          items:
            type: string
      required:
      - incoming
      - outgoing
      title: CategorySet
    ValidationErrorLocItems:
      oneOf:
      - type: string
      - type: integer
      title: ValidationErrorLocItems
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-Api-Key
x-provenance:
  method: harvested
  publisher: Ntropy
  source: https://docs.ntropy.com/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)