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/hackforddata-com:hackforddata-com-saved-searches-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: Hackford Public Saved searches API
  version: v1
  description: Versioned public API for Hackford regulated-firm intelligence. Firm type is Hackford's public regulated-firm grouping contract.
  contact:
    email: support@hackforddata.com
servers:
- url: https://api.hackforddata.com/v1
  description: Production
tags:
- name: Saved searches
paths:
  /saved-searches:
    get:
      operationId: saved_searches_list
      tags:
      - Saved searches
      security:
      - OAuthAccessTokenAuth: []
      - PublicApiKeyAuth: []
      - jwtAuth: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PublicApiSavedSearch'
          description: ''
      summary: Saved searches list
      x-summary-source: derived
    post:
      operationId: saved_searches_create
      tags:
      - Saved searches
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicApiSavedSearchRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PublicApiSavedSearchRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PublicApiSavedSearchRequest'
        required: true
      security:
      - OAuthAccessTokenAuth: []
      - PublicApiKeyAuth: []
      - jwtAuth: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiSavedSearch'
          description: ''
      summary: Saved searches create
      x-summary-source: derived
  /saved-searches/{saved_search_id}:
    get:
      operationId: saved_searches_retrieve
      parameters:
      - in: path
        name: saved_search_id
        schema:
          type: integer
        required: true
      tags:
      - Saved searches
      security:
      - OAuthAccessTokenAuth: []
      - PublicApiKeyAuth: []
      - jwtAuth: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiSavedSearch'
          description: ''
      summary: Saved searches retrieve
      x-summary-source: derived
    patch:
      operationId: saved_searches_partial_update
      parameters:
      - in: path
        name: saved_search_id
        schema:
          type: integer
        required: true
      tags:
      - Saved searches
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedPublicApiSavedSearchRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedPublicApiSavedSearchRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedPublicApiSavedSearchRequest'
      security:
      - OAuthAccessTokenAuth: []
      - PublicApiKeyAuth: []
      - jwtAuth: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiSavedSearch'
          description: ''
      summary: Saved searches partial update
      x-summary-source: derived
    delete:
      operationId: saved_searches_destroy
      parameters:
      - in: path
        name: saved_search_id
        schema:
          type: integer
        required: true
      tags:
      - Saved searches
      security:
      - OAuthAccessTokenAuth: []
      - PublicApiKeyAuth: []
      - jwtAuth: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '204':
          description: No response body
      summary: Saved searches destroy
      x-summary-source: derived
  /saved-searches/{saved_search_id}/results:
    get:
      operationId: saved_searches_results_retrieve
      description: Execute a supported firm saved search using its stored Search Builder definition. Unsupported criteria return an error and are never ignored.
      summary: Run a saved search
      parameters:
      - in: query
        name: page
        schema:
          type: integer
      - in: query
        name: page_size
        schema:
          type: integer
      - in: path
        name: saved_search_id
        schema:
          type: integer
        required: true
      tags:
      - Saved searches
      security:
      - OAuthAccessTokenAuth: []
      - PublicApiKeyAuth: []
      - jwtAuth: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
          description: ''
  /saved-searches/{saved_search_id}/watchlist:
    post:
      operationId: saved_searches_watchlist_create
      description: Execute a supported firm saved search and atomically create a watchlist containing every match. Unsupported criteria are never ignored.
      summary: Create a watchlist from a saved search
      parameters:
      - in: path
        name: saved_search_id
        schema:
          type: integer
        required: true
      tags:
      - Saved searches
      requestBody:
        content:
          application/json:
            schema:
              type: object
              additionalProperties: {}
          application/x-www-form-urlencoded:
            schema:
              type: object
              additionalProperties: {}
          multipart/form-data:
            schema:
              type: object
              additionalProperties: {}
      security:
      - OAuthAccessTokenAuth: []
      - PublicApiKeyAuth: []
      - jwtAuth: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
          description: ''
components:
  schemas:
    PublicApiSavedSearch:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        scope:
          type: string
          readOnly: true
        can_edit:
          type: boolean
          readOnly: true
        name:
          type: string
          maxLength: 120
        entity_type:
          $ref: '#/components/schemas/EntityTypeEnum'
        definition_version:
          type: integer
          readOnly: true
        definition: {}
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - can_edit
      - created_at
      - definition_version
      - entity_type
      - id
      - name
      - scope
      - updated_at
    EntityTypeEnum:
      enum:
      - firms
      - people
      type: string
      description: '* `firms` - firms

        * `people` - people'
    PatchedPublicApiSavedSearchRequest:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 120
        entity_type:
          $ref: '#/components/schemas/EntityTypeEnum'
        definition: {}
    PublicApiSavedSearchRequest:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 120
        entity_type:
          $ref: '#/components/schemas/EntityTypeEnum'
        definition: {}
      required:
      - entity_type
      - name
  securitySchemes:
    OAuthAccessTokenAuth:
      type: http
      scheme: bearer
      bearerFormat: OAuth 2.1 access token
    PublicApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: Hackford public API key
    cookieAuth:
      type: apiKey
      in: cookie
      name: sessionid
    jwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"