{
  "openapi": "3.0.1",
  "info": {
    "title": "Hacker News Mention Monitor - Keyword, Brand & Domain Alerts",
    "description": "Get alerted when Hacker News mentions your brand, product, keyword, domain or a user, in stories AND comments. Whole-word matching (no fuzzy junk), monitor mode returns only new hits, sweeps past the 1,000-result cap. Official free HN API. $0.50 per 1,000 mentions.",
    "version": "1.0",
    "x-build-id": "1a97tSLnnEh3AEgcG"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/tali-works~hacker-news-mention-monitor/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-tali-works-hacker-news-mention-monitor",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/tali-works~hacker-news-mention-monitor/runs": {
      "post": {
        "operationId": "runs-sync-tali-works-hacker-news-mention-monitor",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/tali-works~hacker-news-mention-monitor/run-sync": {
      "post": {
        "operationId": "run-sync-tali-works-hacker-news-mention-monitor",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "properties": {
          "keywords": {
            "title": "Keywords, brands or product names",
            "type": "array",
            "description": "Words or phrases to watch, e.g. your brand, product, competitor or a topic. Case-insensitive, whole-word match in the story title, story text, story URL or the comment's own text. Phrases like 'open source' also match 'open-source'.",
            "items": {
              "type": "string"
            }
          },
          "domains": {
            "title": "Domains / URLs",
            "type": "array",
            "description": "Domains to watch, e.g. example.com or https://blog.example.com. Matches stories linking to the domain (or any subdomain) and stories/comments whose text contains a link to it.",
            "items": {
              "type": "string"
            }
          },
          "authors": {
            "title": "HN usernames (posted by)",
            "type": "array",
            "description": "Return every story/comment posted by these Hacker News users (e.g. a founder, competitor or your own team). Username or https://news.ycombinator.com/user?id=... URL. To catch people mentioning a username, add it to Keywords instead.",
            "items": {
              "type": "string"
            }
          },
          "includeStories": {
            "title": "Search stories",
            "type": "boolean",
            "description": "Stories, Show HN, Ask HN, jobs.",
            "default": true
          },
          "includeComments": {
            "title": "Search comments",
            "type": "boolean",
            "description": "A comment matches only if the comment itself mentions your term (not just the story it sits under).",
            "default": true
          },
          "lookbackDays": {
            "title": "Look back (days)",
            "minimum": 0,
            "type": "number",
            "description": "How far back to search on a normal run or on the first monitor run. Later monitor runs only scan since the previous run (with a 3-hour safety overlap). Use decimals for hours, e.g. 0.25 = 6 hours.",
            "default": 7
          },
          "since": {
            "title": "Since (date)",
            "type": "string",
            "description": "Optional. Overrides 'Look back'. YYYY-MM-DD, ISO timestamp (UTC if no zone) or unix seconds."
          },
          "minPoints": {
            "title": "Min points (stories)",
            "minimum": 0,
            "type": "integer",
            "description": "Only stories with at least this score. Comments have no public score, so they are not filtered by this."
          },
          "excludeKeywords": {
            "title": "Exclude if text contains",
            "type": "array",
            "description": "Drop hits that mention any of these words (whole word), e.g. to remove an unrelated meaning of your brand name.",
            "items": {
              "type": "string"
            }
          },
          "matchMode": {
            "title": "Match mode",
            "enum": [
              "wholeWord",
              "substring"
            ],
            "type": "string",
            "description": "The HN search engine also returns prefix and partial matches; every hit is re-checked against your term. Whole word: 'Acme' matches 'Acme' and 'acme.io' but not 'Acmes' or 'Acmex'.",
            "default": "wholeWord"
          },
          "maxTotalItems": {
            "title": "Max mentions per run (cost cap)",
            "minimum": 0,
            "type": "integer",
            "description": "Stop after this many output rows (newest first). 0 = no cap. In monitor mode, if a run is capped the remaining mentions are returned on the next run.",
            "default": 1000
          },
          "onlyNew": {
            "title": "Monitor mode: only new mentions",
            "type": "boolean",
            "description": "Remember what earlier runs returned (named key-value store 'hn-mention-monitor-state') and output only mentions not seen before. Already-seen hits are free. Schedule the Actor (Schedules > Create), e.g. hourly.",
            "default": false
          },
          "monitorKey": {
            "title": "Monitor key",
            "type": "string",
            "description": "Optional name for this monitor's memory, e.g. 'acme-brand'. Keeps the memory when you edit the input. By default the key is derived from your terms and filters, so changing them starts a fresh baseline."
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}