openapi: 3.1.0 info: version: 0.0.43 title: Indexer Restful API servers: - url: https://api.ethcomments.xyz description: Production Indexer API components: schemas: APIBadRequestValidationErrorResponse: type: object properties: issues: type: array items: oneOf: - type: object properties: fatal: type: boolean message: type: string path: type: array items: anyOf: - type: string - type: number code: type: string enum: - invalid_type expected: type: string received: type: string required: - path - code - expected - received - type: object properties: fatal: type: boolean message: type: string path: type: array items: anyOf: - type: string - type: number code: type: string enum: - invalid_literal expected: {} received: {} required: - path - code - type: object properties: fatal: type: boolean message: type: string path: type: array items: anyOf: - type: string - type: number code: type: string enum: - unrecognized_keys keys: type: array items: type: string required: - path - code - keys - type: object properties: fatal: type: boolean message: type: string path: type: array items: anyOf: - type: string - type: number code: type: string enum: - invalid_union unionErrors: type: array items: type: object properties: issues: type: array items: $ref: >- #/components/schemas/APIBadRequestValidationErrorResponse required: - path - code - unionErrors - type: object properties: fatal: type: boolean message: type: string path: type: array items: anyOf: - type: string - type: number code: type: string enum: - invalid_union_discriminator options: type: array items: anyOf: - type: string - type: number - type: string pattern: ^d+$ - type: boolean - type: string description: A symbol - type: 'null' - type: 'null' required: - path - code - options - type: object properties: fatal: type: boolean message: type: string path: type: array items: anyOf: - type: string - type: number code: type: string enum: - invalid_enum_value options: type: array items: anyOf: - type: string - type: number required: - path - code - options - type: object properties: fatal: type: boolean message: type: string path: type: array items: anyOf: - type: string - type: number code: type: string enum: - invalid_arguments argumentsError: type: object properties: issues: type: array items: $ref: >- #/components/schemas/APIBadRequestValidationErrorResponse required: - path - code - argumentsError - type: object properties: fatal: type: boolean message: type: string path: type: array items: anyOf: - type: string - type: number code: type: string enum: - invalid_return_type returnTypeError: type: object properties: issues: type: array items: $ref: >- #/components/schemas/APIBadRequestValidationErrorResponse required: - path - code - returnTypeError - type: object properties: fatal: type: boolean message: type: string path: type: array items: anyOf: - type: string - type: number code: type: string enum: - invalid_date required: - path - code - type: object properties: fatal: type: boolean message: type: string path: type: array items: anyOf: - type: string - type: number code: type: string enum: - invalid_string validation: anyOf: - type: string - type: object properties: includes: type: string position: type: number required: - includes - type: object properties: startsWith: type: string required: - startsWith - type: object properties: endsWith: type: string required: - endsWith required: - path - code - validation - type: object properties: fatal: type: boolean message: type: string path: type: array items: anyOf: - type: string - type: number code: type: string enum: - too_small minimum: anyOf: - type: number - type: string pattern: ^d+$ inclusive: type: boolean exact: type: boolean type: type: string required: - path - code - minimum - inclusive - type - type: object properties: fatal: type: boolean message: type: string path: type: array items: anyOf: - type: string - type: number code: type: string enum: - too_big maximum: anyOf: - type: number - type: string pattern: ^d+$ inclusive: type: boolean exact: type: boolean type: type: string required: - path - code - maximum - inclusive - type - type: object properties: fatal: type: boolean message: type: string path: type: array items: anyOf: - type: string - type: number code: type: string enum: - invalid_intersection_types required: - path - code - type: object properties: fatal: type: boolean message: type: string path: type: array items: anyOf: - type: string - type: number code: type: string enum: - not_multiple_of multipleOf: anyOf: - type: number - type: string pattern: ^d+$ required: - path - code - multipleOf - type: object properties: fatal: type: boolean message: type: string path: type: array items: anyOf: - type: string - type: number code: type: string enum: - not_finite required: - path - code - type: object properties: fatal: type: boolean message: type: string path: type: array items: anyOf: - type: string - type: number code: type: string enum: - custom params: type: object additionalProperties: {} required: - path - code required: - issues APIErrorResponse: type: object properties: message: type: string description: The error message required: - message APIBadRequestResponse: anyOf: - type: object properties: success: type: boolean enum: - false error: $ref: '#/components/schemas/APIBadRequestValidationErrorResponse' required: - success - error - $ref: '#/components/schemas/APIErrorResponse' object_2: type: object properties: &ref_1 app: type: string description: Hex format string, e.g. `0x1234567890abcdef` author: type: object properties: address: type: string description: Hex format string, e.g. `0x1234567890abcdef` ens: type: object properties: name: type: string avatarUrl: type: - string - 'null' required: - name - avatarUrl farcaster: type: object properties: fid: type: integer pfpUrl: type: string displayName: type: string username: type: string required: - fid - username required: - address id: type: string description: Hex format string, e.g. `0x1234567890abcdef` channelId: type: string pattern: ^d+$ commentType: type: integer minimum: 0 maximum: 255 content: type: string chainId: type: integer deletedAt: type: - string - 'null' logIndex: type: - integer - 'null' metadata: type: array items: type: object properties: key: type: string description: Hex format string, e.g. `0x1234567890abcdef` value: type: string description: Hex format string, e.g. `0x1234567890abcdef` required: - key - value hookMetadata: type: array items: type: object properties: key: type: string description: Hex format string, e.g. `0x1234567890abcdef` value: type: string description: Hex format string, e.g. `0x1234567890abcdef` required: - key - value parentId: type: - string - 'null' description: Hex format string, e.g. `0x1234567890abcdef` targetUri: type: string txHash: type: string description: Hex format string, e.g. `0x1234567890abcdef` cursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` moderationStatus: type: string enum: &ref_0 - approved - rejected - pending moderationStatusChangedAt: type: - string - 'null' moderationClassifierResult: type: object additionalProperties: type: number minimum: 0 maximum: 1 moderationClassifierScore: type: number minimum: 0 maximum: 1 createdAt: type: - string - 'null' updatedAt: type: - string - 'null' revision: type: integer zeroExSwap: type: - object - 'null' properties: from: type: object properties: address: type: string description: Hex format string, e.g. `0x1234567890abcdef` amount: type: string pattern: ^\d+(\.\d+)?$ symbol: type: string required: - address - amount - symbol to: type: object properties: address: anyOf: - type: string description: Hex format string, e.g. `0x1234567890abcdef` - type: string enum: - '' description: Hex format string, e.g. `0x1234567890abcdef` amount: anyOf: - type: string pattern: ^\d+(\.\d+)?$ - type: string enum: - '' symbol: type: string required: - address - amount - symbol required: - from - to references: type: array items: anyOf: - type: object properties: type: type: string enum: - ens avatarUrl: type: - string - 'null' name: type: string address: type: string description: Hex format string, e.g. `0x1234567890abcdef` position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - avatarUrl - name - address - position - url - type: object properties: type: type: string enum: - erc20 symbol: type: string logoURI: type: - string - 'null' name: type: string address: type: string description: Hex format string, e.g. `0x1234567890abcdef` decimals: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end chainId: type: - integer - 'null' exclusiveMinimum: 0 chains: type: array items: type: object properties: caip: type: string chainId: type: integer exclusiveMinimum: 0 required: - caip - chainId required: - type - symbol - logoURI - name - address - decimals - position - chainId - chains - type: object properties: type: type: string enum: - farcaster address: type: string description: Hex format string, e.g. `0x1234567890abcdef` fid: type: integer fname: type: string username: type: string displayName: type: - string - 'null' pfpUrl: type: - string - 'null' position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - address - fid - fname - username - displayName - pfpUrl - position - url - type: object properties: type: type: string enum: - webpage url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end title: type: string description: type: - string - 'null' favicon: type: - string - 'null' format: uri opengraph: type: - object - 'null' properties: title: type: string description: type: - string - 'null' image: type: string format: uri url: type: string format: uri required: - title - description - image - url mediaType: type: string required: - type - url - position - title - description - favicon - opengraph - mediaType - type: object properties: type: type: string enum: - file url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string required: - type - url - position - mediaType - type: object properties: type: type: string enum: - image url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height required: - type - url - position - mediaType - type: object properties: type: type: string enum: - video url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string videoTracks: type: array items: type: object properties: dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height codec: type: string required: - dimension required: - type - url - position - mediaType - type: object properties: type: type: string enum: - quoted_comment id: type: string description: Hex format string, e.g. `0x1234567890abcdef` chainId: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end required: - type - id - chainId - position - {} - type: 'null' path: type: string viewerReactions: type: object additionalProperties: type: array items: {} reactionCounts: type: object additionalProperties: type: number replies: type: object properties: extra: type: object properties: moderationEnabled: type: boolean moderationKnownReactions: type: array items: type: string required: - moderationEnabled - moderationKnownReactions pagination: type: object properties: limit: type: integer hasNext: type: boolean hasPrevious: type: boolean startCursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` endCursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` count: type: integer minimum: 0 required: - limit - hasNext - hasPrevious - count results: type: array items: {} required: - extra - pagination - results required: &ref_2 - app - author - id - channelId - commentType - content - chainId - deletedAt - logIndex - metadata - hookMetadata - parentId - targetUri - txHash - cursor - moderationStatus - moderationStatusChangedAt - moderationClassifierResult - moderationClassifierScore - createdAt - updatedAt - revision - zeroExSwap - references - path - viewerReactions - reactionCounts - replies object_1: type: object properties: &ref_8 app: type: string description: Hex format string, e.g. `0x1234567890abcdef` author: type: object properties: address: type: string description: Hex format string, e.g. `0x1234567890abcdef` ens: type: object properties: name: type: string avatarUrl: type: - string - 'null' required: - name - avatarUrl farcaster: type: object properties: fid: type: integer pfpUrl: type: string displayName: type: string username: type: string required: - fid - username required: - address id: type: string description: Hex format string, e.g. `0x1234567890abcdef` channelId: type: string pattern: ^d+$ commentType: type: integer minimum: 0 maximum: 255 content: type: string chainId: type: integer deletedAt: type: - string - 'null' logIndex: type: - integer - 'null' metadata: type: array items: type: object properties: key: type: string description: Hex format string, e.g. `0x1234567890abcdef` value: type: string description: Hex format string, e.g. `0x1234567890abcdef` required: - key - value hookMetadata: type: array items: type: object properties: key: type: string description: Hex format string, e.g. `0x1234567890abcdef` value: type: string description: Hex format string, e.g. `0x1234567890abcdef` required: - key - value parentId: type: - string - 'null' description: Hex format string, e.g. `0x1234567890abcdef` targetUri: type: string txHash: type: string description: Hex format string, e.g. `0x1234567890abcdef` cursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` moderationStatus: type: string enum: *ref_0 moderationStatusChangedAt: type: - string - 'null' moderationClassifierResult: type: object additionalProperties: type: number minimum: 0 maximum: 1 moderationClassifierScore: type: number minimum: 0 maximum: 1 createdAt: type: - string - 'null' updatedAt: type: - string - 'null' revision: type: integer zeroExSwap: type: - object - 'null' properties: from: type: object properties: address: type: string description: Hex format string, e.g. `0x1234567890abcdef` amount: type: string pattern: ^\d+(\.\d+)?$ symbol: type: string required: - address - amount - symbol to: type: object properties: address: anyOf: - type: string description: Hex format string, e.g. `0x1234567890abcdef` - type: string enum: - '' description: Hex format string, e.g. `0x1234567890abcdef` amount: anyOf: - type: string pattern: ^\d+(\.\d+)?$ - type: string enum: - '' symbol: type: string required: - address - amount - symbol required: - from - to references: type: array items: anyOf: - type: object properties: type: type: string enum: - ens avatarUrl: type: - string - 'null' name: type: string address: type: string description: Hex format string, e.g. `0x1234567890abcdef` position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - avatarUrl - name - address - position - url - type: object properties: type: type: string enum: - erc20 symbol: type: string logoURI: type: - string - 'null' name: type: string address: type: string description: Hex format string, e.g. `0x1234567890abcdef` decimals: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end chainId: type: - integer - 'null' exclusiveMinimum: 0 chains: type: array items: type: object properties: caip: type: string chainId: type: integer exclusiveMinimum: 0 required: - caip - chainId required: - type - symbol - logoURI - name - address - decimals - position - chainId - chains - type: object properties: type: type: string enum: - farcaster address: type: string description: Hex format string, e.g. `0x1234567890abcdef` fid: type: integer fname: type: string username: type: string displayName: type: - string - 'null' pfpUrl: type: - string - 'null' position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - address - fid - fname - username - displayName - pfpUrl - position - url - type: object properties: type: type: string enum: - webpage url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end title: type: string description: type: - string - 'null' favicon: type: - string - 'null' format: uri opengraph: type: - object - 'null' properties: title: type: string description: type: - string - 'null' image: type: string format: uri url: type: string format: uri required: - title - description - image - url mediaType: type: string required: - type - url - position - title - description - favicon - opengraph - mediaType - type: object properties: type: type: string enum: - file url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string required: - type - url - position - mediaType - type: object properties: type: type: string enum: - image url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height required: - type - url - position - mediaType - type: object properties: type: type: string enum: - video url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string videoTracks: type: array items: type: object properties: dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height codec: type: string required: - dimension required: - type - url - position - mediaType - type: object properties: type: type: string enum: - quoted_comment id: type: string description: Hex format string, e.g. `0x1234567890abcdef` chainId: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end required: - type - id - chainId - position - {} - type: 'null' path: type: string viewerReactions: type: object additionalProperties: type: array items: {} reactionCounts: type: object additionalProperties: type: number replies: type: object properties: extra: type: object properties: moderationEnabled: type: boolean moderationKnownReactions: type: array items: type: string required: - moderationEnabled - moderationKnownReactions pagination: type: object properties: limit: type: integer hasNext: type: boolean hasPrevious: type: boolean startCursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` endCursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` count: type: integer minimum: 0 required: - limit - hasNext - hasPrevious - count results: type: array items: type: object properties: *ref_1 required: *ref_2 required: - extra - pagination - results required: &ref_9 - app - author - id - channelId - commentType - content - chainId - deletedAt - logIndex - metadata - hookMetadata - parentId - targetUri - txHash - cursor - moderationStatus - moderationStatusChangedAt - moderationClassifierResult - moderationClassifierScore - createdAt - updatedAt - revision - zeroExSwap - references - path - viewerReactions - reactionCounts - replies object_4: type: object properties: &ref_4 app: type: string description: Hex format string, e.g. `0x1234567890abcdef` author: type: object properties: address: type: string description: Hex format string, e.g. `0x1234567890abcdef` ens: type: object properties: name: type: string avatarUrl: type: - string - 'null' required: - name - avatarUrl farcaster: type: object properties: fid: type: integer pfpUrl: type: string displayName: type: string username: type: string required: - fid - username required: - address id: type: string description: Hex format string, e.g. `0x1234567890abcdef` channelId: type: string pattern: ^d+$ commentType: type: integer minimum: 0 maximum: 255 content: type: string chainId: type: integer deletedAt: type: - string - 'null' logIndex: type: - integer - 'null' metadata: type: array items: type: object properties: key: type: string description: Hex format string, e.g. `0x1234567890abcdef` value: type: string description: Hex format string, e.g. `0x1234567890abcdef` required: - key - value hookMetadata: type: array items: type: object properties: key: type: string description: Hex format string, e.g. `0x1234567890abcdef` value: type: string description: Hex format string, e.g. `0x1234567890abcdef` required: - key - value parentId: type: - string - 'null' description: Hex format string, e.g. `0x1234567890abcdef` targetUri: type: string txHash: type: string description: Hex format string, e.g. `0x1234567890abcdef` cursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` moderationStatus: type: string enum: &ref_3 - approved - rejected - pending moderationStatusChangedAt: type: - string - 'null' moderationClassifierResult: type: object additionalProperties: type: number minimum: 0 maximum: 1 moderationClassifierScore: type: number minimum: 0 maximum: 1 createdAt: type: - string - 'null' updatedAt: type: - string - 'null' revision: type: integer zeroExSwap: type: - object - 'null' properties: from: type: object properties: address: type: string description: Hex format string, e.g. `0x1234567890abcdef` amount: type: string pattern: ^\d+(\.\d+)?$ symbol: type: string required: - address - amount - symbol to: type: object properties: address: anyOf: - type: string description: Hex format string, e.g. `0x1234567890abcdef` - type: string enum: - '' description: Hex format string, e.g. `0x1234567890abcdef` amount: anyOf: - type: string pattern: ^\d+(\.\d+)?$ - type: string enum: - '' symbol: type: string required: - address - amount - symbol required: - from - to references: type: array items: anyOf: - type: object properties: type: type: string enum: - ens avatarUrl: type: - string - 'null' name: type: string address: type: string description: Hex format string, e.g. `0x1234567890abcdef` position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - avatarUrl - name - address - position - url - type: object properties: type: type: string enum: - erc20 symbol: type: string logoURI: type: - string - 'null' name: type: string address: type: string description: Hex format string, e.g. `0x1234567890abcdef` decimals: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end chainId: type: - integer - 'null' exclusiveMinimum: 0 chains: type: array items: type: object properties: caip: type: string chainId: type: integer exclusiveMinimum: 0 required: - caip - chainId required: - type - symbol - logoURI - name - address - decimals - position - chainId - chains - type: object properties: type: type: string enum: - farcaster address: type: string description: Hex format string, e.g. `0x1234567890abcdef` fid: type: integer fname: type: string username: type: string displayName: type: - string - 'null' pfpUrl: type: - string - 'null' position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - address - fid - fname - username - displayName - pfpUrl - position - url - type: object properties: type: type: string enum: - webpage url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end title: type: string description: type: - string - 'null' favicon: type: - string - 'null' format: uri opengraph: type: - object - 'null' properties: title: type: string description: type: - string - 'null' image: type: string format: uri url: type: string format: uri required: - title - description - image - url mediaType: type: string required: - type - url - position - title - description - favicon - opengraph - mediaType - type: object properties: type: type: string enum: - file url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string required: - type - url - position - mediaType - type: object properties: type: type: string enum: - image url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height required: - type - url - position - mediaType - type: object properties: type: type: string enum: - video url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string videoTracks: type: array items: type: object properties: dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height codec: type: string required: - dimension required: - type - url - position - mediaType - type: object properties: type: type: string enum: - quoted_comment id: type: string description: Hex format string, e.g. `0x1234567890abcdef` chainId: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end required: - type - id - chainId - position - {} - type: 'null' path: type: string viewerReactions: type: object additionalProperties: type: array items: {} reactionCounts: type: object additionalProperties: type: number replies: type: object properties: extra: type: object properties: moderationEnabled: type: boolean moderationKnownReactions: type: array items: type: string required: - moderationEnabled - moderationKnownReactions pagination: type: object properties: limit: type: integer hasNext: type: boolean hasPrevious: type: boolean startCursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` endCursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` count: type: integer minimum: 0 required: - limit - hasNext - hasPrevious - count results: type: array items: {} required: - extra - pagination - results required: &ref_5 - app - author - id - channelId - commentType - content - chainId - deletedAt - logIndex - metadata - hookMetadata - parentId - targetUri - txHash - cursor - moderationStatus - moderationStatusChangedAt - moderationClassifierResult - moderationClassifierScore - createdAt - updatedAt - revision - zeroExSwap - references - path - viewerReactions - reactionCounts - replies object_3: type: object properties: &ref_11 app: type: string description: Hex format string, e.g. `0x1234567890abcdef` author: type: object properties: address: type: string description: Hex format string, e.g. `0x1234567890abcdef` ens: type: object properties: name: type: string avatarUrl: type: - string - 'null' required: - name - avatarUrl farcaster: type: object properties: fid: type: integer pfpUrl: type: string displayName: type: string username: type: string required: - fid - username required: - address id: type: string description: Hex format string, e.g. `0x1234567890abcdef` channelId: type: string pattern: ^d+$ commentType: type: integer minimum: 0 maximum: 255 content: type: string chainId: type: integer deletedAt: type: - string - 'null' logIndex: type: - integer - 'null' metadata: type: array items: type: object properties: key: type: string description: Hex format string, e.g. `0x1234567890abcdef` value: type: string description: Hex format string, e.g. `0x1234567890abcdef` required: - key - value hookMetadata: type: array items: type: object properties: key: type: string description: Hex format string, e.g. `0x1234567890abcdef` value: type: string description: Hex format string, e.g. `0x1234567890abcdef` required: - key - value parentId: type: - string - 'null' description: Hex format string, e.g. `0x1234567890abcdef` targetUri: type: string txHash: type: string description: Hex format string, e.g. `0x1234567890abcdef` cursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` moderationStatus: type: string enum: *ref_3 moderationStatusChangedAt: type: - string - 'null' moderationClassifierResult: type: object additionalProperties: type: number minimum: 0 maximum: 1 moderationClassifierScore: type: number minimum: 0 maximum: 1 createdAt: type: - string - 'null' updatedAt: type: - string - 'null' revision: type: integer zeroExSwap: type: - object - 'null' properties: from: type: object properties: address: type: string description: Hex format string, e.g. `0x1234567890abcdef` amount: type: string pattern: ^\d+(\.\d+)?$ symbol: type: string required: - address - amount - symbol to: type: object properties: address: anyOf: - type: string description: Hex format string, e.g. `0x1234567890abcdef` - type: string enum: - '' description: Hex format string, e.g. `0x1234567890abcdef` amount: anyOf: - type: string pattern: ^\d+(\.\d+)?$ - type: string enum: - '' symbol: type: string required: - address - amount - symbol required: - from - to references: type: array items: anyOf: - type: object properties: type: type: string enum: - ens avatarUrl: type: - string - 'null' name: type: string address: type: string description: Hex format string, e.g. `0x1234567890abcdef` position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - avatarUrl - name - address - position - url - type: object properties: type: type: string enum: - erc20 symbol: type: string logoURI: type: - string - 'null' name: type: string address: type: string description: Hex format string, e.g. `0x1234567890abcdef` decimals: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end chainId: type: - integer - 'null' exclusiveMinimum: 0 chains: type: array items: type: object properties: caip: type: string chainId: type: integer exclusiveMinimum: 0 required: - caip - chainId required: - type - symbol - logoURI - name - address - decimals - position - chainId - chains - type: object properties: type: type: string enum: - farcaster address: type: string description: Hex format string, e.g. `0x1234567890abcdef` fid: type: integer fname: type: string username: type: string displayName: type: - string - 'null' pfpUrl: type: - string - 'null' position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - address - fid - fname - username - displayName - pfpUrl - position - url - type: object properties: type: type: string enum: - webpage url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end title: type: string description: type: - string - 'null' favicon: type: - string - 'null' format: uri opengraph: type: - object - 'null' properties: title: type: string description: type: - string - 'null' image: type: string format: uri url: type: string format: uri required: - title - description - image - url mediaType: type: string required: - type - url - position - title - description - favicon - opengraph - mediaType - type: object properties: type: type: string enum: - file url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string required: - type - url - position - mediaType - type: object properties: type: type: string enum: - image url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height required: - type - url - position - mediaType - type: object properties: type: type: string enum: - video url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string videoTracks: type: array items: type: object properties: dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height codec: type: string required: - dimension required: - type - url - position - mediaType - type: object properties: type: type: string enum: - quoted_comment id: type: string description: Hex format string, e.g. `0x1234567890abcdef` chainId: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end required: - type - id - chainId - position - {} - type: 'null' path: type: string viewerReactions: type: object additionalProperties: type: array items: {} reactionCounts: type: object additionalProperties: type: number replies: type: object properties: extra: type: object properties: moderationEnabled: type: boolean moderationKnownReactions: type: array items: type: string required: - moderationEnabled - moderationKnownReactions pagination: type: object properties: limit: type: integer hasNext: type: boolean hasPrevious: type: boolean startCursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` endCursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` count: type: integer minimum: 0 required: - limit - hasNext - hasPrevious - count results: type: array items: type: object properties: *ref_4 required: *ref_5 required: - extra - pagination - results required: &ref_12 - app - author - id - channelId - commentType - content - chainId - deletedAt - logIndex - metadata - hookMetadata - parentId - targetUri - txHash - cursor - moderationStatus - moderationStatusChangedAt - moderationClassifierResult - moderationClassifierScore - createdAt - updatedAt - revision - zeroExSwap - references - path - viewerReactions - reactionCounts - replies object_6: type: object properties: &ref_6 app: type: string description: Hex format string, e.g. `0x1234567890abcdef` author: type: object properties: address: type: string description: Hex format string, e.g. `0x1234567890abcdef` ens: type: object properties: name: type: string avatarUrl: type: - string - 'null' required: - name - avatarUrl farcaster: type: object properties: fid: type: integer pfpUrl: type: string displayName: type: string username: type: string required: - fid - username required: - address id: type: string description: Hex format string, e.g. `0x1234567890abcdef` channelId: type: string pattern: ^d+$ commentType: type: integer minimum: 0 maximum: 255 content: type: string chainId: type: integer deletedAt: type: - string - 'null' logIndex: type: - integer - 'null' metadata: type: array items: type: object properties: key: type: string description: Hex format string, e.g. `0x1234567890abcdef` value: type: string description: Hex format string, e.g. `0x1234567890abcdef` required: - key - value hookMetadata: type: array items: type: object properties: key: type: string description: Hex format string, e.g. `0x1234567890abcdef` value: type: string description: Hex format string, e.g. `0x1234567890abcdef` required: - key - value parentId: type: - string - 'null' description: Hex format string, e.g. `0x1234567890abcdef` targetUri: type: string txHash: type: string description: Hex format string, e.g. `0x1234567890abcdef` cursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` moderationStatus: type: string enum: *ref_0 moderationStatusChangedAt: type: - string - 'null' moderationClassifierResult: type: object additionalProperties: type: number minimum: 0 maximum: 1 moderationClassifierScore: type: number minimum: 0 maximum: 1 createdAt: type: - string - 'null' updatedAt: type: - string - 'null' revision: type: integer zeroExSwap: type: - object - 'null' properties: from: type: object properties: address: type: string description: Hex format string, e.g. `0x1234567890abcdef` amount: type: string pattern: ^\d+(\.\d+)?$ symbol: type: string required: - address - amount - symbol to: type: object properties: address: anyOf: - type: string description: Hex format string, e.g. `0x1234567890abcdef` - type: string enum: - '' description: Hex format string, e.g. `0x1234567890abcdef` amount: anyOf: - type: string pattern: ^\d+(\.\d+)?$ - type: string enum: - '' symbol: type: string required: - address - amount - symbol required: - from - to references: type: array items: anyOf: - type: object properties: type: type: string enum: - ens avatarUrl: type: - string - 'null' name: type: string address: type: string description: Hex format string, e.g. `0x1234567890abcdef` position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - avatarUrl - name - address - position - url - type: object properties: type: type: string enum: - erc20 symbol: type: string logoURI: type: - string - 'null' name: type: string address: type: string description: Hex format string, e.g. `0x1234567890abcdef` decimals: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end chainId: type: - integer - 'null' exclusiveMinimum: 0 chains: type: array items: type: object properties: caip: type: string chainId: type: integer exclusiveMinimum: 0 required: - caip - chainId required: - type - symbol - logoURI - name - address - decimals - position - chainId - chains - type: object properties: type: type: string enum: - farcaster address: type: string description: Hex format string, e.g. `0x1234567890abcdef` fid: type: integer fname: type: string username: type: string displayName: type: - string - 'null' pfpUrl: type: - string - 'null' position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - address - fid - fname - username - displayName - pfpUrl - position - url - type: object properties: type: type: string enum: - webpage url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end title: type: string description: type: - string - 'null' favicon: type: - string - 'null' format: uri opengraph: type: - object - 'null' properties: title: type: string description: type: - string - 'null' image: type: string format: uri url: type: string format: uri required: - title - description - image - url mediaType: type: string required: - type - url - position - title - description - favicon - opengraph - mediaType - type: object properties: type: type: string enum: - file url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string required: - type - url - position - mediaType - type: object properties: type: type: string enum: - image url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height required: - type - url - position - mediaType - type: object properties: type: type: string enum: - video url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string videoTracks: type: array items: type: object properties: dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height codec: type: string required: - dimension required: - type - url - position - mediaType - type: object properties: type: type: string enum: - quoted_comment id: type: string description: Hex format string, e.g. `0x1234567890abcdef` chainId: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end required: - type - id - chainId - position - {} - type: 'null' path: type: string viewerReactions: type: object additionalProperties: type: array items: {} reactionCounts: type: object additionalProperties: type: number replies: type: object properties: extra: type: object properties: moderationEnabled: type: boolean moderationKnownReactions: type: array items: type: string required: - moderationEnabled - moderationKnownReactions pagination: type: object properties: limit: type: integer hasNext: type: boolean hasPrevious: type: boolean startCursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` endCursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` count: type: integer minimum: 0 required: - limit - hasNext - hasPrevious - count results: type: array items: {} required: - extra - pagination - results required: &ref_7 - app - author - id - channelId - commentType - content - chainId - deletedAt - logIndex - metadata - hookMetadata - parentId - targetUri - txHash - cursor - moderationStatus - moderationStatusChangedAt - moderationClassifierResult - moderationClassifierScore - createdAt - updatedAt - revision - zeroExSwap - references - path - viewerReactions - reactionCounts - replies object_5: type: object properties: &ref_15 app: type: string description: Hex format string, e.g. `0x1234567890abcdef` author: type: object properties: address: type: string description: Hex format string, e.g. `0x1234567890abcdef` ens: type: object properties: name: type: string avatarUrl: type: - string - 'null' required: - name - avatarUrl farcaster: type: object properties: fid: type: integer pfpUrl: type: string displayName: type: string username: type: string required: - fid - username required: - address id: type: string description: Hex format string, e.g. `0x1234567890abcdef` channelId: type: string pattern: ^d+$ commentType: type: integer minimum: 0 maximum: 255 content: type: string chainId: type: integer deletedAt: type: - string - 'null' logIndex: type: - integer - 'null' metadata: type: array items: type: object properties: key: type: string description: Hex format string, e.g. `0x1234567890abcdef` value: type: string description: Hex format string, e.g. `0x1234567890abcdef` required: - key - value hookMetadata: type: array items: type: object properties: key: type: string description: Hex format string, e.g. `0x1234567890abcdef` value: type: string description: Hex format string, e.g. `0x1234567890abcdef` required: - key - value parentId: type: - string - 'null' description: Hex format string, e.g. `0x1234567890abcdef` targetUri: type: string txHash: type: string description: Hex format string, e.g. `0x1234567890abcdef` cursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` moderationStatus: type: string enum: *ref_0 moderationStatusChangedAt: type: - string - 'null' moderationClassifierResult: type: object additionalProperties: type: number minimum: 0 maximum: 1 moderationClassifierScore: type: number minimum: 0 maximum: 1 createdAt: type: - string - 'null' updatedAt: type: - string - 'null' revision: type: integer zeroExSwap: type: - object - 'null' properties: from: type: object properties: address: type: string description: Hex format string, e.g. `0x1234567890abcdef` amount: type: string pattern: ^\d+(\.\d+)?$ symbol: type: string required: - address - amount - symbol to: type: object properties: address: anyOf: - type: string description: Hex format string, e.g. `0x1234567890abcdef` - type: string enum: - '' description: Hex format string, e.g. `0x1234567890abcdef` amount: anyOf: - type: string pattern: ^\d+(\.\d+)?$ - type: string enum: - '' symbol: type: string required: - address - amount - symbol required: - from - to references: type: array items: anyOf: - type: object properties: type: type: string enum: - ens avatarUrl: type: - string - 'null' name: type: string address: type: string description: Hex format string, e.g. `0x1234567890abcdef` position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - avatarUrl - name - address - position - url - type: object properties: type: type: string enum: - erc20 symbol: type: string logoURI: type: - string - 'null' name: type: string address: type: string description: Hex format string, e.g. `0x1234567890abcdef` decimals: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end chainId: type: - integer - 'null' exclusiveMinimum: 0 chains: type: array items: type: object properties: caip: type: string chainId: type: integer exclusiveMinimum: 0 required: - caip - chainId required: - type - symbol - logoURI - name - address - decimals - position - chainId - chains - type: object properties: type: type: string enum: - farcaster address: type: string description: Hex format string, e.g. `0x1234567890abcdef` fid: type: integer fname: type: string username: type: string displayName: type: - string - 'null' pfpUrl: type: - string - 'null' position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - address - fid - fname - username - displayName - pfpUrl - position - url - type: object properties: type: type: string enum: - webpage url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end title: type: string description: type: - string - 'null' favicon: type: - string - 'null' format: uri opengraph: type: - object - 'null' properties: title: type: string description: type: - string - 'null' image: type: string format: uri url: type: string format: uri required: - title - description - image - url mediaType: type: string required: - type - url - position - title - description - favicon - opengraph - mediaType - type: object properties: type: type: string enum: - file url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string required: - type - url - position - mediaType - type: object properties: type: type: string enum: - image url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height required: - type - url - position - mediaType - type: object properties: type: type: string enum: - video url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string videoTracks: type: array items: type: object properties: dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height codec: type: string required: - dimension required: - type - url - position - mediaType - type: object properties: type: type: string enum: - quoted_comment id: type: string description: Hex format string, e.g. `0x1234567890abcdef` chainId: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end required: - type - id - chainId - position - {} - type: 'null' path: type: string viewerReactions: type: object additionalProperties: type: array items: {} reactionCounts: type: object additionalProperties: type: number replies: type: object properties: extra: type: object properties: moderationEnabled: type: boolean moderationKnownReactions: type: array items: type: string required: - moderationEnabled - moderationKnownReactions pagination: type: object properties: limit: type: integer hasNext: type: boolean hasPrevious: type: boolean startCursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` endCursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` count: type: integer minimum: 0 required: - limit - hasNext - hasPrevious - count results: type: array items: type: object properties: *ref_6 required: *ref_7 required: - extra - pagination - results required: &ref_16 - app - author - id - channelId - commentType - content - chainId - deletedAt - logIndex - metadata - hookMetadata - parentId - targetUri - txHash - cursor - moderationStatus - moderationStatusChangedAt - moderationClassifierResult - moderationClassifierScore - createdAt - updatedAt - revision - zeroExSwap - references - path - viewerReactions - reactionCounts - replies parameters: {} paths: /api/channels/{channelId}: get: tags: - channels description: Retrieve a channel by ID parameters: - schema: type: string pattern: ^d+$ description: The ID of the channel required: true name: channelId in: path responses: '200': description: Retrieve a list of channels content: application/json: schema: type: object properties: id: type: string pattern: ^d+$ createdAt: type: - string - 'null' updatedAt: type: - string - 'null' owner: type: string description: Hex format string, e.g. `0x1234567890abcdef` name: type: string description: type: string metadata: type: array items: type: object properties: key: type: string description: Hex format string, e.g. `0x1234567890abcdef` value: type: string description: Hex format string, e.g. `0x1234567890abcdef` required: - key - value hook: type: - string - 'null' description: Hex format string, e.g. `0x1234567890abcdef` chainId: type: integer required: - id - createdAt - updatedAt - owner - name - description - metadata - hook - chainId '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '404': description: Channel not found content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' /api/channels: get: tags: - channels description: Retrieve a list of channels based on the criteria parameters: - schema: type: string description: >- Non inclusive cursor from which to fetch the channels based on sort pattern: ^0x[a-fA-F0-9]+$ required: false name: cursor in: query - schema: type: string description: Filter channels by owner pattern: ^0x[a-fA-F0-9]+$ required: false description: Hex format string, e.g. `0x1234567890abcdef` name: owner in: query - schema: type: string description: >- Filters by chain ID. Can be a single chain id or comma-separated list of chain ids (e.g. 1,137,10). required: true name: chainId in: query - schema: type: integer minimum: 1 maximum: 100 default: 50 description: The number of channels to return required: false name: limit in: query - schema: type: string enum: - asc - desc default: desc description: The sort order of the channels required: false name: sort in: query responses: '200': description: Retrieve a list of channels content: application/json: schema: type: object properties: results: type: array items: type: object properties: id: type: string pattern: ^d+$ createdAt: type: - string - 'null' updatedAt: type: - string - 'null' owner: type: string description: Hex format string, e.g. `0x1234567890abcdef` name: type: string description: type: string metadata: type: array items: type: object properties: key: type: string description: Hex format string, e.g. `0x1234567890abcdef` value: type: string description: Hex format string, e.g. `0x1234567890abcdef` required: - key - value hook: type: - string - 'null' description: Hex format string, e.g. `0x1234567890abcdef` chainId: type: integer required: - id - createdAt - updatedAt - owner - name - description - metadata - hook - chainId pagination: type: object properties: limit: type: integer hasNext: type: boolean hasPrevious: type: boolean startCursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` endCursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` required: - limit - hasNext - hasPrevious required: - results - pagination '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' /api/comments/{commentId}: get: tags: - comments description: Retrieve a single comment by ID parameters: - schema: type: string description: The ID of the comment to retrieve required: true description: Hex format string, e.g. `0x1234567890abcdef` name: commentId in: path - schema: type: string description: The viewer's address, for personalized data such as reactions pattern: ^0x[a-fA-F0-9]+$ required: false description: Hex format string, e.g. `0x1234567890abcdef` name: viewer in: query - schema: type: string description: >- Filters by chain ID. Can be a single chain id or comma-separated list of chain ids (e.g. 1,137,10). required: true name: chainId in: query - schema: type: string enum: &ref_10 - nested - flat default: nested description: >- The mode to fetch comments in. Nested will return only the first level of comments. Flat will return all replies sorted by timestamp in descending order. required: false name: mode in: query - schema: type: - integer - 'null' minimum: 0 maximum: 255 description: The comment type (e.g. 0=comment, 1=reaction, not passed = all) required: false name: commentType in: query - schema: type: string description: >- Whether to return only deleted replies or only undeleted replies. If omitted it will return both deleted and undeleted replies. example: '1' pattern: ^(1|0)$ required: false name: isReplyDeleted in: query responses: '200': description: A single comment content: application/json: schema: type: object properties: app: type: string description: Hex format string, e.g. `0x1234567890abcdef` author: type: object properties: address: type: string description: Hex format string, e.g. `0x1234567890abcdef` ens: type: object properties: name: type: string avatarUrl: type: - string - 'null' required: - name - avatarUrl farcaster: type: object properties: fid: type: integer pfpUrl: type: string displayName: type: string username: type: string required: - fid - username required: - address id: type: string description: Hex format string, e.g. `0x1234567890abcdef` channelId: type: string pattern: ^d+$ commentType: type: integer minimum: 0 maximum: 255 content: type: string chainId: type: integer deletedAt: type: - string - 'null' logIndex: type: - integer - 'null' metadata: type: array items: type: object properties: key: type: string description: Hex format string, e.g. `0x1234567890abcdef` value: type: string description: Hex format string, e.g. `0x1234567890abcdef` required: - key - value hookMetadata: type: array items: type: object properties: key: type: string description: Hex format string, e.g. `0x1234567890abcdef` value: type: string description: Hex format string, e.g. `0x1234567890abcdef` required: - key - value parentId: type: - string - 'null' description: Hex format string, e.g. `0x1234567890abcdef` targetUri: type: string txHash: type: string description: Hex format string, e.g. `0x1234567890abcdef` cursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` moderationStatus: type: string enum: *ref_0 moderationStatusChangedAt: type: - string - 'null' moderationClassifierResult: type: object additionalProperties: type: number minimum: 0 maximum: 1 moderationClassifierScore: type: number minimum: 0 maximum: 1 createdAt: type: - string - 'null' updatedAt: type: - string - 'null' revision: type: integer zeroExSwap: type: - object - 'null' properties: from: type: object properties: address: type: string description: Hex format string, e.g. `0x1234567890abcdef` amount: type: string pattern: ^\d+(\.\d+)?$ symbol: type: string required: - address - amount - symbol to: type: object properties: address: anyOf: - type: string description: Hex format string, e.g. `0x1234567890abcdef` - type: string enum: - '' description: Hex format string, e.g. `0x1234567890abcdef` amount: anyOf: - type: string pattern: ^\d+(\.\d+)?$ - type: string enum: - '' symbol: type: string required: - address - amount - symbol required: - from - to references: type: array items: anyOf: - type: object properties: type: type: string enum: - ens avatarUrl: type: - string - 'null' name: type: string address: type: string description: Hex format string, e.g. `0x1234567890abcdef` position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - avatarUrl - name - address - position - url - type: object properties: type: type: string enum: - erc20 symbol: type: string logoURI: type: - string - 'null' name: type: string address: type: string description: Hex format string, e.g. `0x1234567890abcdef` decimals: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end chainId: type: - integer - 'null' exclusiveMinimum: 0 chains: type: array items: type: object properties: caip: type: string chainId: type: integer exclusiveMinimum: 0 required: - caip - chainId required: - type - symbol - logoURI - name - address - decimals - position - chainId - chains - type: object properties: type: type: string enum: - farcaster address: type: string description: Hex format string, e.g. `0x1234567890abcdef` fid: type: integer fname: type: string username: type: string displayName: type: - string - 'null' pfpUrl: type: - string - 'null' position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - address - fid - fname - username - displayName - pfpUrl - position - url - type: object properties: type: type: string enum: - webpage url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end title: type: string description: type: - string - 'null' favicon: type: - string - 'null' format: uri opengraph: type: - object - 'null' properties: title: type: string description: type: - string - 'null' image: type: string format: uri url: type: string format: uri required: - title - description - image - url mediaType: type: string required: - type - url - position - title - description - favicon - opengraph - mediaType - type: object properties: type: type: string enum: - file url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string required: - type - url - position - mediaType - type: object properties: type: type: string enum: - image url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height required: - type - url - position - mediaType - type: object properties: type: type: string enum: - video url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string videoTracks: type: array items: type: object properties: dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height codec: type: string required: - dimension required: - type - url - position - mediaType - type: object properties: type: type: string enum: - quoted_comment id: type: string description: Hex format string, e.g. `0x1234567890abcdef` chainId: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end required: - type - id - chainId - position - {} - type: 'null' path: type: string viewerReactions: type: object additionalProperties: type: array items: type: object properties: *ref_8 required: *ref_9 reactionCounts: type: object additionalProperties: type: number replies: type: object properties: extra: type: object properties: moderationEnabled: type: boolean moderationKnownReactions: type: array items: type: string required: - moderationEnabled - moderationKnownReactions pagination: type: object properties: limit: type: integer hasNext: type: boolean hasPrevious: type: boolean startCursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` endCursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` count: type: integer minimum: 0 required: - limit - hasNext - hasPrevious - count results: type: array items: type: object properties: *ref_1 required: *ref_2 required: - extra - pagination - results required: - app - author - id - channelId - commentType - content - chainId - deletedAt - logIndex - metadata - hookMetadata - parentId - targetUri - txHash - cursor - moderationStatus - moderationStatusChangedAt - moderationClassifierResult - moderationClassifierScore - createdAt - updatedAt - revision - zeroExSwap - references - path - viewerReactions - reactionCounts - replies '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '404': description: Comment not found content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' /api/comments: get: tags: - comments description: Retrieve a list of comments based on the criteria parameters: - schema: type: string description: Hex format string, e.g. `0x1234567890abcdef` pattern: ^0x[a-fA-F0-9]+$ required: false description: Hex format string, e.g. `0x1234567890abcdef` name: author in: query - schema: type: string description: The viewer's address pattern: ^0x[a-fA-F0-9]+$ required: false description: Hex format string, e.g. `0x1234567890abcdef` name: viewer in: query - schema: type: string description: The address of the app signer pattern: ^0x[a-fA-F0-9]+$ required: false description: Hex format string, e.g. `0x1234567890abcdef` name: app in: query - schema: type: string description: >- Non inclusive cursor from which to fetch the comments based on sort pattern: ^0x[a-fA-F0-9]+$ required: false name: cursor in: query - schema: type: string pattern: ^d+$ description: The channel ID required: false name: channelId in: query - schema: type: - integer - 'null' minimum: 0 maximum: 255 description: The comment type (e.g. 0=comment, 1=reaction, not passed = all) required: false name: commentType in: query - schema: type: string description: >- Filters by chain ID. Can be a single chain id or comma-separated list of chain ids (e.g. 1,137,10). required: true name: chainId in: query - schema: anyOf: - type: string enum: *ref_0 - type: array items: type: string enum: *ref_0 description: >- The moderation status of the comments to return. If omitted it will return comments based on moderation settings (approved if moderation is enabled). required: false name: moderationStatus in: query - schema: type: number description: >- The moderation score of the comments to return. If the comment's moderation score exceeds the provided value, it is not returned. minimum: 0 maximum: 1 required: false name: moderationScore in: query - schema: type: string description: >- The moderation labels to exclude from the comments to return. This filter works in conjunction with the `moderationStatus` filter. example: spam,sexual pattern: >- ^(llm_generated|spam|sexual|hate|violence|harassment|self_harm|sexual_minors|hate_threatening|violence_graphic)(,(llm_generated|spam|sexual|hate|violence|harassment|self_harm|sexual_minors|hate_threatening|violence_graphic))*$ required: false name: excludeByModerationLabels in: query - schema: type: integer minimum: 1 maximum: 100 default: 50 description: The number of comments to return required: false name: limit in: query - schema: type: string format: uri description: The comment target URI required: false name: targetUri in: query - schema: type: string enum: &ref_13 - asc - desc default: desc description: The sort order of the comments required: false name: sort in: query - schema: type: string enum: &ref_14 - nested - flat default: nested description: >- The mode to fetch comments in. Nested will return only the first level of comments. Flat will return all replies sorted by timestamp in descending order. required: false name: mode in: query - schema: type: string description: >- Whether to return only deleted or only undeleted comments. If omitted it will return both deleted and undeleted comments. example: '1' pattern: ^(1|0)$ required: false name: isDeleted in: query responses: '200': description: Retrieve a list of comments content: application/json: schema: type: object properties: results: type: array items: type: object properties: app: type: string description: Hex format string, e.g. `0x1234567890abcdef` author: type: object properties: address: type: string description: Hex format string, e.g. `0x1234567890abcdef` ens: type: object properties: name: type: string avatarUrl: type: - string - 'null' required: - name - avatarUrl farcaster: type: object properties: fid: type: integer pfpUrl: type: string displayName: type: string username: type: string required: - fid - username required: - address id: type: string description: Hex format string, e.g. `0x1234567890abcdef` channelId: type: string pattern: ^d+$ commentType: type: integer minimum: 0 maximum: 255 content: type: string chainId: type: integer deletedAt: type: - string - 'null' logIndex: type: - integer - 'null' metadata: type: array items: type: object properties: key: type: string description: Hex format string, e.g. `0x1234567890abcdef` value: type: string description: Hex format string, e.g. `0x1234567890abcdef` required: - key - value hookMetadata: type: array items: type: object properties: key: type: string description: Hex format string, e.g. `0x1234567890abcdef` value: type: string description: Hex format string, e.g. `0x1234567890abcdef` required: - key - value parentId: type: - string - 'null' description: Hex format string, e.g. `0x1234567890abcdef` targetUri: type: string txHash: type: string description: Hex format string, e.g. `0x1234567890abcdef` cursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` moderationStatus: type: string enum: *ref_0 moderationStatusChangedAt: type: - string - 'null' moderationClassifierResult: type: object additionalProperties: type: number minimum: 0 maximum: 1 moderationClassifierScore: type: number minimum: 0 maximum: 1 createdAt: type: - string - 'null' updatedAt: type: - string - 'null' revision: type: integer zeroExSwap: type: - object - 'null' properties: from: type: object properties: address: type: string description: Hex format string, e.g. `0x1234567890abcdef` amount: type: string pattern: ^\d+(\.\d+)?$ symbol: type: string required: - address - amount - symbol to: type: object properties: address: anyOf: - type: string description: >- Hex format string, e.g. `0x1234567890abcdef` - type: string enum: - '' description: Hex format string, e.g. `0x1234567890abcdef` amount: anyOf: - type: string pattern: ^\d+(\.\d+)?$ - type: string enum: - '' symbol: type: string required: - address - amount - symbol required: - from - to references: type: array items: anyOf: - type: object properties: type: type: string enum: - ens avatarUrl: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - avatarUrl - name - address - position - url - type: object properties: type: type: string enum: - erc20 symbol: type: string logoURI: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` decimals: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end chainId: type: - integer - 'null' exclusiveMinimum: 0 chains: type: array items: type: object properties: caip: type: string chainId: type: integer exclusiveMinimum: 0 required: - caip - chainId required: - type - symbol - logoURI - name - address - decimals - position - chainId - chains - type: object properties: type: type: string enum: - farcaster address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` fid: type: integer fname: type: string username: type: string displayName: type: - string - 'null' pfpUrl: type: - string - 'null' position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - address - fid - fname - username - displayName - pfpUrl - position - url - type: object properties: type: type: string enum: - webpage url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end title: type: string description: type: - string - 'null' favicon: type: - string - 'null' format: uri opengraph: type: - object - 'null' properties: title: type: string description: type: - string - 'null' image: type: string format: uri url: type: string format: uri required: - title - description - image - url mediaType: type: string required: - type - url - position - title - description - favicon - opengraph - mediaType - type: object properties: type: type: string enum: - file url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string required: - type - url - position - mediaType - type: object properties: type: type: string enum: - image url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height required: - type - url - position - mediaType - type: object properties: type: type: string enum: - video url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string videoTracks: type: array items: type: object properties: dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height codec: type: string required: - dimension required: - type - url - position - mediaType - type: object properties: type: type: string enum: - quoted_comment id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` chainId: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end required: - type - id - chainId - position - {} - type: 'null' path: type: string viewerReactions: type: object additionalProperties: type: array items: type: object properties: *ref_8 required: *ref_9 reactionCounts: type: object additionalProperties: type: number replies: type: object properties: extra: type: object properties: moderationEnabled: type: boolean moderationKnownReactions: type: array items: type: string required: - moderationEnabled - moderationKnownReactions pagination: type: object properties: limit: type: integer hasNext: type: boolean hasPrevious: type: boolean startCursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` endCursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` count: type: integer minimum: 0 required: - limit - hasNext - hasPrevious - count results: type: array items: type: object properties: *ref_1 required: *ref_2 required: - extra - pagination - results required: - app - author - id - channelId - commentType - content - chainId - deletedAt - logIndex - metadata - hookMetadata - parentId - targetUri - txHash - cursor - moderationStatus - moderationStatusChangedAt - moderationClassifierResult - moderationClassifierScore - createdAt - updatedAt - revision - zeroExSwap - references - path - viewerReactions - reactionCounts - replies pagination: type: object properties: limit: type: integer hasNext: type: boolean hasPrevious: type: boolean startCursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` endCursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` required: - limit - hasNext - hasPrevious extra: type: object properties: moderationEnabled: type: boolean moderationKnownReactions: type: array items: type: string required: - moderationEnabled - moderationKnownReactions required: - results - pagination - extra '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' /api/comments/by-path/{authorShortId}/{commentShortId}: get: tags: - comments description: Retrieve a single comment by path parameters: - schema: type: string description: The author short id, whole address or ENS name required: true name: authorShortId in: path - schema: type: string pattern: ^0x[a-fA-F0-9]+(\.\.\.)?[a-fA-F0-9]+$ description: The comment short id or full comment ID in hex format required: true name: commentShortId in: path - schema: type: string description: The viewer's address, for personalized data such as reactions pattern: ^0x[a-fA-F0-9]+$ required: false description: Hex format string, e.g. `0x1234567890abcdef` name: viewer in: query - schema: type: string description: >- Filters by chain ID. Can be a single chain id or comma-separated list of chain ids (e.g. 1,137,10). required: true name: chainId in: query - schema: type: string enum: *ref_10 default: nested description: >- The mode to fetch comments in. Nested will return only the first level of comments. Flat will return all replies sorted by timestamp in descending order. required: false name: mode in: query - schema: type: - integer - 'null' minimum: 0 maximum: 255 description: The comment type (e.g. 0=comment, 1=reaction, not passed = all) required: false name: commentType in: query - schema: type: string description: >- Whether to return only deleted replies or only undeleted replies. If omitted it will return both deleted and undeleted replies. example: '1' pattern: ^(1|0)$ required: false name: isReplyDeleted in: query responses: '200': description: A single comment content: application/json: schema: type: object properties: app: type: string description: Hex format string, e.g. `0x1234567890abcdef` author: type: object properties: address: type: string description: Hex format string, e.g. `0x1234567890abcdef` ens: type: object properties: name: type: string avatarUrl: type: - string - 'null' required: - name - avatarUrl farcaster: type: object properties: fid: type: integer pfpUrl: type: string displayName: type: string username: type: string required: - fid - username required: - address id: type: string description: Hex format string, e.g. `0x1234567890abcdef` channelId: type: string pattern: ^d+$ commentType: type: integer minimum: 0 maximum: 255 content: type: string chainId: type: integer deletedAt: type: - string - 'null' logIndex: type: - integer - 'null' metadata: type: array items: type: object properties: key: type: string description: Hex format string, e.g. `0x1234567890abcdef` value: type: string description: Hex format string, e.g. `0x1234567890abcdef` required: - key - value hookMetadata: type: array items: type: object properties: key: type: string description: Hex format string, e.g. `0x1234567890abcdef` value: type: string description: Hex format string, e.g. `0x1234567890abcdef` required: - key - value parentId: type: - string - 'null' description: Hex format string, e.g. `0x1234567890abcdef` targetUri: type: string txHash: type: string description: Hex format string, e.g. `0x1234567890abcdef` cursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` moderationStatus: type: string enum: *ref_3 moderationStatusChangedAt: type: - string - 'null' moderationClassifierResult: type: object additionalProperties: type: number minimum: 0 maximum: 1 moderationClassifierScore: type: number minimum: 0 maximum: 1 createdAt: type: - string - 'null' updatedAt: type: - string - 'null' revision: type: integer zeroExSwap: type: - object - 'null' properties: from: type: object properties: address: type: string description: Hex format string, e.g. `0x1234567890abcdef` amount: type: string pattern: ^\d+(\.\d+)?$ symbol: type: string required: - address - amount - symbol to: type: object properties: address: anyOf: - type: string description: Hex format string, e.g. `0x1234567890abcdef` - type: string enum: - '' description: Hex format string, e.g. `0x1234567890abcdef` amount: anyOf: - type: string pattern: ^\d+(\.\d+)?$ - type: string enum: - '' symbol: type: string required: - address - amount - symbol required: - from - to references: type: array items: anyOf: - type: object properties: type: type: string enum: - ens avatarUrl: type: - string - 'null' name: type: string address: type: string description: Hex format string, e.g. `0x1234567890abcdef` position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - avatarUrl - name - address - position - url - type: object properties: type: type: string enum: - erc20 symbol: type: string logoURI: type: - string - 'null' name: type: string address: type: string description: Hex format string, e.g. `0x1234567890abcdef` decimals: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end chainId: type: - integer - 'null' exclusiveMinimum: 0 chains: type: array items: type: object properties: caip: type: string chainId: type: integer exclusiveMinimum: 0 required: - caip - chainId required: - type - symbol - logoURI - name - address - decimals - position - chainId - chains - type: object properties: type: type: string enum: - farcaster address: type: string description: Hex format string, e.g. `0x1234567890abcdef` fid: type: integer fname: type: string username: type: string displayName: type: - string - 'null' pfpUrl: type: - string - 'null' position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - address - fid - fname - username - displayName - pfpUrl - position - url - type: object properties: type: type: string enum: - webpage url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end title: type: string description: type: - string - 'null' favicon: type: - string - 'null' format: uri opengraph: type: - object - 'null' properties: title: type: string description: type: - string - 'null' image: type: string format: uri url: type: string format: uri required: - title - description - image - url mediaType: type: string required: - type - url - position - title - description - favicon - opengraph - mediaType - type: object properties: type: type: string enum: - file url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string required: - type - url - position - mediaType - type: object properties: type: type: string enum: - image url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height required: - type - url - position - mediaType - type: object properties: type: type: string enum: - video url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string videoTracks: type: array items: type: object properties: dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height codec: type: string required: - dimension required: - type - url - position - mediaType - type: object properties: type: type: string enum: - quoted_comment id: type: string description: Hex format string, e.g. `0x1234567890abcdef` chainId: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end required: - type - id - chainId - position - {} - type: 'null' path: type: string viewerReactions: type: object additionalProperties: type: array items: type: object properties: *ref_11 required: *ref_12 reactionCounts: type: object additionalProperties: type: number replies: type: object properties: extra: type: object properties: moderationEnabled: type: boolean moderationKnownReactions: type: array items: type: string required: - moderationEnabled - moderationKnownReactions pagination: type: object properties: limit: type: integer hasNext: type: boolean hasPrevious: type: boolean startCursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` endCursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` count: type: integer minimum: 0 required: - limit - hasNext - hasPrevious - count results: type: array items: type: object properties: *ref_4 required: *ref_5 required: - extra - pagination - results required: - app - author - id - channelId - commentType - content - chainId - deletedAt - logIndex - metadata - hookMetadata - parentId - targetUri - txHash - cursor - moderationStatus - moderationStatusChangedAt - moderationClassifierResult - moderationClassifierScore - createdAt - updatedAt - revision - zeroExSwap - references - path - viewerReactions - reactionCounts - replies '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '404': description: Comment not found content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' /api/comments/{commentId}/replies: get: tags: - comments description: >- Return replies to a comment according to the comment id and additional criteria parameters: - schema: type: string description: The comment ID required: true description: Hex format string, e.g. `0x1234567890abcdef` name: commentId in: path - schema: type: string description: Hex format string, e.g. `0x1234567890abcdef` pattern: ^0x[a-fA-F0-9]+$ required: false description: Hex format string, e.g. `0x1234567890abcdef` name: author in: query - schema: type: string description: The viewer's address pattern: ^0x[a-fA-F0-9]+$ required: false description: Hex format string, e.g. `0x1234567890abcdef` name: viewer in: query - schema: type: string description: The address of the app signer pattern: ^0x[a-fA-F0-9]+$ required: false description: Hex format string, e.g. `0x1234567890abcdef` name: app in: query - schema: type: string description: >- Non inclusive cursor from which to fetch the comments based on sort pattern: ^0x[a-fA-F0-9]+$ required: false name: cursor in: query - schema: type: string pattern: ^d+$ description: The channel ID required: false name: channelId in: query - schema: type: - integer - 'null' minimum: 0 maximum: 255 description: The comment type (e.g. 0=comment, 1=reaction, not passed = all) required: false name: commentType in: query - schema: type: string description: >- Filters by chain ID. Can be a single chain id or comma-separated list of chain ids (e.g. 1,137,10). required: true name: chainId in: query - schema: anyOf: - type: string enum: *ref_0 - type: array items: type: string enum: *ref_0 description: >- The moderation status of the comments to return. If omitted it will return comments based on moderation settings (approved if moderation is enabled). required: false name: moderationStatus in: query - schema: type: number description: >- The moderation score of the comments to return. If the comment's moderation score exceeds the provided value, it is not returned. minimum: 0 maximum: 1 required: false name: moderationScore in: query - schema: type: string description: >- The moderation labels to exclude from the comments to return. This filter works in conjunction with the `moderationStatus` filter. example: spam,sexual pattern: >- ^(llm_generated|spam|sexual|hate|violence|harassment|self_harm|sexual_minors|hate_threatening|violence_graphic)(,(llm_generated|spam|sexual|hate|violence|harassment|self_harm|sexual_minors|hate_threatening|violence_graphic))*$ required: false name: excludeByModerationLabels in: query - schema: type: integer minimum: 1 maximum: 100 default: 50 description: The number of comments to return required: false name: limit in: query - schema: type: string enum: *ref_13 default: desc description: The sort order of the comments required: false name: sort in: query - schema: type: string enum: *ref_14 default: nested description: >- The mode to fetch comments in. Nested will return only the first level of comments. Flat will return all replies sorted by timestamp in descending order. required: false name: mode in: query - schema: type: string description: >- Whether to return only deleted or only undeleted comments. If omitted it will return both deleted and undeleted comments. example: '1' pattern: ^(1|0)$ required: false name: isDeleted in: query responses: '200': description: Retrieve replies to the specified comment content: application/json: schema: type: object properties: results: type: array items: type: object properties: app: type: string description: Hex format string, e.g. `0x1234567890abcdef` author: type: object properties: address: type: string description: Hex format string, e.g. `0x1234567890abcdef` ens: type: object properties: name: type: string avatarUrl: type: - string - 'null' required: - name - avatarUrl farcaster: type: object properties: fid: type: integer pfpUrl: type: string displayName: type: string username: type: string required: - fid - username required: - address id: type: string description: Hex format string, e.g. `0x1234567890abcdef` channelId: type: string pattern: ^d+$ commentType: type: integer minimum: 0 maximum: 255 content: type: string chainId: type: integer deletedAt: type: - string - 'null' logIndex: type: - integer - 'null' metadata: type: array items: type: object properties: key: type: string description: Hex format string, e.g. `0x1234567890abcdef` value: type: string description: Hex format string, e.g. `0x1234567890abcdef` required: - key - value hookMetadata: type: array items: type: object properties: key: type: string description: Hex format string, e.g. `0x1234567890abcdef` value: type: string description: Hex format string, e.g. `0x1234567890abcdef` required: - key - value parentId: type: - string - 'null' description: Hex format string, e.g. `0x1234567890abcdef` targetUri: type: string txHash: type: string description: Hex format string, e.g. `0x1234567890abcdef` cursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` moderationStatus: type: string enum: *ref_0 moderationStatusChangedAt: type: - string - 'null' moderationClassifierResult: type: object additionalProperties: type: number minimum: 0 maximum: 1 moderationClassifierScore: type: number minimum: 0 maximum: 1 createdAt: type: - string - 'null' updatedAt: type: - string - 'null' revision: type: integer zeroExSwap: type: - object - 'null' properties: from: type: object properties: address: type: string description: Hex format string, e.g. `0x1234567890abcdef` amount: type: string pattern: ^\d+(\.\d+)?$ symbol: type: string required: - address - amount - symbol to: type: object properties: address: anyOf: - type: string description: >- Hex format string, e.g. `0x1234567890abcdef` - type: string enum: - '' description: Hex format string, e.g. `0x1234567890abcdef` amount: anyOf: - type: string pattern: ^\d+(\.\d+)?$ - type: string enum: - '' symbol: type: string required: - address - amount - symbol required: - from - to references: type: array items: anyOf: - type: object properties: type: type: string enum: - ens avatarUrl: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - avatarUrl - name - address - position - url - type: object properties: type: type: string enum: - erc20 symbol: type: string logoURI: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` decimals: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end chainId: type: - integer - 'null' exclusiveMinimum: 0 chains: type: array items: type: object properties: caip: type: string chainId: type: integer exclusiveMinimum: 0 required: - caip - chainId required: - type - symbol - logoURI - name - address - decimals - position - chainId - chains - type: object properties: type: type: string enum: - farcaster address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` fid: type: integer fname: type: string username: type: string displayName: type: - string - 'null' pfpUrl: type: - string - 'null' position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - address - fid - fname - username - displayName - pfpUrl - position - url - type: object properties: type: type: string enum: - webpage url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end title: type: string description: type: - string - 'null' favicon: type: - string - 'null' format: uri opengraph: type: - object - 'null' properties: title: type: string description: type: - string - 'null' image: type: string format: uri url: type: string format: uri required: - title - description - image - url mediaType: type: string required: - type - url - position - title - description - favicon - opengraph - mediaType - type: object properties: type: type: string enum: - file url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string required: - type - url - position - mediaType - type: object properties: type: type: string enum: - image url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height required: - type - url - position - mediaType - type: object properties: type: type: string enum: - video url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string videoTracks: type: array items: type: object properties: dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height codec: type: string required: - dimension required: - type - url - position - mediaType - type: object properties: type: type: string enum: - quoted_comment id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` chainId: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end required: - type - id - chainId - position - {} - type: 'null' path: type: string viewerReactions: type: object additionalProperties: type: array items: type: object properties: *ref_8 required: *ref_9 reactionCounts: type: object additionalProperties: type: number replies: type: object properties: extra: type: object properties: moderationEnabled: type: boolean moderationKnownReactions: type: array items: type: string required: - moderationEnabled - moderationKnownReactions pagination: type: object properties: limit: type: integer hasNext: type: boolean hasPrevious: type: boolean startCursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` endCursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` count: type: integer minimum: 0 required: - limit - hasNext - hasPrevious - count results: type: array items: type: object properties: *ref_1 required: *ref_2 required: - extra - pagination - results required: - app - author - id - channelId - commentType - content - chainId - deletedAt - logIndex - metadata - hookMetadata - parentId - targetUri - txHash - cursor - moderationStatus - moderationStatusChangedAt - moderationClassifierResult - moderationClassifierScore - createdAt - updatedAt - revision - zeroExSwap - references - path - viewerReactions - reactionCounts - replies pagination: type: object properties: limit: type: integer hasNext: type: boolean hasPrevious: type: boolean startCursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` endCursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` required: - limit - hasNext - hasPrevious extra: type: object properties: moderationEnabled: type: boolean moderationKnownReactions: type: array items: type: string required: - moderationEnabled - moderationKnownReactions required: - results - pagination - extra '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' /api/approvals: get: tags: - approvals description: Retrieve a list of approvals according to the criteria parameters: - schema: type: string description: >- The author's address. Can be used to filter approvals by author. Either `author` or `app` must be provided or both. pattern: ^0x[a-fA-F0-9]+$ required: false description: Hex format string, e.g. `0x1234567890abcdef` name: author in: query - schema: type: string description: >- The address of the app signer. Can be used to filter approvals by app. Either `author` or `app` must be provided or both. pattern: ^0x[a-fA-F0-9]+$ required: false description: Hex format string, e.g. `0x1234567890abcdef` name: app in: query - schema: type: string description: >- Filters by chain ID. Can be a single chain id or comma-separated list of chain ids (e.g. 1,137,10). required: true name: chainId in: query - schema: type: integer exclusiveMinimum: 0 maximum: 100 default: 50 description: The number of approvals to return required: false name: limit in: query - schema: type: - integer - 'null' minimum: 0 default: 0 description: The offset of the approvals to return required: false name: offset in: query responses: '200': description: Retrieve a list of approvals according to the criteria content: application/json: schema: type: object properties: results: type: array items: type: object properties: id: type: string app: type: string description: Hex format string, e.g. `0x1234567890abcdef` pattern: ^0x[a-fA-F0-9]+$ author: type: string description: Hex format string, e.g. `0x1234567890abcdef` pattern: ^0x[a-fA-F0-9]+$ deletedAt: type: - string - 'null' description: A date string in ISO 8601 format chainId: type: integer txHash: type: string description: Hex format string, e.g. `0x1234567890abcdef` pattern: ^0x[a-fA-F0-9]+$ expiresAt: type: string description: A date string in ISO 8601 format required: - id - app - author - deletedAt - chainId - txHash - expiresAt pagination: type: object properties: limit: type: integer offset: type: integer hasMore: type: boolean required: - limit - offset - hasMore required: - results - pagination '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' /api/authors/{authorAddress}: get: tags: - comments description: Retrieve author ENS / Farcaster data parameters: - schema: type: string description: The author's address pattern: ^0x[a-fA-F0-9]+$ required: true description: Hex format string, e.g. `0x1234567890abcdef` name: authorAddress in: path responses: '200': description: An object with author address and ENS and Farcaster data content: application/json: schema: type: object properties: address: type: string description: Hex format string, e.g. `0x1234567890abcdef` ens: type: object properties: name: type: string avatarUrl: type: - string - 'null' required: - name - avatarUrl farcaster: type: object properties: fid: type: integer pfpUrl: type: string displayName: type: string username: type: string required: - fid - username required: - address '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' /api/muted-accounts/{address}: get: tags: - comments description: Check if an address is marked as muted parameters: - schema: type: string description: The address of the muted account pattern: ^0x[a-fA-F0-9]+$ required: true description: Hex format string, e.g. `0x1234567890abcdef` name: address in: path responses: '200': description: When address is marked as muted content: application/json: schema: type: object properties: address: type: string description: The address of the muted account pattern: ^0x[a-fA-F0-9]+$ createdAt: type: - string - 'null' description: The date the account was muted required: - address - createdAt '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '404': description: When address is not marked as muted content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' delete: tags: - comments description: >- Removes account from muted list, newer comments from this account will be indexed parameters: - schema: type: string description: The address of the muted account pattern: ^0x[a-fA-F0-9]+$ required: true description: Hex format string, e.g. `0x1234567890abcdef` name: address in: path responses: '204': description: When muted account was unmuted '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '401': description: When request is not authenticated content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '404': description: When muted account was not found in the list content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' /api/muted-accounts: post: tags: - comments description: >- Marks account as muted, newer comments from this account won't be indexed requestBody: required: true content: application/json: schema: type: object properties: address: type: string description: The address of the muted account pattern: ^0x[a-fA-F0-9]+$ reason: type: string description: The reason for muting the account required: - address responses: '200': description: An object with muted account address content: application/json: schema: type: object properties: address: type: string description: The address of the muted account pattern: ^0x[a-fA-F0-9]+$ required: - address '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '401': description: When request is not authenticated content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '409': description: When account is already marked as muted content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' /api/moderate-comments: get: tags: - comments description: Get a list of comments pending moderation parameters: - schema: type: string description: >- Non inclusive cursor from which to fetch the comments based on sort pattern: ^0x[a-fA-F0-9]+$ required: false name: cursor in: query - schema: type: integer minimum: 1 maximum: 100 default: 50 description: The number of comments to return required: false name: limit in: query - schema: type: string enum: - asc - desc default: desc description: The sort order of the comments required: false name: sort in: query responses: '200': description: List of pending comments content: application/json: schema: type: object properties: results: type: array items: type: object properties: app: type: string description: Hex format string, e.g. `0x1234567890abcdef` author: type: object properties: address: type: string description: Hex format string, e.g. `0x1234567890abcdef` ens: type: object properties: name: type: string avatarUrl: type: - string - 'null' required: - name - avatarUrl farcaster: type: object properties: fid: type: integer pfpUrl: type: string displayName: type: string username: type: string required: - fid - username required: - address id: type: string description: Hex format string, e.g. `0x1234567890abcdef` channelId: type: string pattern: ^d+$ commentType: type: integer minimum: 0 maximum: 255 content: type: string chainId: type: integer deletedAt: type: - string - 'null' logIndex: type: - integer - 'null' metadata: type: array items: type: object properties: key: type: string description: Hex format string, e.g. `0x1234567890abcdef` value: type: string description: Hex format string, e.g. `0x1234567890abcdef` required: - key - value hookMetadata: type: array items: type: object properties: key: type: string description: Hex format string, e.g. `0x1234567890abcdef` value: type: string description: Hex format string, e.g. `0x1234567890abcdef` required: - key - value parentId: type: - string - 'null' description: Hex format string, e.g. `0x1234567890abcdef` targetUri: type: string txHash: type: string description: Hex format string, e.g. `0x1234567890abcdef` cursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` moderationStatus: type: string enum: *ref_0 moderationStatusChangedAt: type: - string - 'null' moderationClassifierResult: type: object additionalProperties: type: number minimum: 0 maximum: 1 moderationClassifierScore: type: number minimum: 0 maximum: 1 createdAt: type: - string - 'null' updatedAt: type: - string - 'null' revision: type: integer zeroExSwap: type: - object - 'null' properties: from: type: object properties: address: type: string description: Hex format string, e.g. `0x1234567890abcdef` amount: type: string pattern: ^\d+(\.\d+)?$ symbol: type: string required: - address - amount - symbol to: type: object properties: address: anyOf: - type: string description: >- Hex format string, e.g. `0x1234567890abcdef` - type: string enum: - '' description: Hex format string, e.g. `0x1234567890abcdef` amount: anyOf: - type: string pattern: ^\d+(\.\d+)?$ - type: string enum: - '' symbol: type: string required: - address - amount - symbol required: - from - to references: type: array items: anyOf: - type: object properties: type: type: string enum: - ens avatarUrl: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - avatarUrl - name - address - position - url - type: object properties: type: type: string enum: - erc20 symbol: type: string logoURI: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` decimals: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end chainId: type: - integer - 'null' exclusiveMinimum: 0 chains: type: array items: type: object properties: caip: type: string chainId: type: integer exclusiveMinimum: 0 required: - caip - chainId required: - type - symbol - logoURI - name - address - decimals - position - chainId - chains - type: object properties: type: type: string enum: - farcaster address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` fid: type: integer fname: type: string username: type: string displayName: type: - string - 'null' pfpUrl: type: - string - 'null' position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - address - fid - fname - username - displayName - pfpUrl - position - url - type: object properties: type: type: string enum: - webpage url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end title: type: string description: type: - string - 'null' favicon: type: - string - 'null' format: uri opengraph: type: - object - 'null' properties: title: type: string description: type: - string - 'null' image: type: string format: uri url: type: string format: uri required: - title - description - image - url mediaType: type: string required: - type - url - position - title - description - favicon - opengraph - mediaType - type: object properties: type: type: string enum: - file url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string required: - type - url - position - mediaType - type: object properties: type: type: string enum: - image url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height required: - type - url - position - mediaType - type: object properties: type: type: string enum: - video url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string videoTracks: type: array items: type: object properties: dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height codec: type: string required: - dimension required: - type - url - position - mediaType - type: object properties: type: type: string enum: - quoted_comment id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` chainId: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end required: - type - id - chainId - position - {} - type: 'null' path: type: string viewerReactions: type: object additionalProperties: type: array items: type: object properties: *ref_8 required: *ref_9 reactionCounts: type: object additionalProperties: type: number replies: type: object properties: extra: type: object properties: moderationEnabled: type: boolean moderationKnownReactions: type: array items: type: string required: - moderationEnabled - moderationKnownReactions pagination: type: object properties: limit: type: integer hasNext: type: boolean hasPrevious: type: boolean startCursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` endCursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` count: type: integer minimum: 0 required: - limit - hasNext - hasPrevious - count results: type: array items: type: object properties: *ref_1 required: *ref_2 required: - extra - pagination - results required: - app - author - id - channelId - commentType - content - chainId - deletedAt - logIndex - metadata - hookMetadata - parentId - targetUri - txHash - cursor - moderationStatus - moderationStatusChangedAt - moderationClassifierResult - moderationClassifierScore - createdAt - updatedAt - revision - zeroExSwap - references - path - viewerReactions - reactionCounts - replies pagination: type: object properties: limit: type: integer hasNext: type: boolean hasPrevious: type: boolean startCursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` endCursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` required: - limit - hasNext - hasPrevious required: - results - pagination '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '401': description: When user is not authenticated content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' /api/moderate-comments/{commentId}: patch: tags: - comments description: Change the moderation status of a comment parameters: - schema: type: string description: The ID of the comment to moderate pattern: ^0x[a-fA-F0-9]+$ required: true description: Hex format string, e.g. `0x1234567890abcdef` name: commentId in: path requestBody: required: true content: application/json: schema: type: object properties: revision: type: integer minimum: 0 description: >- The revision of the comment. If omitted it will update the latest revision and all older pending revisions. moderationStatus: type: string enum: *ref_0 description: The moderation status of the comment required: - moderationStatus responses: '200': description: Comment with moderation status changed content: application/json: schema: type: object properties: app: type: string description: Hex format string, e.g. `0x1234567890abcdef` author: type: object properties: address: type: string description: Hex format string, e.g. `0x1234567890abcdef` ens: type: object properties: name: type: string avatarUrl: type: - string - 'null' required: - name - avatarUrl farcaster: type: object properties: fid: type: integer pfpUrl: type: string displayName: type: string username: type: string required: - fid - username required: - address id: type: string description: Hex format string, e.g. `0x1234567890abcdef` channelId: type: string pattern: ^d+$ commentType: type: integer minimum: 0 maximum: 255 content: type: string chainId: type: integer deletedAt: type: - string - 'null' logIndex: type: - integer - 'null' metadata: type: array items: type: object properties: key: type: string description: Hex format string, e.g. `0x1234567890abcdef` value: type: string description: Hex format string, e.g. `0x1234567890abcdef` required: - key - value hookMetadata: type: array items: type: object properties: key: type: string description: Hex format string, e.g. `0x1234567890abcdef` value: type: string description: Hex format string, e.g. `0x1234567890abcdef` required: - key - value parentId: type: - string - 'null' description: Hex format string, e.g. `0x1234567890abcdef` targetUri: type: string txHash: type: string description: Hex format string, e.g. `0x1234567890abcdef` cursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` moderationStatus: type: string enum: *ref_0 moderationStatusChangedAt: type: - string - 'null' moderationClassifierResult: type: object additionalProperties: type: number minimum: 0 maximum: 1 moderationClassifierScore: type: number minimum: 0 maximum: 1 createdAt: type: - string - 'null' updatedAt: type: - string - 'null' revision: type: integer zeroExSwap: type: - object - 'null' properties: from: type: object properties: address: type: string description: Hex format string, e.g. `0x1234567890abcdef` amount: type: string pattern: ^\d+(\.\d+)?$ symbol: type: string required: - address - amount - symbol to: type: object properties: address: anyOf: - type: string description: Hex format string, e.g. `0x1234567890abcdef` - type: string enum: - '' description: Hex format string, e.g. `0x1234567890abcdef` amount: anyOf: - type: string pattern: ^\d+(\.\d+)?$ - type: string enum: - '' symbol: type: string required: - address - amount - symbol required: - from - to references: type: array items: anyOf: - type: object properties: type: type: string enum: - ens avatarUrl: type: - string - 'null' name: type: string address: type: string description: Hex format string, e.g. `0x1234567890abcdef` position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - avatarUrl - name - address - position - url - type: object properties: type: type: string enum: - erc20 symbol: type: string logoURI: type: - string - 'null' name: type: string address: type: string description: Hex format string, e.g. `0x1234567890abcdef` decimals: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end chainId: type: - integer - 'null' exclusiveMinimum: 0 chains: type: array items: type: object properties: caip: type: string chainId: type: integer exclusiveMinimum: 0 required: - caip - chainId required: - type - symbol - logoURI - name - address - decimals - position - chainId - chains - type: object properties: type: type: string enum: - farcaster address: type: string description: Hex format string, e.g. `0x1234567890abcdef` fid: type: integer fname: type: string username: type: string displayName: type: - string - 'null' pfpUrl: type: - string - 'null' position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - address - fid - fname - username - displayName - pfpUrl - position - url - type: object properties: type: type: string enum: - webpage url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end title: type: string description: type: - string - 'null' favicon: type: - string - 'null' format: uri opengraph: type: - object - 'null' properties: title: type: string description: type: - string - 'null' image: type: string format: uri url: type: string format: uri required: - title - description - image - url mediaType: type: string required: - type - url - position - title - description - favicon - opengraph - mediaType - type: object properties: type: type: string enum: - file url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string required: - type - url - position - mediaType - type: object properties: type: type: string enum: - image url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height required: - type - url - position - mediaType - type: object properties: type: type: string enum: - video url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string videoTracks: type: array items: type: object properties: dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height codec: type: string required: - dimension required: - type - url - position - mediaType - type: object properties: type: type: string enum: - quoted_comment id: type: string description: Hex format string, e.g. `0x1234567890abcdef` chainId: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end required: - type - id - chainId - position - {} - type: 'null' path: type: string viewerReactions: type: object additionalProperties: type: array items: type: object properties: *ref_15 required: *ref_16 reactionCounts: type: object additionalProperties: type: number replies: type: object properties: extra: type: object properties: moderationEnabled: type: boolean moderationKnownReactions: type: array items: type: string required: - moderationEnabled - moderationKnownReactions pagination: type: object properties: limit: type: integer hasNext: type: boolean hasPrevious: type: boolean startCursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` endCursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` count: type: integer minimum: 0 required: - limit - hasNext - hasPrevious - count results: type: array items: type: object properties: *ref_6 required: *ref_7 required: - extra - pagination - results required: - app - author - id - channelId - commentType - content - chainId - deletedAt - logIndex - metadata - hookMetadata - parentId - targetUri - txHash - cursor - moderationStatus - moderationStatusChangedAt - moderationClassifierResult - moderationClassifierScore - createdAt - updatedAt - revision - zeroExSwap - references - path - viewerReactions - reactionCounts - replies '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '401': description: When user is not authenticated content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '404': description: When comment is not found content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' get: tags: - comments description: Get a comment by ID with its moderation status parameters: - schema: type: string description: The ID of the comment to moderate pattern: ^0x[a-fA-F0-9]+$ required: true description: Hex format string, e.g. `0x1234567890abcdef` name: commentId in: path responses: '200': description: Comment found content: application/json: schema: type: object properties: app: type: string description: Hex format string, e.g. `0x1234567890abcdef` author: type: object properties: address: type: string description: Hex format string, e.g. `0x1234567890abcdef` ens: type: object properties: name: type: string avatarUrl: type: - string - 'null' required: - name - avatarUrl farcaster: type: object properties: fid: type: integer pfpUrl: type: string displayName: type: string username: type: string required: - fid - username required: - address id: type: string description: Hex format string, e.g. `0x1234567890abcdef` channelId: type: string pattern: ^d+$ commentType: type: integer minimum: 0 maximum: 255 content: type: string chainId: type: integer deletedAt: type: - string - 'null' logIndex: type: - integer - 'null' metadata: type: array items: type: object properties: key: type: string description: Hex format string, e.g. `0x1234567890abcdef` value: type: string description: Hex format string, e.g. `0x1234567890abcdef` required: - key - value hookMetadata: type: array items: type: object properties: key: type: string description: Hex format string, e.g. `0x1234567890abcdef` value: type: string description: Hex format string, e.g. `0x1234567890abcdef` required: - key - value parentId: type: - string - 'null' description: Hex format string, e.g. `0x1234567890abcdef` targetUri: type: string txHash: type: string description: Hex format string, e.g. `0x1234567890abcdef` cursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` moderationStatus: type: string enum: *ref_0 moderationStatusChangedAt: type: - string - 'null' moderationClassifierResult: type: object additionalProperties: type: number minimum: 0 maximum: 1 moderationClassifierScore: type: number minimum: 0 maximum: 1 createdAt: type: - string - 'null' updatedAt: type: - string - 'null' revision: type: integer zeroExSwap: type: - object - 'null' properties: from: type: object properties: address: type: string description: Hex format string, e.g. `0x1234567890abcdef` amount: type: string pattern: ^\d+(\.\d+)?$ symbol: type: string required: - address - amount - symbol to: type: object properties: address: anyOf: - type: string description: Hex format string, e.g. `0x1234567890abcdef` - type: string enum: - '' description: Hex format string, e.g. `0x1234567890abcdef` amount: anyOf: - type: string pattern: ^\d+(\.\d+)?$ - type: string enum: - '' symbol: type: string required: - address - amount - symbol required: - from - to references: type: array items: anyOf: - type: object properties: type: type: string enum: - ens avatarUrl: type: - string - 'null' name: type: string address: type: string description: Hex format string, e.g. `0x1234567890abcdef` position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - avatarUrl - name - address - position - url - type: object properties: type: type: string enum: - erc20 symbol: type: string logoURI: type: - string - 'null' name: type: string address: type: string description: Hex format string, e.g. `0x1234567890abcdef` decimals: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end chainId: type: - integer - 'null' exclusiveMinimum: 0 chains: type: array items: type: object properties: caip: type: string chainId: type: integer exclusiveMinimum: 0 required: - caip - chainId required: - type - symbol - logoURI - name - address - decimals - position - chainId - chains - type: object properties: type: type: string enum: - farcaster address: type: string description: Hex format string, e.g. `0x1234567890abcdef` fid: type: integer fname: type: string username: type: string displayName: type: - string - 'null' pfpUrl: type: - string - 'null' position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - address - fid - fname - username - displayName - pfpUrl - position - url - type: object properties: type: type: string enum: - webpage url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end title: type: string description: type: - string - 'null' favicon: type: - string - 'null' format: uri opengraph: type: - object - 'null' properties: title: type: string description: type: - string - 'null' image: type: string format: uri url: type: string format: uri required: - title - description - image - url mediaType: type: string required: - type - url - position - title - description - favicon - opengraph - mediaType - type: object properties: type: type: string enum: - file url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string required: - type - url - position - mediaType - type: object properties: type: type: string enum: - image url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height required: - type - url - position - mediaType - type: object properties: type: type: string enum: - video url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string videoTracks: type: array items: type: object properties: dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height codec: type: string required: - dimension required: - type - url - position - mediaType - type: object properties: type: type: string enum: - quoted_comment id: type: string description: Hex format string, e.g. `0x1234567890abcdef` chainId: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end required: - type - id - chainId - position - {} - type: 'null' path: type: string viewerReactions: type: object additionalProperties: type: array items: type: object properties: *ref_15 required: *ref_16 reactionCounts: type: object additionalProperties: type: number replies: type: object properties: extra: type: object properties: moderationEnabled: type: boolean moderationKnownReactions: type: array items: type: string required: - moderationEnabled - moderationKnownReactions pagination: type: object properties: limit: type: integer hasNext: type: boolean hasPrevious: type: boolean startCursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` endCursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` count: type: integer minimum: 0 required: - limit - hasNext - hasPrevious - count results: type: array items: type: object properties: *ref_6 required: *ref_7 required: - extra - pagination - results required: - app - author - id - channelId - commentType - content - chainId - deletedAt - logIndex - metadata - hookMetadata - parentId - targetUri - txHash - cursor - moderationStatus - moderationStatusChangedAt - moderationClassifierResult - moderationClassifierScore - createdAt - updatedAt - revision - zeroExSwap - references - path - viewerReactions - reactionCounts - replies '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '401': description: When user is not authenticated content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '404': description: When comment is not found content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' /api/webhook: post: description: Webhook to receive commands requestBody: required: true content: application/json: schema: type: object properties: callback_query: type: object properties: id: type: string minLength: 1 data: type: string minLength: 1 message: type: object properties: message_id: type: integer minimum: 0 required: - message_id from: type: object properties: id: type: integer minimum: 0 username: type: - string - 'null' required: - id - username required: - id - data - message required: - callback_query responses: '204': description: When webhook request is valid '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '401': description: When request signature is not valid content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' /api/autocomplete: get: tags: - autocomplete - ens - erc20 - farcaster description: Retrieve a list of autocomplete suggestions parameters: - schema: type: string minLength: 2 description: The query to autocomplete required: true name: query in: query - schema: type: string enum: - '@' - $ description: >- The prefix character. $ is more specific and looks only for ERC20 tokens (by address or symbol), @ is more general and looks for ENS/Farcaster name and ERC20 tokens. required: true name: char in: query responses: '200': description: List of autocomplete suggestions content: application/json: schema: type: object properties: results: type: array items: oneOf: - type: object properties: type: type: string enum: - ens address: type: string description: Hex format string, e.g. `0x1234567890abcdef` name: type: string avatarUrl: type: - string - 'null' url: type: string value: type: string description: >- The value in hex format of the autocomplete suggestion that should be used. required: - type - address - name - avatarUrl - url - value - type: object properties: type: type: string enum: - erc20 address: type: string description: Hex format string, e.g. `0x1234567890abcdef` name: type: string symbol: type: string caip19: type: string chainId: type: integer decimals: type: integer logoURI: type: - string - 'null' value: type: string description: >- The value in CAIP-19 format of the autocomplete suggestion that should be used. required: - type - address - name - symbol - caip19 - chainId - decimals - logoURI - value - type: object properties: type: type: string enum: - farcaster address: type: string description: Hex format string, e.g. `0x1234567890abcdef` fid: type: integer fname: type: string displayName: type: - string - 'null' username: type: string pfpUrl: type: - string - 'null' url: type: string value: type: string description: >- The value in hex format of the autocomplete suggestion that should be used. required: - type - address - fid - fname - username - url - value required: - results '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' /api/comments/{commentId}/reports: post: tags: - comments description: Report a comment parameters: - schema: type: string description: Hex format string, e.g. `0x1234567890abcdef` required: true description: Hex format string, e.g. `0x1234567890abcdef` name: commentId in: path requestBody: required: true content: application/json: schema: type: object properties: reportee: type: string description: Hex format string, e.g. `0x1234567890abcdef` message: type: string maxLength: 200 signature: type: string chainId: type: integer exclusiveMinimum: 0 required: - reportee - message - signature - chainId responses: '204': description: Comment reported successfully '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '404': description: When comment is not found content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' /api/reports: get: tags: - reports description: Get a list of comment reports parameters: - schema: type: string description: Non inclusive cursor from which to fetch the reports based on sort pattern: ^0x[a-fA-F0-9]+$ required: false name: cursor in: query - schema: type: integer minimum: 1 maximum: 100 default: 10 description: The number of reports to return required: false name: limit in: query - schema: type: string enum: - asc - desc default: desc description: The sort order of the reports required: false name: sort in: query - schema: type: string enum: &ref_17 - pending - resolved - closed default: pending required: false name: status in: query responses: '200': description: List of comment reports content: application/json: schema: type: object properties: results: type: array items: type: object properties: id: type: string format: uuid commentId: type: string description: Hex format string, e.g. `0x1234567890abcdef` reportee: type: string description: Hex format string, e.g. `0x1234567890abcdef` message: type: string createdAt: type: - string - 'null' updatedAt: type: - string - 'null' status: type: string enum: *ref_17 required: - id - commentId - reportee - message - createdAt - updatedAt - status pagination: type: object properties: limit: type: integer hasNext: type: boolean hasPrevious: type: boolean startCursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` endCursor: type: string description: Hex format string, e.g. `0x1234567890abcdef` required: - limit - hasNext - hasPrevious required: - results - pagination '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '401': description: When user is not authenticated content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' /api/reports/{reportId}: get: tags: - reports description: Get a report by ID parameters: - schema: type: string format: uuid required: true name: reportId in: path responses: '200': description: Report details content: application/json: schema: type: object properties: id: type: string format: uuid commentId: type: string description: Hex format string, e.g. `0x1234567890abcdef` reportee: type: string description: Hex format string, e.g. `0x1234567890abcdef` message: type: string createdAt: type: - string - 'null' updatedAt: type: - string - 'null' status: type: string enum: *ref_17 required: - id - commentId - reportee - message - createdAt - updatedAt - status '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '401': description: When user is not authenticated content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '404': description: When report is not found content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' patch: tags: - reports description: Update a report's status parameters: - schema: type: string format: uuid required: true name: reportId in: path requestBody: required: true content: application/json: schema: type: object properties: status: type: string enum: *ref_17 required: - status responses: '200': description: Report updated successfully content: application/json: schema: type: object properties: id: type: string format: uuid commentId: type: string description: Hex format string, e.g. `0x1234567890abcdef` reportee: type: string description: Hex format string, e.g. `0x1234567890abcdef` message: type: string createdAt: type: - string - 'null' updatedAt: type: - string - 'null' status: type: string enum: *ref_17 required: - id - commentId - reportee - message - createdAt - updatedAt - status '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '401': description: When user is not authenticated content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '404': description: When report is not found content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' /api/auth/siwe/nonce: get: tags: - auth - siwe description: Get a nonce for a SIWE request responses: '200': description: Nonce and token generated successfully content: application/json: schema: type: object properties: nonce: type: string minLength: 1 token: type: string minLength: 1 required: - nonce - token '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' /api/auth/siwe/verify: post: tags: - auth - siwe description: Verify a SIWE request and issue auth tokens requestBody: required: true content: application/json: schema: type: object properties: message: type: string minLength: 1 signature: type: string description: Hex format string, e.g. `0x1234567890abcdef` token: type: string minLength: 1 required: - message - signature - token responses: '200': description: SIWE verification successful and auth tokens issued content: application/json: schema: type: object properties: accessToken: type: object properties: token: type: string minLength: 1 expiresAt: type: integer exclusiveMinimum: 0 required: - token - expiresAt refreshToken: type: object properties: token: type: string minLength: 1 expiresAt: type: integer exclusiveMinimum: 0 required: - token - expiresAt required: - accessToken - refreshToken '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' /api/auth/siwe/refresh: post: tags: - auth - siwe description: Refresh a SIWE access token using a refresh token parameters: - schema: type: string minLength: 1 pattern: ^Bearer\s[^\s]+$ required: true name: Authorization in: header responses: '200': description: Tokens refreshed successfully content: application/json: schema: type: object properties: accessToken: type: object properties: token: type: string expiresAt: type: number required: - token - expiresAt refreshToken: type: object properties: token: type: string expiresAt: type: number required: - token - expiresAt required: - accessToken - refreshToken '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '401': description: Not authenticated content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' /api/users/me: get: tags: - user description: Get the current user responses: '200': description: User details content: application/json: schema: type: object properties: id: type: string format: uuid createdAt: type: string description: A date string in ISO 8601 format updatedAt: type: string description: A date string in ISO 8601 format authMethods: type: array items: type: object properties: id: type: string format: uuid createdAt: type: string description: A date string in ISO 8601 format updatedAt: type: string description: A date string in ISO 8601 format identifier: type: string method: type: string enum: - siwe required: - id - createdAt - updatedAt - identifier - method role: type: string enum: - admin - user required: - id - createdAt - updatedAt - authMethods - role '401': description: Not authenticated content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' delete: tags: - user description: Delete the current user responses: '204': description: User deleted successfully '401': description: Not authenticated content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' /api/apps: post: tags: - apps - webhooks description: Create a new app requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 50 required: - name responses: '200': description: App created successfully content: application/json: schema: type: object properties: id: type: string format: uuid createdAt: type: string description: A date string in ISO 8601 format updatedAt: type: string description: A date string in ISO 8601 format name: type: string minLength: 1 secret: type: string description: Masked app secret required: - id - createdAt - updatedAt - name - secret '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' get: tags: - apps - webhooks description: Get a list of apps parameters: - schema: type: integer exclusiveMinimum: 0 default: 1 required: false name: page in: query - schema: type: integer exclusiveMinimum: 0 maximum: 100 default: 10 required: false name: limit in: query responses: '200': description: Paginated list of apps content: application/json: schema: type: object properties: results: type: array items: type: object properties: id: type: string format: uuid createdAt: type: string description: A date string in ISO 8601 format updatedAt: type: string description: A date string in ISO 8601 format name: type: string minLength: 1 required: - id - createdAt - updatedAt - name pageInfo: type: object properties: total: type: integer minimum: 0 required: - total required: - results - pageInfo '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' /api/apps/{id}: delete: tags: - apps - webhooks description: Delete an app parameters: - schema: type: string format: uuid required: true name: id in: path responses: '200': description: App deleted successfully content: application/json: schema: type: object properties: id: type: string format: uuid createdAt: type: string description: A date string in ISO 8601 format updatedAt: type: string description: A date string in ISO 8601 format name: type: string minLength: 1 required: - id - createdAt - updatedAt - name '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '404': description: App not found content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' patch: tags: - apps - webhooks description: Update an app parameters: - schema: type: string format: uuid required: true name: id in: path requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 50 required: - name responses: '200': description: App updated successfully content: application/json: schema: type: object properties: id: type: string format: uuid createdAt: type: string description: A date string in ISO 8601 format updatedAt: type: string description: A date string in ISO 8601 format name: type: string minLength: 1 required: - id - createdAt - updatedAt - name '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '404': description: App not found content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' get: tags: - apps - webhooks description: Get an app parameters: - schema: type: string format: uuid required: true name: id in: path responses: '200': description: App details content: application/json: schema: type: object properties: id: type: string format: uuid createdAt: type: string description: A date string in ISO 8601 format updatedAt: type: string description: A date string in ISO 8601 format name: type: string minLength: 1 maxLength: 50 secret: type: string description: Masked app secret required: - id - createdAt - updatedAt - name - secret '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '404': description: App not found content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' /api/apps/{id}/secret/refresh: post: tags: - apps - webhooks description: Refresh an app secret parameters: - schema: type: string format: uuid required: true name: id in: path responses: '200': description: Secret refreshed successfully content: application/json: schema: type: object properties: secret: type: string description: Masked app secret required: - secret '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '404': description: App not found content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' /api/apps/{id}/secret/reveal: post: tags: - apps - webhooks description: Reveal an app secret parameters: - schema: type: string format: uuid required: true name: id in: path responses: '200': description: Secret revealed successfully content: application/json: schema: type: object properties: secret: type: string minLength: 1 required: - secret '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '404': description: App not found content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' /api/apps/{id}/webhooks: post: tags: - apps - webhooks description: Create a new webhook for an app parameters: - schema: type: string format: uuid required: true name: id in: path requestBody: required: true content: application/json: schema: type: object properties: url: type: string format: uri events: type: array items: type: string enum: &ref_18 - approval:added - approval:removed - approval:expired - channel:created - channel:updated - channel:hook:status:updated - channel:metadata:set - channel:transferred - comment:added - comment:hook:metadata:set - comment:deleted - comment:edited - comment:moderation:status:updated - comment:reactions:updated - comment:references:updated - test minItems: 1 auth: oneOf: - type: object properties: type: type: string enum: - http-basic-auth headerName: type: string default: Authorization username: type: string password: type: string required: - type - username - password - type: object properties: type: type: string enum: - header headerName: type: string default: Authorization headerValue: type: string required: - type - headerValue - type: object properties: type: type: string enum: - no-auth required: - type name: type: string minLength: 1 maxLength: 50 required: - url - events - auth - name responses: '200': description: Webhook created successfully content: application/json: schema: type: object properties: id: type: string format: uuid createdAt: type: string description: A date string in ISO 8601 format updatedAt: type: string description: A date string in ISO 8601 format name: type: string url: type: string format: uri auth: oneOf: - type: object properties: type: type: string enum: - http-basic-auth headerName: type: string default: Authorization username: type: string password: type: string required: - type - username - password - type: object properties: type: type: string enum: - header headerName: type: string default: Authorization headerValue: type: string required: - type - headerValue - type: object properties: type: type: string enum: - no-auth required: - type eventFilter: type: array items: type: string enum: *ref_18 required: - id - createdAt - updatedAt - name - url - auth - eventFilter '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '404': description: App not found content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' get: tags: - apps - webhooks description: Get a list of webhooks for an app parameters: - schema: type: string format: uuid required: true name: id in: path - schema: type: integer exclusiveMinimum: 0 default: 1 required: false name: page in: query - schema: type: integer exclusiveMinimum: 0 maximum: 100 default: 10 required: false name: limit in: query responses: '200': description: Paginated list of webhooks content: application/json: schema: type: object properties: results: type: array items: type: object properties: id: type: string format: uuid createdAt: type: string description: A date string in ISO 8601 format updatedAt: type: string description: A date string in ISO 8601 format name: type: string url: type: string format: uri auth: oneOf: - type: object properties: type: type: string enum: - http-basic-auth headerName: type: string default: Authorization username: type: string password: type: string required: - type - username - password - type: object properties: type: type: string enum: - header headerName: type: string default: Authorization headerValue: type: string required: - type - headerValue - type: object properties: type: type: string enum: - no-auth required: - type eventFilter: type: array items: type: string enum: *ref_18 adminOnly: type: object properties: paused: type: boolean pausedAt: type: string description: A date string in ISO 8601 format required: - paused - pausedAt required: - id - createdAt - updatedAt - name - url - auth - eventFilter pageInfo: type: object properties: total: type: integer minimum: 0 required: - total required: - results - pageInfo '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '404': description: App not found content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' /api/apps/{appId}/webhooks/{webhookId}: delete: tags: - apps - webhooks description: Delete a webhook parameters: - schema: type: string format: uuid required: true name: appId in: path - schema: type: string format: uuid required: true name: webhookId in: path responses: '200': description: Webhook deleted successfully content: application/json: schema: type: object properties: id: type: string format: uuid createdAt: type: string description: A date string in ISO 8601 format updatedAt: type: string description: A date string in ISO 8601 format name: type: string url: type: string format: uri auth: oneOf: - type: object properties: type: type: string enum: - http-basic-auth headerName: type: string default: Authorization username: type: string password: type: string required: - type - username - password - type: object properties: type: type: string enum: - header headerName: type: string default: Authorization headerValue: type: string required: - type - headerValue - type: object properties: type: type: string enum: - no-auth required: - type eventFilter: type: array items: type: string enum: *ref_18 required: - id - createdAt - updatedAt - name - url - auth - eventFilter '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '404': description: Webhook not found content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' get: tags: - apps - webhooks description: Get a webhook parameters: - schema: type: string format: uuid required: true name: appId in: path - schema: type: string format: uuid required: true name: webhookId in: path responses: '200': description: Webhook details content: application/json: schema: type: object properties: id: type: string format: uuid createdAt: type: string description: A date string in ISO 8601 format updatedAt: type: string description: A date string in ISO 8601 format name: type: string url: type: string format: uri auth: oneOf: - type: object properties: type: type: string enum: - http-basic-auth headerName: type: string default: Authorization username: type: string password: type: string required: - type - username - password - type: object properties: type: type: string enum: - header headerName: type: string default: Authorization headerValue: type: string required: - type - headerValue - type: object properties: type: type: string enum: - no-auth required: - type eventFilter: type: array items: type: string enum: *ref_18 adminOnly: type: object properties: paused: type: boolean pausedAt: type: string description: A date string in ISO 8601 format required: - paused - pausedAt required: - id - createdAt - updatedAt - name - url - auth - eventFilter '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' patch: tags: - apps - webhooks description: Update a webhook parameters: - schema: type: string format: uuid required: true name: appId in: path - schema: type: string format: uuid required: true name: webhookId in: path requestBody: required: true content: application/json: schema: type: object properties: auth: oneOf: - type: object properties: type: type: string enum: - http-basic-auth headerName: type: string default: Authorization username: type: string password: type: string required: - type - username - password - type: object properties: type: type: string enum: - header headerName: type: string default: Authorization headerValue: type: string required: - type - headerValue - type: object properties: type: type: string enum: - no-auth required: - type eventFilter: type: array items: type: string enum: *ref_18 minItems: 1 name: type: string minLength: 1 maxLength: 50 url: type: string format: uri responses: '200': description: Webhook updated successfully content: application/json: schema: type: object properties: id: type: string format: uuid createdAt: type: string description: A date string in ISO 8601 format updatedAt: type: string description: A date string in ISO 8601 format name: type: string url: type: string format: uri auth: oneOf: - type: object properties: type: type: string enum: - http-basic-auth headerName: type: string default: Authorization username: type: string password: type: string required: - type - username - password - type: object properties: type: type: string enum: - header headerName: type: string default: Authorization headerValue: type: string required: - type - headerValue - type: object properties: type: type: string enum: - no-auth required: - type eventFilter: type: array items: type: string enum: *ref_18 required: - id - createdAt - updatedAt - name - url - auth - eventFilter '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' /api/apps/{appId}/webhooks/{webhookId}/test: post: tags: - apps - webhooks description: Test a webhook parameters: - schema: type: string format: uuid required: true name: appId in: path - schema: type: string format: uuid required: true name: webhookId in: path responses: '204': description: Webhook test event queued successfully '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '404': description: Webhook or app not found content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' /api/apps/{appId}/webhooks/{webhookId}/deliveries/attempts: get: tags: - apps - webhooks - deliveries description: Get a list of delivery attempts for a webhook parameters: - schema: type: string format: uuid required: true name: appId in: path - schema: type: string format: uuid required: true name: webhookId in: path - schema: type: object properties: id: type: string pattern: ^d+$ required: - id required: false name: before in: query - schema: type: object properties: id: type: string pattern: ^d+$ required: - id required: false name: after in: query - schema: type: integer exclusiveMinimum: 0 maximum: 100 default: 10 required: false name: limit in: query - schema: type: string pattern: ^\d+$ description: A bigint ID of the webhook delivery as string required: false name: webhookDeliveryId in: query responses: '200': description: Paginated list of delivery attempts content: application/json: schema: type: object properties: results: type: array items: type: object properties: cursor: type: object properties: id: type: string description: A bigint string required: - id item: type: object properties: id: type: string description: A bigint string attemptedAt: type: string description: A date string in ISO 8601 format attemptNumber: type: number responseStatus: type: number responseMs: type: number error: type: - string - 'null' delivery: type: object properties: event: type: object properties: eventType: type: string required: - eventType required: - event required: - id - attemptedAt - attemptNumber - responseStatus - responseMs - error - delivery required: - cursor - item pageInfo: type: object properties: hasPreviousPage: type: boolean hasNextPage: type: boolean startCursor: type: object properties: id: type: string description: A bigint string required: - id endCursor: type: object properties: id: type: string description: A bigint string required: - id required: - hasPreviousPage - hasNextPage required: - results - pageInfo '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '404': description: Webhook or app not found content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' /api/apps/{appId}/webhooks/{webhookId}/deliveries/{deliveryId}: get: tags: - apps - webhooks - deliveries description: Get a delivery by ID parameters: - schema: type: string format: uuid required: true name: appId in: path - schema: type: string format: uuid required: true name: webhookId in: path - schema: type: string pattern: ^d+$ required: true name: deliveryId in: path responses: '200': description: Delivery details content: application/json: schema: type: object properties: id: type: string description: A bigint string createdAt: type: string description: A date string in ISO 8601 format nextAttemptAt: type: string description: A date string in ISO 8601 format status: type: string enum: &ref_20 - pending - processing - failed - success attemptsCount: type: integer minimum: 0 lastError: type: - string - 'null' retryNumber: type: integer minimum: 0 event: type: object properties: eventType: type: string eventUid: type: string payload: anyOf: - oneOf: - type: object properties: event: type: string enum: - approval:added data: type: object properties: approval: type: object properties: id: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time author: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` app: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - id - createdAt - updatedAt - author - app required: - approval chainId: type: integer blockNumber: type: string logIndex: type: integer txHash: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` uid: type: string version: type: number enum: - 1 required: - event - data - chainId - blockNumber - logIndex - txHash - uid - version - type: object properties: event: type: string enum: - approval:added data: type: object properties: approval: type: object properties: id: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time author: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` app: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` expiresAt: type: string format: date-time required: - id - createdAt - updatedAt - author - app - expiresAt required: - approval chainId: type: integer blockNumber: type: string logIndex: type: integer txHash: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` uid: type: string version: type: number enum: - 2 required: - event - data - chainId - blockNumber - logIndex - txHash - uid - version - type: object properties: event: type: string enum: - approval:removed data: type: object properties: approval: type: object properties: id: type: string required: - id required: - approval chainId: type: integer blockNumber: type: string logIndex: type: integer txHash: type: string description: Hex format string, e.g. `0x1234567890abcdef` uid: type: string version: type: number enum: - 1 required: - event - data - chainId - blockNumber - logIndex - txHash - uid - version - type: object properties: event: type: string enum: - approval:expired chainId: type: integer data: type: object properties: approval: type: object properties: id: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time author: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` app: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` expiresAt: type: string format: date-time required: - id - createdAt - updatedAt - author - app - expiresAt required: - approval uid: type: string version: type: number enum: - 1 required: - event - chainId - data - uid - version - type: object properties: event: type: string enum: - channel:created uid: type: string version: type: number enum: - 1 data: type: object properties: channel: type: object properties: id: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time owner: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` name: type: string description: type: string hook: type: - string - 'null' description: >- Hex format string, e.g. `0x1234567890abcdef` metadata: type: array items: type: object properties: key: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` value: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - key - value chainId: type: integer required: - id - createdAt - updatedAt - owner - name - description - hook - metadata - chainId required: - channel chainId: type: integer blockNumber: type: string logIndex: type: integer txHash: type: string description: Hex format string, e.g. `0x1234567890abcdef` required: - event - uid - version - data - chainId - blockNumber - logIndex - txHash - type: object properties: event: type: string enum: - channel:updated uid: type: string version: type: number enum: - 1 data: type: object properties: channel: type: object properties: id: type: string updatedAt: type: string format: date-time name: type: string description: type: string metadata: type: array items: type: object properties: key: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` value: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - key - value required: - id - updatedAt - name - description - metadata required: - channel chainId: type: integer blockNumber: type: string logIndex: type: integer txHash: type: string description: Hex format string, e.g. `0x1234567890abcdef` required: - event - uid - version - data - chainId - blockNumber - logIndex - txHash - type: object properties: event: type: string enum: - channel:hook:status:updated uid: type: string version: type: number enum: - 1 data: type: object properties: channel: type: object properties: id: type: string hook: type: - string - 'null' description: >- Hex format string, e.g. `0x1234567890abcdef` updatedAt: type: string format: date-time required: - id - hook - updatedAt hook: type: object properties: address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` enabled: type: boolean required: - address - enabled required: - channel - hook chainId: type: integer blockNumber: type: string logIndex: type: integer txHash: type: string description: Hex format string, e.g. `0x1234567890abcdef` required: - event - uid - version - data - chainId - blockNumber - logIndex - txHash - type: object properties: event: type: string enum: - channel:metadata:set uid: type: string version: type: number enum: - 1 data: type: object properties: channel: type: object properties: id: type: string metadata: type: array items: type: object properties: key: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` value: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - key - value updatedAt: type: string format: date-time required: - id - metadata - updatedAt metadataOperation: oneOf: - type: object properties: type: type: string enum: - delete key: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - type - key - type: object properties: type: type: string enum: - create key: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` value: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - type - key - value - type: object properties: type: type: string enum: - update key: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` value: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - type - key - value required: - channel - metadataOperation chainId: type: integer blockNumber: type: string logIndex: type: integer txHash: type: string description: Hex format string, e.g. `0x1234567890abcdef` required: - event - uid - version - data - chainId - blockNumber - logIndex - txHash - type: object properties: event: type: string enum: - channel:transferred uid: type: string version: type: number enum: - 1 data: type: object properties: channel: type: object properties: id: type: string owner: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` updatedAt: type: string format: date-time required: - id - owner - updatedAt from: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` to: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - channel - from - to chainId: type: integer blockNumber: type: string logIndex: type: integer txHash: type: string description: Hex format string, e.g. `0x1234567890abcdef` required: - event - uid - version - data - chainId - blockNumber - logIndex - txHash - type: object properties: event: type: string enum: - comment:added uid: type: string version: type: number enum: - 1 data: type: object properties: comment: oneOf: - type: object properties: id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` createdAt: type: string format: date-time updatedAt: type: string format: date-time channelId: type: string author: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` app: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` content: type: string commentType: type: integer metadata: type: array items: type: object properties: key: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` value: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - key - value moderationStatus: type: string enum: &ref_19 - pending - approved - rejected references: type: array items: anyOf: - type: object properties: type: type: string enum: - ens avatarUrl: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - avatarUrl - name - address - position - url - type: object properties: type: type: string enum: - erc20 symbol: type: string logoURI: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` decimals: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end chainId: type: - integer - 'null' exclusiveMinimum: 0 chains: type: array items: type: object properties: caip: type: string chainId: type: integer exclusiveMinimum: 0 required: - caip - chainId required: - type - symbol - logoURI - name - address - decimals - position - chainId - chains - type: object properties: type: type: string enum: - farcaster address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` fid: type: integer fname: type: string username: type: string displayName: type: - string - 'null' pfpUrl: type: - string - 'null' position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - address - fid - fname - username - displayName - pfpUrl - position - url - type: object properties: type: type: string enum: - webpage url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end title: type: string description: type: - string - 'null' favicon: type: - string - 'null' format: uri opengraph: type: - object - 'null' properties: title: type: string description: type: - string - 'null' image: type: string format: uri url: type: string format: uri required: - title - description - image - url mediaType: type: string required: - type - url - position - title - description - favicon - opengraph - mediaType - type: object properties: type: type: string enum: - file url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string required: - type - url - position - mediaType - type: object properties: type: type: string enum: - image url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height required: - type - url - position - mediaType - type: object properties: type: type: string enum: - video url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string videoTracks: type: array items: type: object properties: dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height codec: type: string required: - dimension required: - type - url - position - mediaType - type: object properties: type: type: string enum: - quoted_comment id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` chainId: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end required: - type - id - chainId - position - {} - type: 'null' type: type: string enum: - root targetUri: type: string required: - id - createdAt - updatedAt - channelId - author - app - content - commentType - metadata - moderationStatus - references - type - targetUri - type: object properties: id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` createdAt: type: string format: date-time updatedAt: type: string format: date-time channelId: type: string author: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` app: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` content: type: string commentType: type: integer metadata: type: array items: type: object properties: key: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` value: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - key - value moderationStatus: type: string enum: *ref_19 references: type: array items: anyOf: - type: object properties: type: type: string enum: - ens avatarUrl: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - avatarUrl - name - address - position - url - type: object properties: type: type: string enum: - erc20 symbol: type: string logoURI: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` decimals: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end chainId: type: - integer - 'null' exclusiveMinimum: 0 chains: type: array items: type: object properties: caip: type: string chainId: type: integer exclusiveMinimum: 0 required: - caip - chainId required: - type - symbol - logoURI - name - address - decimals - position - chainId - chains - type: object properties: type: type: string enum: - farcaster address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` fid: type: integer fname: type: string username: type: string displayName: type: - string - 'null' pfpUrl: type: - string - 'null' position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - address - fid - fname - username - displayName - pfpUrl - position - url - type: object properties: type: type: string enum: - webpage url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end title: type: string description: type: - string - 'null' favicon: type: - string - 'null' format: uri opengraph: type: - object - 'null' properties: title: type: string description: type: - string - 'null' image: type: string format: uri url: type: string format: uri required: - title - description - image - url mediaType: type: string required: - type - url - position - title - description - favicon - opengraph - mediaType - type: object properties: type: type: string enum: - file url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string required: - type - url - position - mediaType - type: object properties: type: type: string enum: - image url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height required: - type - url - position - mediaType - type: object properties: type: type: string enum: - video url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string videoTracks: type: array items: type: object properties: dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height codec: type: string required: - dimension required: - type - url - position - mediaType - type: object properties: type: type: string enum: - quoted_comment id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` chainId: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end required: - type - id - chainId - position - {} - type: 'null' type: type: string enum: - reply parentId: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - id - createdAt - updatedAt - channelId - author - app - content - commentType - metadata - moderationStatus - references - type - parentId zeroExSwap: type: - object - 'null' properties: from: type: object properties: address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` amount: type: string pattern: ^\d+(\.\d+)?$ symbol: type: string required: - address - amount - symbol to: type: object properties: address: anyOf: - type: string description: >- Hex format string, e.g. `0x1234567890abcdef` - type: string enum: - '' description: >- Hex format string, e.g. `0x1234567890abcdef` amount: anyOf: - type: string pattern: ^\d+(\.\d+)?$ - type: string enum: - '' symbol: type: string required: - address - amount - symbol required: - from - to required: - comment - zeroExSwap chainId: type: integer blockNumber: type: string logIndex: type: integer txHash: type: string description: Hex format string, e.g. `0x1234567890abcdef` required: - event - uid - version - data - chainId - blockNumber - logIndex - txHash - type: object properties: event: type: string enum: - comment:hook:metadata:set uid: type: string version: type: number enum: - 1 data: type: object properties: comment: type: object properties: id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` updatedAt: type: string format: date-time hookMetadata: type: array items: type: object properties: key: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` value: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - key - value required: - id - updatedAt - hookMetadata hookMetadataOperation: oneOf: - type: object properties: type: type: string enum: - delete key: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - type - key - type: object properties: type: type: string enum: - create key: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` value: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - type - key - value - type: object properties: type: type: string enum: - update key: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` value: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - type - key - value required: - comment - hookMetadataOperation chainId: type: integer blockNumber: type: string logIndex: type: integer txHash: type: string description: Hex format string, e.g. `0x1234567890abcdef` required: - event - uid - version - data - chainId - blockNumber - logIndex - txHash - type: object properties: event: type: string enum: - comment:deleted uid: type: string version: type: number enum: - 1 data: type: object properties: comment: type: object properties: id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` deletedAt: type: string format: date-time updatedAt: type: string format: date-time required: - id - deletedAt - updatedAt required: - comment chainId: type: integer blockNumber: type: string logIndex: type: integer txHash: type: string description: Hex format string, e.g. `0x1234567890abcdef` required: - event - uid - version - data - chainId - blockNumber - logIndex - txHash - type: object properties: event: type: string enum: - comment:edited uid: type: string version: type: number enum: - 1 data: type: object properties: comment: type: object properties: id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` updatedAt: type: string format: date-time content: type: string references: type: array items: anyOf: - type: object properties: type: type: string enum: - ens avatarUrl: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - avatarUrl - name - address - position - url - type: object properties: type: type: string enum: - erc20 symbol: type: string logoURI: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` decimals: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end chainId: type: - integer - 'null' exclusiveMinimum: 0 chains: type: array items: type: object properties: caip: type: string chainId: type: integer exclusiveMinimum: 0 required: - caip - chainId required: - type - symbol - logoURI - name - address - decimals - position - chainId - chains - type: object properties: type: type: string enum: - farcaster address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` fid: type: integer fname: type: string username: type: string displayName: type: - string - 'null' pfpUrl: type: - string - 'null' position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - address - fid - fname - username - displayName - pfpUrl - position - url - type: object properties: type: type: string enum: - webpage url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end title: type: string description: type: - string - 'null' favicon: type: - string - 'null' format: uri opengraph: type: - object - 'null' properties: title: type: string description: type: - string - 'null' image: type: string format: uri url: type: string format: uri required: - title - description - image - url mediaType: type: string required: - type - url - position - title - description - favicon - opengraph - mediaType - type: object properties: type: type: string enum: - file url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string required: - type - url - position - mediaType - type: object properties: type: type: string enum: - image url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height required: - type - url - position - mediaType - type: object properties: type: type: string enum: - video url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string videoTracks: type: array items: type: object properties: dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height codec: type: string required: - dimension required: - type - url - position - mediaType - type: object properties: type: type: string enum: - quoted_comment id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` chainId: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end required: - type - id - chainId - position - {} - type: 'null' moderationStatus: type: string enum: *ref_19 required: - id - updatedAt - content - references - moderationStatus required: - comment chainId: type: integer blockNumber: type: string logIndex: type: integer txHash: type: string description: Hex format string, e.g. `0x1234567890abcdef` required: - event - uid - version - data - chainId - blockNumber - logIndex - txHash - type: object properties: event: type: string enum: - comment:moderation:status:updated uid: type: string version: type: number enum: - 1 data: type: object properties: comment: type: object properties: id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` moderationStatus: type: string enum: *ref_19 moderationStatusChangedAt: type: string format: date-time required: - id - moderationStatus - moderationStatusChangedAt required: - comment required: - event - uid - version - data - type: object properties: event: type: string enum: - comment:reactions:updated uid: type: string version: type: number enum: - 1 data: type: object properties: comment: type: object properties: id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` reactionCounts: type: object additionalProperties: type: number required: - id - reactionCounts required: - comment required: - event - uid - version - data - type: object properties: event: type: string enum: - comment:references:updated uid: type: string version: type: number enum: - 1 data: type: object properties: comment: type: object properties: id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` references: type: array items: anyOf: - type: object properties: type: type: string enum: - ens avatarUrl: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - avatarUrl - name - address - position - url - type: object properties: type: type: string enum: - erc20 symbol: type: string logoURI: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` decimals: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end chainId: type: - integer - 'null' exclusiveMinimum: 0 chains: type: array items: type: object properties: caip: type: string chainId: type: integer exclusiveMinimum: 0 required: - caip - chainId required: - type - symbol - logoURI - name - address - decimals - position - chainId - chains - type: object properties: type: type: string enum: - farcaster address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` fid: type: integer fname: type: string username: type: string displayName: type: - string - 'null' pfpUrl: type: - string - 'null' position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - address - fid - fname - username - displayName - pfpUrl - position - url - type: object properties: type: type: string enum: - webpage url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end title: type: string description: type: - string - 'null' favicon: type: - string - 'null' format: uri opengraph: type: - object - 'null' properties: title: type: string description: type: - string - 'null' image: type: string format: uri url: type: string format: uri required: - title - description - image - url mediaType: type: string required: - type - url - position - title - description - favicon - opengraph - mediaType - type: object properties: type: type: string enum: - file url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string required: - type - url - position - mediaType - type: object properties: type: type: string enum: - image url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height required: - type - url - position - mediaType - type: object properties: type: type: string enum: - video url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string videoTracks: type: array items: type: object properties: dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height codec: type: string required: - dimension required: - type - url - position - mediaType - type: object properties: type: type: string enum: - quoted_comment id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` chainId: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end required: - type - id - chainId - position - {} - type: 'null' referencesResolutionStatus: type: string enum: - pending - success - failed - partial referencesResolutionStatusChangedAt: type: string format: date-time required: - id - references - referencesResolutionStatus - referencesResolutionStatusChangedAt required: - comment required: - event - uid - version - data - type: object properties: event: type: string enum: - test uid: type: string version: type: number enum: - 1 appId: type: string format: uuid webhookId: type: string format: uuid data: type: object properties: message: type: string required: - message required: - event - uid - version - appId - webhookId - data required: - eventType - eventUid - payload required: - id - createdAt - nextAttemptAt - status - attemptsCount - lastError - retryNumber - event '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' /api/apps/{appId}/webhooks/{webhookId}/deliveries/{deliveryId}/retry: post: tags: - apps - webhooks - deliveries description: Retry a delivery parameters: - schema: type: string format: uuid required: true name: appId in: path - schema: type: string format: uuid required: true name: webhookId in: path - schema: type: string pattern: ^d+$ required: true name: deliveryId in: path responses: '200': description: New delivery to be retried has been queued content: application/json: schema: type: object properties: id: type: string description: A bigint string createdAt: type: string description: A date string in ISO 8601 format nextAttemptAt: type: string description: A date string in ISO 8601 format status: type: string enum: - pending - processing - success - failed attemptsCount: type: integer minimum: 0 lastError: type: - string - 'null' retryNumber: type: integer minimum: 0 required: - id - createdAt - nextAttemptAt - status - attemptsCount - lastError - retryNumber '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' /api/apps/{appId}/webhooks/{webhookId}/deliveries: get: tags: - apps - webhooks - deliveries description: Get a list of deliveries for a webhook parameters: - schema: type: string format: uuid required: true name: appId in: path - schema: type: string format: uuid required: true name: webhookId in: path - schema: type: object properties: id: type: string pattern: ^d+$ required: - id required: false name: before in: query - schema: type: object properties: id: type: string pattern: ^d+$ required: - id required: false name: after in: query - schema: type: integer exclusiveMinimum: 0 maximum: 100 default: 10 required: false name: limit in: query - schema: anyOf: - type: string enum: *ref_20 - type: array items: type: string enum: *ref_20 - type: string default: [] description: >- Filter by status. It can be a single status or a comma separated list of statuses. oneOf: - type: string enum: - pending - processing - failed - success - type: array items: type: string enum: - pending - processing - failed - success - type: string format: comma-separated-list description: E.g. "pending,processing,failed,success" required: false name: status in: query responses: '200': description: Paginated list of deliveries content: application/json: schema: type: object properties: results: type: array items: type: object properties: cursor: type: object properties: id: type: string description: A bigint string required: - id item: type: object properties: id: type: string description: A bigint string createdAt: type: string description: A date string in ISO 8601 format nextAttemptAt: type: string description: A date string in ISO 8601 format attemptsCount: type: integer minimum: 0 status: type: string enum: *ref_20 event: type: object properties: eventType: type: string required: - eventType required: - id - createdAt - nextAttemptAt - attemptsCount - status - event required: - cursor - item pageInfo: type: object properties: hasPreviousPage: type: boolean hasNextPage: type: boolean startCursor: type: object properties: id: type: string description: A bigint string required: - id endCursor: type: object properties: id: type: string description: A bigint string required: - id required: - hasPreviousPage - hasNextPage required: - results - pageInfo '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '404': description: Webhook or app not found content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' /api/analytics/kpi/deliveries: get: tags: - analytics - kpi - deliveries description: Get the deliveries live status parameters: - schema: type: string required: false name: from in: query - schema: type: - string - 'null' required: false name: to in: query - schema: type: string format: uuid required: false name: appId in: query - schema: type: string format: uuid required: false name: webhookId in: query responses: '200': description: The deliveries live status content: application/json: schema: type: object properties: deliveries: type: string description: A bigint string required: - deliveries '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' /api/analytics/kpi/eventual-success: get: tags: - analytics - kpi - eventual-success description: Get the eventual success live status parameters: - schema: type: string required: false name: from in: query - schema: type: - string - 'null' required: false name: to in: query - schema: type: string format: uuid required: false name: appId in: query - schema: type: string format: uuid required: false name: webhookId in: query responses: '200': description: The eventual success live status content: application/json: schema: type: object properties: eventualSuccessRate: type: number previousEventualSuccessRate: type: number delta: type: number required: - eventualSuccessRate - previousEventualSuccessRate - delta '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' /api/analytics/kpi/first-attempt-success: get: tags: - analytics - kpi - first-attempt-success description: Get the first attempt success live status parameters: - schema: type: string required: false name: from in: query - schema: type: - string - 'null' required: false name: to in: query - schema: type: string format: uuid required: false name: appId in: query - schema: type: string format: uuid required: false name: webhookId in: query responses: '200': description: The first attempt success live status content: application/json: schema: type: object properties: firstSuccessRate: type: number previousFirstSuccessRate: type: number delta: type: number required: - firstSuccessRate - previousFirstSuccessRate - delta '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' /api/analytics/kpi/e2e-latency: get: tags: - analytics - kpi - e2e-latency description: >- Get the p95 end to end latency of first attempt and first success since event creation in ms parameters: - schema: type: string required: false name: from in: query - schema: type: - string - 'null' required: false name: to in: query - schema: type: string format: uuid required: false name: appId in: query - schema: type: string format: uuid required: false name: webhookId in: query responses: '200': description: >- The p95 end to end latency of first attempt and first success since event creation in ms content: application/json: schema: type: object properties: p95: type: object properties: firstAttempt: type: number firstSuccess: type: number required: - firstAttempt - firstSuccess required: - p95 '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' /api/analytics/kpi/backlog: get: tags: - analytics - kpi - backlog description: Get the backlog live status parameters: - schema: type: string format: uuid required: false name: appId in: query - schema: type: string format: uuid required: false name: webhookId in: query responses: '200': description: The backlog live status content: application/json: schema: type: object properties: inProgress: type: number pending: type: number processing: type: number nextDueAt: type: string description: A date string in ISO 8601 format oldestAgeSec: type: - integer - 'null' minimum: 0 required: - inProgress - pending - processing - nextDueAt - oldestAgeSec '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' /api/analytics/kpi/delivered-under-minute: get: tags: - analytics - kpi - delivered-under-minute description: Get the delivered under minute live status parameters: - schema: type: string required: false name: from in: query - schema: type: - string - 'null' required: false name: to in: query - schema: type: string format: uuid required: false name: appId in: query - schema: type: string format: uuid required: false name: webhookId in: query responses: '200': description: The delivered under minute live status content: application/json: schema: type: object properties: rate: type: number required: - rate '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' /api/analytics/volume: get: tags: - analytics - volume description: Get the analytics volume of delivery attempts parameters: - schema: type: string required: false name: from in: query - schema: type: - string - 'null' required: false name: to in: query - schema: type: string enum: &ref_21 - hour - day - week - month default: day required: false name: bucket in: query - schema: type: string format: uuid required: false name: appId in: query - schema: type: string format: uuid required: false name: webhookId in: query responses: '200': description: The analytics volume of delivery attempts content: application/json: schema: type: object properties: results: type: array items: type: object properties: time: type: string description: A date string in ISO 8601 format attempts: type: string description: A bigint string successes: type: string description: A bigint string failures: type: string description: A bigint string http4xx: type: string description: A bigint string http5xx: type: string description: A bigint string transport: type: string description: A bigint string required: - time - attempts - successes - failures - http4xx - http5xx - transport info: type: object properties: bucket: type: string enum: - hour - day - week - month from: type: string description: A date string in ISO 8601 format to: type: string description: A date string in ISO 8601 format required: - bucket - from - to required: - results - info '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' /api/analytics/terminal: get: tags: - analytics - terminal description: Get the analytics terminal outcomes of deliveries parameters: - schema: type: string required: false name: from in: query - schema: type: - string - 'null' required: false name: to in: query - schema: type: string enum: *ref_21 default: day required: false name: bucket in: query - schema: type: string format: uuid required: false name: appId in: query - schema: type: string format: uuid required: false name: webhookId in: query responses: '200': description: The analytics terminal outcomes of deliveries content: application/json: schema: type: object properties: results: type: array items: type: object properties: time: type: string description: A date string in ISO 8601 format deliveries: type: string description: A bigint string successes: type: string description: A bigint string failures: type: string description: A bigint string required: - time - deliveries - successes - failures info: type: object properties: bucket: type: string enum: - hour - day - week - month from: type: string description: A date string in ISO 8601 format to: type: string description: A date string in ISO 8601 format required: - bucket - from - to required: - results - info '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' /api/analytics/success-rates: get: tags: - analytics - success-rates description: Get the analytics success rates of deliveries parameters: - schema: type: string required: false name: from in: query - schema: type: - string - 'null' required: false name: to in: query - schema: type: string enum: *ref_21 default: day required: false name: bucket in: query - schema: type: string format: uuid required: false name: appId in: query - schema: type: string format: uuid required: false name: webhookId in: query responses: '200': description: The analytics success rates of deliveries content: application/json: schema: type: object properties: results: type: array items: type: object properties: time: type: string description: A date string in ISO 8601 format eventualSuccessRate: type: number firstSuccessRate: type: number required: - time - eventualSuccessRate - firstSuccessRate info: type: object properties: bucket: type: string enum: - hour - day - week - month from: type: string description: A date string in ISO 8601 format to: type: string description: A date string in ISO 8601 format required: - bucket - from - to required: - results - info '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' /api/analytics/e2e-latency: get: tags: - analytics - e2e-latency description: >- Get the analytics end to end latency from event creation to first successful delivery attempt in ms parameters: - schema: type: string required: false name: from in: query - schema: type: - string - 'null' required: false name: to in: query - schema: type: string enum: *ref_21 default: day required: false name: bucket in: query - schema: type: string format: uuid required: false name: appId in: query - schema: type: string format: uuid required: false name: webhookId in: query responses: '200': description: >- The analytics end to end latency from event creation to first successful delivery attempt in ms content: application/json: schema: type: object properties: results: type: array items: type: object properties: time: type: string description: A date string in ISO 8601 format latencies: type: object properties: p50: type: number p90: type: number p95: type: number p99: type: number required: - p50 - p90 - p95 - p99 required: - time - latencies info: type: object properties: bucket: type: string enum: - hour - day - week - month from: type: string description: A date string in ISO 8601 format to: type: string description: A date string in ISO 8601 format required: - bucket - from - to required: - results - info '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' /api/analytics/sla-bands: get: tags: - analytics - sla-bands description: Get the analytics sla bands of delivery attempts parameters: - schema: type: string required: false name: from in: query - schema: type: - string - 'null' required: false name: to in: query - schema: type: string enum: *ref_21 default: day required: false name: bucket in: query - schema: type: string format: uuid required: false name: appId in: query - schema: type: string format: uuid required: false name: webhookId in: query responses: '200': description: The analytics sla bands of delivery attempts content: application/json: schema: type: object properties: results: type: array items: type: object properties: time: type: string description: A date string in ISO 8601 format bands: type: object properties: 5s: type: number 10s: type: number 30s: type: number 60s: type: number 300s: type: number '>300s': type: number required: - 5s - 10s - 30s - 60s - 300s - '>300s' required: - time - bands info: type: object properties: bucket: type: string enum: - hour - day - week - month from: type: string description: A date string in ISO 8601 format to: type: string description: A date string in ISO 8601 format required: - bucket - from - to required: - results - info '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' /api/analytics/errors: get: tags: - analytics - errors description: Get the analytics errors breakdown parameters: - schema: type: string required: false name: from in: query - schema: type: - string - 'null' required: false name: to in: query - schema: type: string enum: *ref_21 default: day required: false name: bucket in: query - schema: type: string format: uuid required: false name: appId in: query - schema: type: string format: uuid required: false name: webhookId in: query responses: '200': description: The analytics errors breakdown content: application/json: schema: type: object properties: results: type: array items: type: object properties: time: type: string description: A date string in ISO 8601 format http4xx: type: string description: A bigint string http5xx: type: string description: A bigint string timeout: type: string description: A bigint string other: type: string description: A bigint string required: - time - http4xx - http5xx - timeout - other info: type: object properties: bucket: type: string enum: - hour - day - week - month from: type: string description: A date string in ISO 8601 format to: type: string description: A date string in ISO 8601 format required: - bucket - from - to required: - results - info '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' /api/notifications/seen: post: description: Mark notifications as seen requestBody: content: application/json: schema: type: object properties: type: anyOf: - type: string enum: &ref_22 - reply - mention - reaction - quote - type: array items: type: string enum: *ref_22 default: [] description: >- The type of notification to mark as seen, if omitted or empty all notifications will be marked as seen lastSeenNotificationDate: type: - string - 'null' description: >- The date of the last seen notification, only unseen notifications created after this date will be marked as seen. If omitted all notifications will be marked as seen user: anyOf: - type: string description: The Ethereum address of the user pattern: ^0x[a-fA-F0-9]{40}$ - description: The ENS name of the user pattern: ^[a-zA-Z0-9.-]+\.eth$ description: The ENS name or address of the user app: anyOf: - type: string description: Hex format string, e.g. `0x1234567890abcdef` pattern: ^0x[a-fA-F0-9]+$ - type: array items: type: string description: Hex format string, e.g. `0x1234567890abcdef` pattern: ^0x[a-fA-F0-9]+$ description: >- The app signers to mark notifications as seen for, if omitted all notifications will be marked as seen required: - user responses: '200': description: Successfully marked notifications as seen content: application/json: schema: type: object properties: count: type: integer minimum: 0 description: The number of notifications marked as seen required: - count '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' /api/notifications: get: description: Get notifications parameters: - schema: type: array items: type: string description: Hex format string, e.g. `0x1234567890abcdef` pattern: ^0x[a-fA-F0-9]+$ maxItems: 20 default: &ref_23 [] description: Return only notifications created by this app signers oneOf: &ref_24 - type: array items: type: string description: an array of app signer public keys in hex format - type: string description: Comma separated list of app signer public keys in hex format - type: string description: An app signer public key in hex format required: false name: app in: query - schema: type: object properties: id: type: string pattern: ^d+$ required: - id description: Fetch newer notifications than the cursor required: false name: before in: query - schema: type: object properties: id: type: string pattern: ^d+$ required: - id description: Fetch older notifications than the cursor required: false name: after in: query - schema: type: integer minimum: 1 maximum: 100 default: 10 description: The number of notifications to return required: false name: limit in: query - schema: type: string description: Return only notifications for this parent id pattern: ^0x[a-fA-F0-9]+$ required: false description: Hex format string, e.g. `0x1234567890abcdef` name: parentId in: query - schema: type: array items: type: string enum: *ref_22 default: &ref_25 [] description: Return only notifications of this type oneOf: &ref_26 - type: array items: type: string enum: *ref_22 - type: string enum: *ref_22 - type: string description: Comma separated list of notification types example: reply,mention,reaction,quote required: false name: type in: query - schema: anyOf: - type: string description: The Ethereum address of the user pattern: ^0x[a-fA-F0-9]{40}$ - description: The ENS name of the user pattern: ^[a-zA-Z0-9.-]+\.eth$ description: The ENS name or address of the user required: true name: user in: query - schema: type: string enum: &ref_27 - 'true' - 'false' - '1' - '0' description: >- Whether to include only seen or unseen notifications, if omitted or empty all notifications will be included required: false name: seen in: query responses: '200': description: The notifications content: application/json: schema: type: object properties: notifications: type: array items: type: object properties: cursor: type: object properties: id: type: string description: A bigint string required: - id notification: oneOf: - type: object properties: type: type: string enum: - reply replyingTo: type: object properties: app: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` author: type: object properties: address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` ens: type: object properties: name: type: string avatarUrl: type: - string - 'null' required: - name - avatarUrl farcaster: type: object properties: fid: type: integer pfpUrl: type: string displayName: type: string username: type: string required: - fid - username required: - address id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` channelId: type: string pattern: ^d+$ commentType: type: integer minimum: 0 maximum: 255 content: type: string chainId: type: integer deletedAt: type: - string - 'null' logIndex: type: - integer - 'null' metadata: type: array items: type: object properties: key: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` value: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - key - value hookMetadata: type: array items: type: object properties: key: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` value: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - key - value parentId: type: - string - 'null' description: >- Hex format string, e.g. `0x1234567890abcdef` targetUri: type: string txHash: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` cursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` moderationStatus: type: string enum: *ref_3 moderationStatusChangedAt: type: - string - 'null' moderationClassifierResult: type: object additionalProperties: type: number minimum: 0 maximum: 1 moderationClassifierScore: type: number minimum: 0 maximum: 1 createdAt: type: - string - 'null' updatedAt: type: - string - 'null' revision: type: integer zeroExSwap: type: - object - 'null' properties: from: type: object properties: address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` amount: type: string pattern: ^\d+(\.\d+)?$ symbol: type: string required: - address - amount - symbol to: type: object properties: address: anyOf: - type: string description: >- Hex format string, e.g. `0x1234567890abcdef` - type: string enum: - '' description: >- Hex format string, e.g. `0x1234567890abcdef` amount: anyOf: - type: string pattern: ^\d+(\.\d+)?$ - type: string enum: - '' symbol: type: string required: - address - amount - symbol required: - from - to references: type: array items: anyOf: - type: object properties: type: type: string enum: - ens avatarUrl: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - avatarUrl - name - address - position - url - type: object properties: type: type: string enum: - erc20 symbol: type: string logoURI: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` decimals: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end chainId: type: - integer - 'null' exclusiveMinimum: 0 chains: type: array items: type: object properties: caip: type: string chainId: type: integer exclusiveMinimum: 0 required: - caip - chainId required: - type - symbol - logoURI - name - address - decimals - position - chainId - chains - type: object properties: type: type: string enum: - farcaster address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` fid: type: integer fname: type: string username: type: string displayName: type: - string - 'null' pfpUrl: type: - string - 'null' position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - address - fid - fname - username - displayName - pfpUrl - position - url - type: object properties: type: type: string enum: - webpage url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end title: type: string description: type: - string - 'null' favicon: type: - string - 'null' format: uri opengraph: type: - object - 'null' properties: title: type: string description: type: - string - 'null' image: type: string format: uri url: type: string format: uri required: - title - description - image - url mediaType: type: string required: - type - url - position - title - description - favicon - opengraph - mediaType - type: object properties: type: type: string enum: - file url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string required: - type - url - position - mediaType - type: object properties: type: type: string enum: - image url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height required: - type - url - position - mediaType - type: object properties: type: type: string enum: - video url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string videoTracks: type: array items: type: object properties: dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height codec: type: string required: - dimension required: - type - url - position - mediaType - type: object properties: type: type: string enum: - quoted_comment id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` chainId: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end required: - type - id - chainId - position - {} - type: 'null' path: type: string viewerReactions: type: object additionalProperties: type: array items: type: object properties: *ref_11 required: *ref_12 reactionCounts: type: object additionalProperties: type: number replies: type: object properties: extra: type: object properties: moderationEnabled: type: boolean moderationKnownReactions: type: array items: type: string required: - moderationEnabled - moderationKnownReactions pagination: type: object properties: limit: type: integer hasNext: type: boolean hasPrevious: type: boolean startCursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` endCursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` count: type: integer minimum: 0 required: - limit - hasNext - hasPrevious - count results: type: array items: type: object properties: *ref_4 required: *ref_5 required: - extra - pagination - results required: - app - author - id - channelId - commentType - content - chainId - deletedAt - logIndex - metadata - hookMetadata - parentId - targetUri - txHash - cursor - moderationStatus - moderationStatusChangedAt - moderationClassifierResult - moderationClassifierScore - createdAt - updatedAt - revision - zeroExSwap - references - path - viewerReactions - reactionCounts - replies id: type: string description: A bigint string createdAt: type: string description: A date string in ISO 8601 format seen: type: boolean seenAt: type: string description: A date string in ISO 8601 format app: type: string description: Hex format string, e.g. `0x1234567890abcdef` pattern: ^0x[a-fA-F0-9]+$ author: type: object properties: address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` ens: type: object properties: name: type: string avatarUrl: type: - string - 'null' required: - name - avatarUrl farcaster: type: object properties: fid: type: integer pfpUrl: type: string displayName: type: string username: type: string required: - fid - username required: - address comment: type: object properties: app: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` author: type: object properties: address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` ens: type: object properties: name: type: string avatarUrl: type: - string - 'null' required: - name - avatarUrl farcaster: type: object properties: fid: type: integer pfpUrl: type: string displayName: type: string username: type: string required: - fid - username required: - address id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` channelId: type: string pattern: ^d+$ commentType: type: integer minimum: 0 maximum: 255 content: type: string chainId: type: integer deletedAt: type: - string - 'null' logIndex: type: - integer - 'null' metadata: type: array items: type: object properties: key: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` value: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - key - value hookMetadata: type: array items: type: object properties: key: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` value: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - key - value parentId: type: - string - 'null' description: >- Hex format string, e.g. `0x1234567890abcdef` targetUri: type: string txHash: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` cursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` moderationStatus: type: string enum: *ref_3 moderationStatusChangedAt: type: - string - 'null' moderationClassifierResult: type: object additionalProperties: type: number minimum: 0 maximum: 1 moderationClassifierScore: type: number minimum: 0 maximum: 1 createdAt: type: - string - 'null' updatedAt: type: - string - 'null' revision: type: integer zeroExSwap: type: - object - 'null' properties: from: type: object properties: address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` amount: type: string pattern: ^\d+(\.\d+)?$ symbol: type: string required: - address - amount - symbol to: type: object properties: address: anyOf: - type: string description: >- Hex format string, e.g. `0x1234567890abcdef` - type: string enum: - '' description: >- Hex format string, e.g. `0x1234567890abcdef` amount: anyOf: - type: string pattern: ^\d+(\.\d+)?$ - type: string enum: - '' symbol: type: string required: - address - amount - symbol required: - from - to references: type: array items: anyOf: - type: object properties: type: type: string enum: - ens avatarUrl: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - avatarUrl - name - address - position - url - type: object properties: type: type: string enum: - erc20 symbol: type: string logoURI: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` decimals: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end chainId: type: - integer - 'null' exclusiveMinimum: 0 chains: type: array items: type: object properties: caip: type: string chainId: type: integer exclusiveMinimum: 0 required: - caip - chainId required: - type - symbol - logoURI - name - address - decimals - position - chainId - chains - type: object properties: type: type: string enum: - farcaster address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` fid: type: integer fname: type: string username: type: string displayName: type: - string - 'null' pfpUrl: type: - string - 'null' position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - address - fid - fname - username - displayName - pfpUrl - position - url - type: object properties: type: type: string enum: - webpage url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end title: type: string description: type: - string - 'null' favicon: type: - string - 'null' format: uri opengraph: type: - object - 'null' properties: title: type: string description: type: - string - 'null' image: type: string format: uri url: type: string format: uri required: - title - description - image - url mediaType: type: string required: - type - url - position - title - description - favicon - opengraph - mediaType - type: object properties: type: type: string enum: - file url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string required: - type - url - position - mediaType - type: object properties: type: type: string enum: - image url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height required: - type - url - position - mediaType - type: object properties: type: type: string enum: - video url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string videoTracks: type: array items: type: object properties: dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height codec: type: string required: - dimension required: - type - url - position - mediaType - type: object properties: type: type: string enum: - quoted_comment id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` chainId: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end required: - type - id - chainId - position - {} - type: 'null' path: type: string viewerReactions: type: object additionalProperties: type: array items: type: object properties: *ref_11 required: *ref_12 reactionCounts: type: object additionalProperties: type: number replies: type: object properties: extra: type: object properties: moderationEnabled: type: boolean moderationKnownReactions: type: array items: type: string required: - moderationEnabled - moderationKnownReactions pagination: type: object properties: limit: type: integer hasNext: type: boolean hasPrevious: type: boolean startCursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` endCursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` count: type: integer minimum: 0 required: - limit - hasNext - hasPrevious - count results: type: array items: type: object properties: *ref_4 required: *ref_5 required: - extra - pagination - results required: - app - author - id - channelId - commentType - content - chainId - deletedAt - logIndex - metadata - hookMetadata - parentId - targetUri - txHash - cursor - moderationStatus - moderationStatusChangedAt - moderationClassifierResult - moderationClassifierScore - createdAt - updatedAt - revision - zeroExSwap - references - path - viewerReactions - reactionCounts - replies description: >- The comment that has been created by the author. This comment triggered the notification. required: - type - replyingTo - id - createdAt - seen - seenAt - app - author - comment - type: object properties: type: type: string enum: - mention mentionedUser: type: object properties: address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` ens: type: object properties: name: type: string avatarUrl: type: - string - 'null' required: - name - avatarUrl farcaster: type: object properties: fid: type: integer pfpUrl: type: string displayName: type: string username: type: string required: - fid - username required: - address id: type: string description: A bigint string createdAt: type: string description: A date string in ISO 8601 format seen: type: boolean seenAt: type: string description: A date string in ISO 8601 format app: type: string description: Hex format string, e.g. `0x1234567890abcdef` pattern: ^0x[a-fA-F0-9]+$ author: type: object properties: address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` ens: type: object properties: name: type: string avatarUrl: type: - string - 'null' required: - name - avatarUrl farcaster: type: object properties: fid: type: integer pfpUrl: type: string displayName: type: string username: type: string required: - fid - username required: - address comment: type: object properties: app: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` author: type: object properties: address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` ens: type: object properties: name: type: string avatarUrl: type: - string - 'null' required: - name - avatarUrl farcaster: type: object properties: fid: type: integer pfpUrl: type: string displayName: type: string username: type: string required: - fid - username required: - address id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` channelId: type: string pattern: ^d+$ commentType: type: integer minimum: 0 maximum: 255 content: type: string chainId: type: integer deletedAt: type: - string - 'null' logIndex: type: - integer - 'null' metadata: type: array items: type: object properties: key: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` value: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - key - value hookMetadata: type: array items: type: object properties: key: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` value: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - key - value parentId: type: - string - 'null' description: >- Hex format string, e.g. `0x1234567890abcdef` targetUri: type: string txHash: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` cursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` moderationStatus: type: string enum: *ref_3 moderationStatusChangedAt: type: - string - 'null' moderationClassifierResult: type: object additionalProperties: type: number minimum: 0 maximum: 1 moderationClassifierScore: type: number minimum: 0 maximum: 1 createdAt: type: - string - 'null' updatedAt: type: - string - 'null' revision: type: integer zeroExSwap: type: - object - 'null' properties: from: type: object properties: address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` amount: type: string pattern: ^\d+(\.\d+)?$ symbol: type: string required: - address - amount - symbol to: type: object properties: address: anyOf: - type: string description: >- Hex format string, e.g. `0x1234567890abcdef` - type: string enum: - '' description: >- Hex format string, e.g. `0x1234567890abcdef` amount: anyOf: - type: string pattern: ^\d+(\.\d+)?$ - type: string enum: - '' symbol: type: string required: - address - amount - symbol required: - from - to references: type: array items: anyOf: - type: object properties: type: type: string enum: - ens avatarUrl: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - avatarUrl - name - address - position - url - type: object properties: type: type: string enum: - erc20 symbol: type: string logoURI: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` decimals: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end chainId: type: - integer - 'null' exclusiveMinimum: 0 chains: type: array items: type: object properties: caip: type: string chainId: type: integer exclusiveMinimum: 0 required: - caip - chainId required: - type - symbol - logoURI - name - address - decimals - position - chainId - chains - type: object properties: type: type: string enum: - farcaster address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` fid: type: integer fname: type: string username: type: string displayName: type: - string - 'null' pfpUrl: type: - string - 'null' position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - address - fid - fname - username - displayName - pfpUrl - position - url - type: object properties: type: type: string enum: - webpage url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end title: type: string description: type: - string - 'null' favicon: type: - string - 'null' format: uri opengraph: type: - object - 'null' properties: title: type: string description: type: - string - 'null' image: type: string format: uri url: type: string format: uri required: - title - description - image - url mediaType: type: string required: - type - url - position - title - description - favicon - opengraph - mediaType - type: object properties: type: type: string enum: - file url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string required: - type - url - position - mediaType - type: object properties: type: type: string enum: - image url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height required: - type - url - position - mediaType - type: object properties: type: type: string enum: - video url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string videoTracks: type: array items: type: object properties: dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height codec: type: string required: - dimension required: - type - url - position - mediaType - type: object properties: type: type: string enum: - quoted_comment id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` chainId: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end required: - type - id - chainId - position - {} - type: 'null' path: type: string viewerReactions: type: object additionalProperties: type: array items: type: object properties: *ref_11 required: *ref_12 reactionCounts: type: object additionalProperties: type: number replies: type: object properties: extra: type: object properties: moderationEnabled: type: boolean moderationKnownReactions: type: array items: type: string required: - moderationEnabled - moderationKnownReactions pagination: type: object properties: limit: type: integer hasNext: type: boolean hasPrevious: type: boolean startCursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` endCursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` count: type: integer minimum: 0 required: - limit - hasNext - hasPrevious - count results: type: array items: type: object properties: *ref_4 required: *ref_5 required: - extra - pagination - results required: - app - author - id - channelId - commentType - content - chainId - deletedAt - logIndex - metadata - hookMetadata - parentId - targetUri - txHash - cursor - moderationStatus - moderationStatusChangedAt - moderationClassifierResult - moderationClassifierScore - createdAt - updatedAt - revision - zeroExSwap - references - path - viewerReactions - reactionCounts - replies description: >- The comment that has been created by the author. This comment triggered the notification. required: - type - mentionedUser - id - createdAt - seen - seenAt - app - author - comment - type: object properties: type: type: string enum: - reaction reactingTo: type: object properties: app: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` author: type: object properties: address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` ens: type: object properties: name: type: string avatarUrl: type: - string - 'null' required: - name - avatarUrl farcaster: type: object properties: fid: type: integer pfpUrl: type: string displayName: type: string username: type: string required: - fid - username required: - address id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` channelId: type: string pattern: ^d+$ commentType: type: integer minimum: 0 maximum: 255 content: type: string chainId: type: integer deletedAt: type: - string - 'null' logIndex: type: - integer - 'null' metadata: type: array items: type: object properties: key: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` value: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - key - value hookMetadata: type: array items: type: object properties: key: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` value: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - key - value parentId: type: - string - 'null' description: >- Hex format string, e.g. `0x1234567890abcdef` targetUri: type: string txHash: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` cursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` moderationStatus: type: string enum: *ref_3 moderationStatusChangedAt: type: - string - 'null' moderationClassifierResult: type: object additionalProperties: type: number minimum: 0 maximum: 1 moderationClassifierScore: type: number minimum: 0 maximum: 1 createdAt: type: - string - 'null' updatedAt: type: - string - 'null' revision: type: integer zeroExSwap: type: - object - 'null' properties: from: type: object properties: address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` amount: type: string pattern: ^\d+(\.\d+)?$ symbol: type: string required: - address - amount - symbol to: type: object properties: address: anyOf: - type: string description: >- Hex format string, e.g. `0x1234567890abcdef` - type: string enum: - '' description: >- Hex format string, e.g. `0x1234567890abcdef` amount: anyOf: - type: string pattern: ^\d+(\.\d+)?$ - type: string enum: - '' symbol: type: string required: - address - amount - symbol required: - from - to references: type: array items: anyOf: - type: object properties: type: type: string enum: - ens avatarUrl: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - avatarUrl - name - address - position - url - type: object properties: type: type: string enum: - erc20 symbol: type: string logoURI: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` decimals: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end chainId: type: - integer - 'null' exclusiveMinimum: 0 chains: type: array items: type: object properties: caip: type: string chainId: type: integer exclusiveMinimum: 0 required: - caip - chainId required: - type - symbol - logoURI - name - address - decimals - position - chainId - chains - type: object properties: type: type: string enum: - farcaster address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` fid: type: integer fname: type: string username: type: string displayName: type: - string - 'null' pfpUrl: type: - string - 'null' position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - address - fid - fname - username - displayName - pfpUrl - position - url - type: object properties: type: type: string enum: - webpage url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end title: type: string description: type: - string - 'null' favicon: type: - string - 'null' format: uri opengraph: type: - object - 'null' properties: title: type: string description: type: - string - 'null' image: type: string format: uri url: type: string format: uri required: - title - description - image - url mediaType: type: string required: - type - url - position - title - description - favicon - opengraph - mediaType - type: object properties: type: type: string enum: - file url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string required: - type - url - position - mediaType - type: object properties: type: type: string enum: - image url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height required: - type - url - position - mediaType - type: object properties: type: type: string enum: - video url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string videoTracks: type: array items: type: object properties: dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height codec: type: string required: - dimension required: - type - url - position - mediaType - type: object properties: type: type: string enum: - quoted_comment id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` chainId: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end required: - type - id - chainId - position - {} - type: 'null' path: type: string viewerReactions: type: object additionalProperties: type: array items: type: object properties: *ref_11 required: *ref_12 reactionCounts: type: object additionalProperties: type: number replies: type: object properties: extra: type: object properties: moderationEnabled: type: boolean moderationKnownReactions: type: array items: type: string required: - moderationEnabled - moderationKnownReactions pagination: type: object properties: limit: type: integer hasNext: type: boolean hasPrevious: type: boolean startCursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` endCursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` count: type: integer minimum: 0 required: - limit - hasNext - hasPrevious - count results: type: array items: type: object properties: *ref_4 required: *ref_5 required: - extra - pagination - results required: - app - author - id - channelId - commentType - content - chainId - deletedAt - logIndex - metadata - hookMetadata - parentId - targetUri - txHash - cursor - moderationStatus - moderationStatusChangedAt - moderationClassifierResult - moderationClassifierScore - createdAt - updatedAt - revision - zeroExSwap - references - path - viewerReactions - reactionCounts - replies id: type: string description: A bigint string createdAt: type: string description: A date string in ISO 8601 format seen: type: boolean seenAt: type: string description: A date string in ISO 8601 format app: type: string description: Hex format string, e.g. `0x1234567890abcdef` pattern: ^0x[a-fA-F0-9]+$ author: type: object properties: address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` ens: type: object properties: name: type: string avatarUrl: type: - string - 'null' required: - name - avatarUrl farcaster: type: object properties: fid: type: integer pfpUrl: type: string displayName: type: string username: type: string required: - fid - username required: - address comment: type: object properties: app: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` author: type: object properties: address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` ens: type: object properties: name: type: string avatarUrl: type: - string - 'null' required: - name - avatarUrl farcaster: type: object properties: fid: type: integer pfpUrl: type: string displayName: type: string username: type: string required: - fid - username required: - address id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` channelId: type: string pattern: ^d+$ commentType: type: integer minimum: 0 maximum: 255 content: type: string chainId: type: integer deletedAt: type: - string - 'null' logIndex: type: - integer - 'null' metadata: type: array items: type: object properties: key: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` value: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - key - value hookMetadata: type: array items: type: object properties: key: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` value: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - key - value parentId: type: - string - 'null' description: >- Hex format string, e.g. `0x1234567890abcdef` targetUri: type: string txHash: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` cursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` moderationStatus: type: string enum: *ref_3 moderationStatusChangedAt: type: - string - 'null' moderationClassifierResult: type: object additionalProperties: type: number minimum: 0 maximum: 1 moderationClassifierScore: type: number minimum: 0 maximum: 1 createdAt: type: - string - 'null' updatedAt: type: - string - 'null' revision: type: integer zeroExSwap: type: - object - 'null' properties: from: type: object properties: address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` amount: type: string pattern: ^\d+(\.\d+)?$ symbol: type: string required: - address - amount - symbol to: type: object properties: address: anyOf: - type: string description: >- Hex format string, e.g. `0x1234567890abcdef` - type: string enum: - '' description: >- Hex format string, e.g. `0x1234567890abcdef` amount: anyOf: - type: string pattern: ^\d+(\.\d+)?$ - type: string enum: - '' symbol: type: string required: - address - amount - symbol required: - from - to references: type: array items: anyOf: - type: object properties: type: type: string enum: - ens avatarUrl: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - avatarUrl - name - address - position - url - type: object properties: type: type: string enum: - erc20 symbol: type: string logoURI: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` decimals: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end chainId: type: - integer - 'null' exclusiveMinimum: 0 chains: type: array items: type: object properties: caip: type: string chainId: type: integer exclusiveMinimum: 0 required: - caip - chainId required: - type - symbol - logoURI - name - address - decimals - position - chainId - chains - type: object properties: type: type: string enum: - farcaster address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` fid: type: integer fname: type: string username: type: string displayName: type: - string - 'null' pfpUrl: type: - string - 'null' position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - address - fid - fname - username - displayName - pfpUrl - position - url - type: object properties: type: type: string enum: - webpage url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end title: type: string description: type: - string - 'null' favicon: type: - string - 'null' format: uri opengraph: type: - object - 'null' properties: title: type: string description: type: - string - 'null' image: type: string format: uri url: type: string format: uri required: - title - description - image - url mediaType: type: string required: - type - url - position - title - description - favicon - opengraph - mediaType - type: object properties: type: type: string enum: - file url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string required: - type - url - position - mediaType - type: object properties: type: type: string enum: - image url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height required: - type - url - position - mediaType - type: object properties: type: type: string enum: - video url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string videoTracks: type: array items: type: object properties: dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height codec: type: string required: - dimension required: - type - url - position - mediaType - type: object properties: type: type: string enum: - quoted_comment id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` chainId: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end required: - type - id - chainId - position - {} - type: 'null' path: type: string viewerReactions: type: object additionalProperties: type: array items: type: object properties: *ref_11 required: *ref_12 reactionCounts: type: object additionalProperties: type: number replies: type: object properties: extra: type: object properties: moderationEnabled: type: boolean moderationKnownReactions: type: array items: type: string required: - moderationEnabled - moderationKnownReactions pagination: type: object properties: limit: type: integer hasNext: type: boolean hasPrevious: type: boolean startCursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` endCursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` count: type: integer minimum: 0 required: - limit - hasNext - hasPrevious - count results: type: array items: type: object properties: *ref_4 required: *ref_5 required: - extra - pagination - results required: - app - author - id - channelId - commentType - content - chainId - deletedAt - logIndex - metadata - hookMetadata - parentId - targetUri - txHash - cursor - moderationStatus - moderationStatusChangedAt - moderationClassifierResult - moderationClassifierScore - createdAt - updatedAt - revision - zeroExSwap - references - path - viewerReactions - reactionCounts - replies description: >- The comment that has been created by the author. This comment triggered the notification. required: - type - reactingTo - id - createdAt - seen - seenAt - app - author - comment - type: object properties: type: type: string enum: - quote quotedComment: type: object properties: app: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` author: type: object properties: address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` ens: type: object properties: name: type: string avatarUrl: type: - string - 'null' required: - name - avatarUrl farcaster: type: object properties: fid: type: integer pfpUrl: type: string displayName: type: string username: type: string required: - fid - username required: - address id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` channelId: type: string pattern: ^d+$ commentType: type: integer minimum: 0 maximum: 255 content: type: string chainId: type: integer deletedAt: type: - string - 'null' logIndex: type: - integer - 'null' metadata: type: array items: type: object properties: key: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` value: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - key - value hookMetadata: type: array items: type: object properties: key: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` value: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - key - value parentId: type: - string - 'null' description: >- Hex format string, e.g. `0x1234567890abcdef` targetUri: type: string txHash: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` cursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` moderationStatus: type: string enum: *ref_3 moderationStatusChangedAt: type: - string - 'null' moderationClassifierResult: type: object additionalProperties: type: number minimum: 0 maximum: 1 moderationClassifierScore: type: number minimum: 0 maximum: 1 createdAt: type: - string - 'null' updatedAt: type: - string - 'null' revision: type: integer zeroExSwap: type: - object - 'null' properties: from: type: object properties: address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` amount: type: string pattern: ^\d+(\.\d+)?$ symbol: type: string required: - address - amount - symbol to: type: object properties: address: anyOf: - type: string description: >- Hex format string, e.g. `0x1234567890abcdef` - type: string enum: - '' description: >- Hex format string, e.g. `0x1234567890abcdef` amount: anyOf: - type: string pattern: ^\d+(\.\d+)?$ - type: string enum: - '' symbol: type: string required: - address - amount - symbol required: - from - to references: type: array items: anyOf: - type: object properties: type: type: string enum: - ens avatarUrl: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - avatarUrl - name - address - position - url - type: object properties: type: type: string enum: - erc20 symbol: type: string logoURI: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` decimals: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end chainId: type: - integer - 'null' exclusiveMinimum: 0 chains: type: array items: type: object properties: caip: type: string chainId: type: integer exclusiveMinimum: 0 required: - caip - chainId required: - type - symbol - logoURI - name - address - decimals - position - chainId - chains - type: object properties: type: type: string enum: - farcaster address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` fid: type: integer fname: type: string username: type: string displayName: type: - string - 'null' pfpUrl: type: - string - 'null' position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - address - fid - fname - username - displayName - pfpUrl - position - url - type: object properties: type: type: string enum: - webpage url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end title: type: string description: type: - string - 'null' favicon: type: - string - 'null' format: uri opengraph: type: - object - 'null' properties: title: type: string description: type: - string - 'null' image: type: string format: uri url: type: string format: uri required: - title - description - image - url mediaType: type: string required: - type - url - position - title - description - favicon - opengraph - mediaType - type: object properties: type: type: string enum: - file url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string required: - type - url - position - mediaType - type: object properties: type: type: string enum: - image url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height required: - type - url - position - mediaType - type: object properties: type: type: string enum: - video url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string videoTracks: type: array items: type: object properties: dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height codec: type: string required: - dimension required: - type - url - position - mediaType - type: object properties: type: type: string enum: - quoted_comment id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` chainId: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end required: - type - id - chainId - position - {} - type: 'null' path: type: string viewerReactions: type: object additionalProperties: type: array items: type: object properties: *ref_11 required: *ref_12 reactionCounts: type: object additionalProperties: type: number replies: type: object properties: extra: type: object properties: moderationEnabled: type: boolean moderationKnownReactions: type: array items: type: string required: - moderationEnabled - moderationKnownReactions pagination: type: object properties: limit: type: integer hasNext: type: boolean hasPrevious: type: boolean startCursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` endCursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` count: type: integer minimum: 0 required: - limit - hasNext - hasPrevious - count results: type: array items: type: object properties: *ref_4 required: *ref_5 required: - extra - pagination - results required: - app - author - id - channelId - commentType - content - chainId - deletedAt - logIndex - metadata - hookMetadata - parentId - targetUri - txHash - cursor - moderationStatus - moderationStatusChangedAt - moderationClassifierResult - moderationClassifierScore - createdAt - updatedAt - revision - zeroExSwap - references - path - viewerReactions - reactionCounts - replies id: type: string description: A bigint string createdAt: type: string description: A date string in ISO 8601 format seen: type: boolean seenAt: type: string description: A date string in ISO 8601 format app: type: string description: Hex format string, e.g. `0x1234567890abcdef` pattern: ^0x[a-fA-F0-9]+$ author: type: object properties: address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` ens: type: object properties: name: type: string avatarUrl: type: - string - 'null' required: - name - avatarUrl farcaster: type: object properties: fid: type: integer pfpUrl: type: string displayName: type: string username: type: string required: - fid - username required: - address comment: type: object properties: app: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` author: type: object properties: address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` ens: type: object properties: name: type: string avatarUrl: type: - string - 'null' required: - name - avatarUrl farcaster: type: object properties: fid: type: integer pfpUrl: type: string displayName: type: string username: type: string required: - fid - username required: - address id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` channelId: type: string pattern: ^d+$ commentType: type: integer minimum: 0 maximum: 255 content: type: string chainId: type: integer deletedAt: type: - string - 'null' logIndex: type: - integer - 'null' metadata: type: array items: type: object properties: key: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` value: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - key - value hookMetadata: type: array items: type: object properties: key: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` value: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - key - value parentId: type: - string - 'null' description: >- Hex format string, e.g. `0x1234567890abcdef` targetUri: type: string txHash: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` cursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` moderationStatus: type: string enum: *ref_3 moderationStatusChangedAt: type: - string - 'null' moderationClassifierResult: type: object additionalProperties: type: number minimum: 0 maximum: 1 moderationClassifierScore: type: number minimum: 0 maximum: 1 createdAt: type: - string - 'null' updatedAt: type: - string - 'null' revision: type: integer zeroExSwap: type: - object - 'null' properties: from: type: object properties: address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` amount: type: string pattern: ^\d+(\.\d+)?$ symbol: type: string required: - address - amount - symbol to: type: object properties: address: anyOf: - type: string description: >- Hex format string, e.g. `0x1234567890abcdef` - type: string enum: - '' description: >- Hex format string, e.g. `0x1234567890abcdef` amount: anyOf: - type: string pattern: ^\d+(\.\d+)?$ - type: string enum: - '' symbol: type: string required: - address - amount - symbol required: - from - to references: type: array items: anyOf: - type: object properties: type: type: string enum: - ens avatarUrl: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - avatarUrl - name - address - position - url - type: object properties: type: type: string enum: - erc20 symbol: type: string logoURI: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` decimals: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end chainId: type: - integer - 'null' exclusiveMinimum: 0 chains: type: array items: type: object properties: caip: type: string chainId: type: integer exclusiveMinimum: 0 required: - caip - chainId required: - type - symbol - logoURI - name - address - decimals - position - chainId - chains - type: object properties: type: type: string enum: - farcaster address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` fid: type: integer fname: type: string username: type: string displayName: type: - string - 'null' pfpUrl: type: - string - 'null' position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - address - fid - fname - username - displayName - pfpUrl - position - url - type: object properties: type: type: string enum: - webpage url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end title: type: string description: type: - string - 'null' favicon: type: - string - 'null' format: uri opengraph: type: - object - 'null' properties: title: type: string description: type: - string - 'null' image: type: string format: uri url: type: string format: uri required: - title - description - image - url mediaType: type: string required: - type - url - position - title - description - favicon - opengraph - mediaType - type: object properties: type: type: string enum: - file url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string required: - type - url - position - mediaType - type: object properties: type: type: string enum: - image url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height required: - type - url - position - mediaType - type: object properties: type: type: string enum: - video url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string videoTracks: type: array items: type: object properties: dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height codec: type: string required: - dimension required: - type - url - position - mediaType - type: object properties: type: type: string enum: - quoted_comment id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` chainId: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end required: - type - id - chainId - position - {} - type: 'null' path: type: string viewerReactions: type: object additionalProperties: type: array items: type: object properties: *ref_11 required: *ref_12 reactionCounts: type: object additionalProperties: type: number replies: type: object properties: extra: type: object properties: moderationEnabled: type: boolean moderationKnownReactions: type: array items: type: string required: - moderationEnabled - moderationKnownReactions pagination: type: object properties: limit: type: integer hasNext: type: boolean hasPrevious: type: boolean startCursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` endCursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` count: type: integer minimum: 0 required: - limit - hasNext - hasPrevious - count results: type: array items: type: object properties: *ref_4 required: *ref_5 required: - extra - pagination - results required: - app - author - id - channelId - commentType - content - chainId - deletedAt - logIndex - metadata - hookMetadata - parentId - targetUri - txHash - cursor - moderationStatus - moderationStatusChangedAt - moderationClassifierResult - moderationClassifierScore - createdAt - updatedAt - revision - zeroExSwap - references - path - viewerReactions - reactionCounts - replies description: >- The comment that has been created by the author. This comment triggered the notification. required: - type - quotedComment - id - createdAt - seen - seenAt - app - author - comment required: - cursor - notification pageInfo: type: object properties: hasNextPage: type: boolean hasPreviousPage: type: boolean startCursor: type: object properties: id: type: string description: A bigint string required: - id endCursor: type: object properties: id: type: string description: A bigint string required: - id required: - hasNextPage - hasPreviousPage extra: type: object properties: unseenCount: type: string description: A bigint string required: - unseenCount required: - notifications - pageInfo - extra '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' /api/notifications/grouped: get: description: Get notifications grouped by type parameters: - schema: type: array items: type: string description: Hex format string, e.g. `0x1234567890abcdef` pattern: ^0x[a-fA-F0-9]+$ maxItems: 20 default: *ref_23 description: Return only notifications created by this app signers oneOf: *ref_24 required: false name: app in: query - schema: type: object properties: us: type: string pattern: ^d+$ id: type: string pattern: ^d+$ required: - us - id description: Fetch newer notifications than the cursor required: false name: before in: query - schema: type: object properties: us: type: string pattern: ^d+$ id: type: string pattern: ^d+$ required: - us - id description: Fetch older notifications than the cursor required: false name: after in: query - schema: type: integer minimum: 1 maximum: 100 default: 10 description: The number of notifications to return required: false name: limit in: query - schema: type: array items: type: string enum: *ref_22 default: *ref_25 description: Return only notifications of this type oneOf: *ref_26 required: false name: type in: query - schema: anyOf: - type: string description: The Ethereum address of the user pattern: ^0x[a-fA-F0-9]{40}$ - description: The ENS name of the user pattern: ^[a-zA-Z0-9.-]+\.eth$ description: The ENS name or address of the user required: true name: user in: query - schema: type: string enum: *ref_27 description: >- Whether to include only seen or unseen notifications, if omitted or empty all notifications will be included required: false name: seen in: query responses: '200': description: The notifications grouped by type content: application/json: schema: type: object properties: notifications: type: array items: type: object properties: cursor: type: object properties: us: type: string description: A bigint string id: type: string description: A bigint string required: - us - id groupedBy: type: object properties: notificationType: type: string enum: *ref_22 parent: type: object properties: type: type: string enum: - comment comment: type: object properties: app: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` author: type: object properties: address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` ens: type: object properties: name: type: string avatarUrl: type: - string - 'null' required: - name - avatarUrl farcaster: type: object properties: fid: type: integer pfpUrl: type: string displayName: type: string username: type: string required: - fid - username required: - address id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` channelId: type: string pattern: ^d+$ commentType: type: integer minimum: 0 maximum: 255 content: type: string chainId: type: integer deletedAt: type: - string - 'null' logIndex: type: - integer - 'null' metadata: type: array items: type: object properties: key: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` value: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - key - value hookMetadata: type: array items: type: object properties: key: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` value: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - key - value parentId: type: - string - 'null' description: >- Hex format string, e.g. `0x1234567890abcdef` targetUri: type: string txHash: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` cursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` moderationStatus: type: string enum: *ref_3 moderationStatusChangedAt: type: - string - 'null' moderationClassifierResult: type: object additionalProperties: type: number minimum: 0 maximum: 1 moderationClassifierScore: type: number minimum: 0 maximum: 1 createdAt: type: - string - 'null' updatedAt: type: - string - 'null' revision: type: integer zeroExSwap: type: - object - 'null' properties: from: type: object properties: address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` amount: type: string pattern: ^\d+(\.\d+)?$ symbol: type: string required: - address - amount - symbol to: type: object properties: address: anyOf: - type: string description: >- Hex format string, e.g. `0x1234567890abcdef` - type: string enum: - '' description: >- Hex format string, e.g. `0x1234567890abcdef` amount: anyOf: - type: string pattern: ^\d+(\.\d+)?$ - type: string enum: - '' symbol: type: string required: - address - amount - symbol required: - from - to references: type: array items: anyOf: - type: object properties: type: type: string enum: - ens avatarUrl: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - avatarUrl - name - address - position - url - type: object properties: type: type: string enum: - erc20 symbol: type: string logoURI: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` decimals: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end chainId: type: - integer - 'null' exclusiveMinimum: 0 chains: type: array items: type: object properties: caip: type: string chainId: type: integer exclusiveMinimum: 0 required: - caip - chainId required: - type - symbol - logoURI - name - address - decimals - position - chainId - chains - type: object properties: type: type: string enum: - farcaster address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` fid: type: integer fname: type: string username: type: string displayName: type: - string - 'null' pfpUrl: type: - string - 'null' position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - address - fid - fname - username - displayName - pfpUrl - position - url - type: object properties: type: type: string enum: - webpage url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end title: type: string description: type: - string - 'null' favicon: type: - string - 'null' format: uri opengraph: type: - object - 'null' properties: title: type: string description: type: - string - 'null' image: type: string format: uri url: type: string format: uri required: - title - description - image - url mediaType: type: string required: - type - url - position - title - description - favicon - opengraph - mediaType - type: object properties: type: type: string enum: - file url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string required: - type - url - position - mediaType - type: object properties: type: type: string enum: - image url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height required: - type - url - position - mediaType - type: object properties: type: type: string enum: - video url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string videoTracks: type: array items: type: object properties: dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height codec: type: string required: - dimension required: - type - url - position - mediaType - type: object properties: type: type: string enum: - quoted_comment id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` chainId: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end required: - type - id - chainId - position - {} - type: 'null' path: type: string viewerReactions: type: object additionalProperties: type: array items: type: object properties: *ref_11 required: *ref_12 reactionCounts: type: object additionalProperties: type: number replies: type: object properties: extra: type: object properties: moderationEnabled: type: boolean moderationKnownReactions: type: array items: type: string required: - moderationEnabled - moderationKnownReactions pagination: type: object properties: limit: type: integer hasNext: type: boolean hasPrevious: type: boolean startCursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` endCursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` count: type: integer minimum: 0 required: - limit - hasNext - hasPrevious - count results: type: array items: type: object properties: *ref_4 required: *ref_5 required: - extra - pagination - results required: - app - author - id - channelId - commentType - content - chainId - deletedAt - logIndex - metadata - hookMetadata - parentId - targetUri - txHash - cursor - moderationStatus - moderationStatusChangedAt - moderationClassifierResult - moderationClassifierScore - createdAt - updatedAt - revision - zeroExSwap - references - path - viewerReactions - reactionCounts - replies required: - type - comment required: - notificationType - parent description: Condition used to group notifications notifications: type: object properties: notifications: type: array items: type: object properties: cursor: type: object properties: id: type: string description: A bigint string required: - id notification: oneOf: - type: object properties: type: type: string enum: - reply replyingTo: type: object properties: app: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` author: type: object properties: address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` ens: type: object properties: name: type: string avatarUrl: type: - string - 'null' required: - name - avatarUrl farcaster: type: object properties: fid: type: integer pfpUrl: type: string displayName: type: string username: type: string required: - fid - username required: - address id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` channelId: type: string pattern: ^d+$ commentType: type: integer minimum: 0 maximum: 255 content: type: string chainId: type: integer deletedAt: type: - string - 'null' logIndex: type: - integer - 'null' metadata: type: array items: type: object properties: key: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` value: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - key - value hookMetadata: type: array items: type: object properties: key: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` value: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - key - value parentId: type: - string - 'null' description: >- Hex format string, e.g. `0x1234567890abcdef` targetUri: type: string txHash: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` cursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` moderationStatus: type: string enum: *ref_3 moderationStatusChangedAt: type: - string - 'null' moderationClassifierResult: type: object additionalProperties: type: number minimum: 0 maximum: 1 moderationClassifierScore: type: number minimum: 0 maximum: 1 createdAt: type: - string - 'null' updatedAt: type: - string - 'null' revision: type: integer zeroExSwap: type: - object - 'null' properties: from: type: object properties: address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` amount: type: string pattern: ^\d+(\.\d+)?$ symbol: type: string required: - address - amount - symbol to: type: object properties: address: anyOf: - type: string description: >- Hex format string, e.g. `0x1234567890abcdef` - type: string enum: - '' description: >- Hex format string, e.g. `0x1234567890abcdef` amount: anyOf: - type: string pattern: ^\d+(\.\d+)?$ - type: string enum: - '' symbol: type: string required: - address - amount - symbol required: - from - to references: type: array items: anyOf: - type: object properties: type: type: string enum: - ens avatarUrl: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - avatarUrl - name - address - position - url - type: object properties: type: type: string enum: - erc20 symbol: type: string logoURI: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` decimals: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end chainId: type: - integer - 'null' exclusiveMinimum: 0 chains: type: array items: type: object properties: caip: type: string chainId: type: integer exclusiveMinimum: 0 required: - caip - chainId required: - type - symbol - logoURI - name - address - decimals - position - chainId - chains - type: object properties: type: type: string enum: - farcaster address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` fid: type: integer fname: type: string username: type: string displayName: type: - string - 'null' pfpUrl: type: - string - 'null' position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - address - fid - fname - username - displayName - pfpUrl - position - url - type: object properties: type: type: string enum: - webpage url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end title: type: string description: type: - string - 'null' favicon: type: - string - 'null' format: uri opengraph: type: - object - 'null' properties: title: type: string description: type: - string - 'null' image: type: string format: uri url: type: string format: uri required: - title - description - image - url mediaType: type: string required: - type - url - position - title - description - favicon - opengraph - mediaType - type: object properties: type: type: string enum: - file url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string required: - type - url - position - mediaType - type: object properties: type: type: string enum: - image url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height required: - type - url - position - mediaType - type: object properties: type: type: string enum: - video url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string videoTracks: type: array items: type: object properties: dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height codec: type: string required: - dimension required: - type - url - position - mediaType - type: object properties: type: type: string enum: - quoted_comment id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` chainId: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end required: - type - id - chainId - position - {} - type: 'null' path: type: string viewerReactions: type: object additionalProperties: type: array items: type: object properties: *ref_11 required: *ref_12 reactionCounts: type: object additionalProperties: type: number replies: type: object properties: extra: type: object properties: moderationEnabled: type: boolean moderationKnownReactions: type: array items: type: string required: - moderationEnabled - moderationKnownReactions pagination: type: object properties: limit: type: integer hasNext: type: boolean hasPrevious: type: boolean startCursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` endCursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` count: type: integer minimum: 0 required: - limit - hasNext - hasPrevious - count results: type: array items: type: object properties: *ref_4 required: *ref_5 required: - extra - pagination - results required: - app - author - id - channelId - commentType - content - chainId - deletedAt - logIndex - metadata - hookMetadata - parentId - targetUri - txHash - cursor - moderationStatus - moderationStatusChangedAt - moderationClassifierResult - moderationClassifierScore - createdAt - updatedAt - revision - zeroExSwap - references - path - viewerReactions - reactionCounts - replies id: type: string description: A bigint string createdAt: type: string description: A date string in ISO 8601 format seen: type: boolean seenAt: type: string description: A date string in ISO 8601 format app: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` pattern: ^0x[a-fA-F0-9]+$ author: type: object properties: address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` ens: type: object properties: name: type: string avatarUrl: type: - string - 'null' required: - name - avatarUrl farcaster: type: object properties: fid: type: integer pfpUrl: type: string displayName: type: string username: type: string required: - fid - username required: - address comment: type: object properties: app: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` author: type: object properties: address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` ens: type: object properties: name: type: string avatarUrl: type: - string - 'null' required: - name - avatarUrl farcaster: type: object properties: fid: type: integer pfpUrl: type: string displayName: type: string username: type: string required: - fid - username required: - address id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` channelId: type: string pattern: ^d+$ commentType: type: integer minimum: 0 maximum: 255 content: type: string chainId: type: integer deletedAt: type: - string - 'null' logIndex: type: - integer - 'null' metadata: type: array items: type: object properties: key: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` value: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - key - value hookMetadata: type: array items: type: object properties: key: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` value: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - key - value parentId: type: - string - 'null' description: >- Hex format string, e.g. `0x1234567890abcdef` targetUri: type: string txHash: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` cursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` moderationStatus: type: string enum: *ref_3 moderationStatusChangedAt: type: - string - 'null' moderationClassifierResult: type: object additionalProperties: type: number minimum: 0 maximum: 1 moderationClassifierScore: type: number minimum: 0 maximum: 1 createdAt: type: - string - 'null' updatedAt: type: - string - 'null' revision: type: integer zeroExSwap: type: - object - 'null' properties: from: type: object properties: address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` amount: type: string pattern: ^\d+(\.\d+)?$ symbol: type: string required: - address - amount - symbol to: type: object properties: address: anyOf: - type: string description: >- Hex format string, e.g. `0x1234567890abcdef` - type: string enum: - '' description: >- Hex format string, e.g. `0x1234567890abcdef` amount: anyOf: - type: string pattern: ^\d+(\.\d+)?$ - type: string enum: - '' symbol: type: string required: - address - amount - symbol required: - from - to references: type: array items: anyOf: - type: object properties: type: type: string enum: - ens avatarUrl: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - avatarUrl - name - address - position - url - type: object properties: type: type: string enum: - erc20 symbol: type: string logoURI: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` decimals: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end chainId: type: - integer - 'null' exclusiveMinimum: 0 chains: type: array items: type: object properties: caip: type: string chainId: type: integer exclusiveMinimum: 0 required: - caip - chainId required: - type - symbol - logoURI - name - address - decimals - position - chainId - chains - type: object properties: type: type: string enum: - farcaster address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` fid: type: integer fname: type: string username: type: string displayName: type: - string - 'null' pfpUrl: type: - string - 'null' position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - address - fid - fname - username - displayName - pfpUrl - position - url - type: object properties: type: type: string enum: - webpage url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end title: type: string description: type: - string - 'null' favicon: type: - string - 'null' format: uri opengraph: type: - object - 'null' properties: title: type: string description: type: - string - 'null' image: type: string format: uri url: type: string format: uri required: - title - description - image - url mediaType: type: string required: - type - url - position - title - description - favicon - opengraph - mediaType - type: object properties: type: type: string enum: - file url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string required: - type - url - position - mediaType - type: object properties: type: type: string enum: - image url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height required: - type - url - position - mediaType - type: object properties: type: type: string enum: - video url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string videoTracks: type: array items: type: object properties: dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height codec: type: string required: - dimension required: - type - url - position - mediaType - type: object properties: type: type: string enum: - quoted_comment id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` chainId: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end required: - type - id - chainId - position - {} - type: 'null' path: type: string viewerReactions: type: object additionalProperties: type: array items: type: object properties: *ref_11 required: *ref_12 reactionCounts: type: object additionalProperties: type: number replies: type: object properties: extra: type: object properties: moderationEnabled: type: boolean moderationKnownReactions: type: array items: type: string required: - moderationEnabled - moderationKnownReactions pagination: type: object properties: limit: type: integer hasNext: type: boolean hasPrevious: type: boolean startCursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` endCursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` count: type: integer minimum: 0 required: - limit - hasNext - hasPrevious - count results: type: array items: type: object properties: *ref_4 required: *ref_5 required: - extra - pagination - results required: - app - author - id - channelId - commentType - content - chainId - deletedAt - logIndex - metadata - hookMetadata - parentId - targetUri - txHash - cursor - moderationStatus - moderationStatusChangedAt - moderationClassifierResult - moderationClassifierScore - createdAt - updatedAt - revision - zeroExSwap - references - path - viewerReactions - reactionCounts - replies description: >- The comment that has been created by the author. This comment triggered the notification. required: - type - replyingTo - id - createdAt - seen - seenAt - app - author - comment - type: object properties: type: type: string enum: - mention mentionedUser: type: object properties: address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` ens: type: object properties: name: type: string avatarUrl: type: - string - 'null' required: - name - avatarUrl farcaster: type: object properties: fid: type: integer pfpUrl: type: string displayName: type: string username: type: string required: - fid - username required: - address id: type: string description: A bigint string createdAt: type: string description: A date string in ISO 8601 format seen: type: boolean seenAt: type: string description: A date string in ISO 8601 format app: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` pattern: ^0x[a-fA-F0-9]+$ author: type: object properties: address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` ens: type: object properties: name: type: string avatarUrl: type: - string - 'null' required: - name - avatarUrl farcaster: type: object properties: fid: type: integer pfpUrl: type: string displayName: type: string username: type: string required: - fid - username required: - address comment: type: object properties: app: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` author: type: object properties: address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` ens: type: object properties: name: type: string avatarUrl: type: - string - 'null' required: - name - avatarUrl farcaster: type: object properties: fid: type: integer pfpUrl: type: string displayName: type: string username: type: string required: - fid - username required: - address id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` channelId: type: string pattern: ^d+$ commentType: type: integer minimum: 0 maximum: 255 content: type: string chainId: type: integer deletedAt: type: - string - 'null' logIndex: type: - integer - 'null' metadata: type: array items: type: object properties: key: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` value: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - key - value hookMetadata: type: array items: type: object properties: key: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` value: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - key - value parentId: type: - string - 'null' description: >- Hex format string, e.g. `0x1234567890abcdef` targetUri: type: string txHash: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` cursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` moderationStatus: type: string enum: *ref_3 moderationStatusChangedAt: type: - string - 'null' moderationClassifierResult: type: object additionalProperties: type: number minimum: 0 maximum: 1 moderationClassifierScore: type: number minimum: 0 maximum: 1 createdAt: type: - string - 'null' updatedAt: type: - string - 'null' revision: type: integer zeroExSwap: type: - object - 'null' properties: from: type: object properties: address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` amount: type: string pattern: ^\d+(\.\d+)?$ symbol: type: string required: - address - amount - symbol to: type: object properties: address: anyOf: - type: string description: >- Hex format string, e.g. `0x1234567890abcdef` - type: string enum: - '' description: >- Hex format string, e.g. `0x1234567890abcdef` amount: anyOf: - type: string pattern: ^\d+(\.\d+)?$ - type: string enum: - '' symbol: type: string required: - address - amount - symbol required: - from - to references: type: array items: anyOf: - type: object properties: type: type: string enum: - ens avatarUrl: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - avatarUrl - name - address - position - url - type: object properties: type: type: string enum: - erc20 symbol: type: string logoURI: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` decimals: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end chainId: type: - integer - 'null' exclusiveMinimum: 0 chains: type: array items: type: object properties: caip: type: string chainId: type: integer exclusiveMinimum: 0 required: - caip - chainId required: - type - symbol - logoURI - name - address - decimals - position - chainId - chains - type: object properties: type: type: string enum: - farcaster address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` fid: type: integer fname: type: string username: type: string displayName: type: - string - 'null' pfpUrl: type: - string - 'null' position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - address - fid - fname - username - displayName - pfpUrl - position - url - type: object properties: type: type: string enum: - webpage url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end title: type: string description: type: - string - 'null' favicon: type: - string - 'null' format: uri opengraph: type: - object - 'null' properties: title: type: string description: type: - string - 'null' image: type: string format: uri url: type: string format: uri required: - title - description - image - url mediaType: type: string required: - type - url - position - title - description - favicon - opengraph - mediaType - type: object properties: type: type: string enum: - file url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string required: - type - url - position - mediaType - type: object properties: type: type: string enum: - image url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height required: - type - url - position - mediaType - type: object properties: type: type: string enum: - video url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string videoTracks: type: array items: type: object properties: dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height codec: type: string required: - dimension required: - type - url - position - mediaType - type: object properties: type: type: string enum: - quoted_comment id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` chainId: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end required: - type - id - chainId - position - {} - type: 'null' path: type: string viewerReactions: type: object additionalProperties: type: array items: type: object properties: *ref_11 required: *ref_12 reactionCounts: type: object additionalProperties: type: number replies: type: object properties: extra: type: object properties: moderationEnabled: type: boolean moderationKnownReactions: type: array items: type: string required: - moderationEnabled - moderationKnownReactions pagination: type: object properties: limit: type: integer hasNext: type: boolean hasPrevious: type: boolean startCursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` endCursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` count: type: integer minimum: 0 required: - limit - hasNext - hasPrevious - count results: type: array items: type: object properties: *ref_4 required: *ref_5 required: - extra - pagination - results required: - app - author - id - channelId - commentType - content - chainId - deletedAt - logIndex - metadata - hookMetadata - parentId - targetUri - txHash - cursor - moderationStatus - moderationStatusChangedAt - moderationClassifierResult - moderationClassifierScore - createdAt - updatedAt - revision - zeroExSwap - references - path - viewerReactions - reactionCounts - replies description: >- The comment that has been created by the author. This comment triggered the notification. required: - type - mentionedUser - id - createdAt - seen - seenAt - app - author - comment - type: object properties: type: type: string enum: - reaction reactingTo: type: object properties: app: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` author: type: object properties: address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` ens: type: object properties: name: type: string avatarUrl: type: - string - 'null' required: - name - avatarUrl farcaster: type: object properties: fid: type: integer pfpUrl: type: string displayName: type: string username: type: string required: - fid - username required: - address id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` channelId: type: string pattern: ^d+$ commentType: type: integer minimum: 0 maximum: 255 content: type: string chainId: type: integer deletedAt: type: - string - 'null' logIndex: type: - integer - 'null' metadata: type: array items: type: object properties: key: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` value: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - key - value hookMetadata: type: array items: type: object properties: key: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` value: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - key - value parentId: type: - string - 'null' description: >- Hex format string, e.g. `0x1234567890abcdef` targetUri: type: string txHash: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` cursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` moderationStatus: type: string enum: *ref_3 moderationStatusChangedAt: type: - string - 'null' moderationClassifierResult: type: object additionalProperties: type: number minimum: 0 maximum: 1 moderationClassifierScore: type: number minimum: 0 maximum: 1 createdAt: type: - string - 'null' updatedAt: type: - string - 'null' revision: type: integer zeroExSwap: type: - object - 'null' properties: from: type: object properties: address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` amount: type: string pattern: ^\d+(\.\d+)?$ symbol: type: string required: - address - amount - symbol to: type: object properties: address: anyOf: - type: string description: >- Hex format string, e.g. `0x1234567890abcdef` - type: string enum: - '' description: >- Hex format string, e.g. `0x1234567890abcdef` amount: anyOf: - type: string pattern: ^\d+(\.\d+)?$ - type: string enum: - '' symbol: type: string required: - address - amount - symbol required: - from - to references: type: array items: anyOf: - type: object properties: type: type: string enum: - ens avatarUrl: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - avatarUrl - name - address - position - url - type: object properties: type: type: string enum: - erc20 symbol: type: string logoURI: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` decimals: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end chainId: type: - integer - 'null' exclusiveMinimum: 0 chains: type: array items: type: object properties: caip: type: string chainId: type: integer exclusiveMinimum: 0 required: - caip - chainId required: - type - symbol - logoURI - name - address - decimals - position - chainId - chains - type: object properties: type: type: string enum: - farcaster address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` fid: type: integer fname: type: string username: type: string displayName: type: - string - 'null' pfpUrl: type: - string - 'null' position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - address - fid - fname - username - displayName - pfpUrl - position - url - type: object properties: type: type: string enum: - webpage url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end title: type: string description: type: - string - 'null' favicon: type: - string - 'null' format: uri opengraph: type: - object - 'null' properties: title: type: string description: type: - string - 'null' image: type: string format: uri url: type: string format: uri required: - title - description - image - url mediaType: type: string required: - type - url - position - title - description - favicon - opengraph - mediaType - type: object properties: type: type: string enum: - file url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string required: - type - url - position - mediaType - type: object properties: type: type: string enum: - image url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height required: - type - url - position - mediaType - type: object properties: type: type: string enum: - video url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string videoTracks: type: array items: type: object properties: dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height codec: type: string required: - dimension required: - type - url - position - mediaType - type: object properties: type: type: string enum: - quoted_comment id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` chainId: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end required: - type - id - chainId - position - {} - type: 'null' path: type: string viewerReactions: type: object additionalProperties: type: array items: type: object properties: *ref_11 required: *ref_12 reactionCounts: type: object additionalProperties: type: number replies: type: object properties: extra: type: object properties: moderationEnabled: type: boolean moderationKnownReactions: type: array items: type: string required: - moderationEnabled - moderationKnownReactions pagination: type: object properties: limit: type: integer hasNext: type: boolean hasPrevious: type: boolean startCursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` endCursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` count: type: integer minimum: 0 required: - limit - hasNext - hasPrevious - count results: type: array items: type: object properties: *ref_4 required: *ref_5 required: - extra - pagination - results required: - app - author - id - channelId - commentType - content - chainId - deletedAt - logIndex - metadata - hookMetadata - parentId - targetUri - txHash - cursor - moderationStatus - moderationStatusChangedAt - moderationClassifierResult - moderationClassifierScore - createdAt - updatedAt - revision - zeroExSwap - references - path - viewerReactions - reactionCounts - replies id: type: string description: A bigint string createdAt: type: string description: A date string in ISO 8601 format seen: type: boolean seenAt: type: string description: A date string in ISO 8601 format app: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` pattern: ^0x[a-fA-F0-9]+$ author: type: object properties: address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` ens: type: object properties: name: type: string avatarUrl: type: - string - 'null' required: - name - avatarUrl farcaster: type: object properties: fid: type: integer pfpUrl: type: string displayName: type: string username: type: string required: - fid - username required: - address comment: type: object properties: app: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` author: type: object properties: address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` ens: type: object properties: name: type: string avatarUrl: type: - string - 'null' required: - name - avatarUrl farcaster: type: object properties: fid: type: integer pfpUrl: type: string displayName: type: string username: type: string required: - fid - username required: - address id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` channelId: type: string pattern: ^d+$ commentType: type: integer minimum: 0 maximum: 255 content: type: string chainId: type: integer deletedAt: type: - string - 'null' logIndex: type: - integer - 'null' metadata: type: array items: type: object properties: key: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` value: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - key - value hookMetadata: type: array items: type: object properties: key: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` value: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - key - value parentId: type: - string - 'null' description: >- Hex format string, e.g. `0x1234567890abcdef` targetUri: type: string txHash: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` cursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` moderationStatus: type: string enum: *ref_3 moderationStatusChangedAt: type: - string - 'null' moderationClassifierResult: type: object additionalProperties: type: number minimum: 0 maximum: 1 moderationClassifierScore: type: number minimum: 0 maximum: 1 createdAt: type: - string - 'null' updatedAt: type: - string - 'null' revision: type: integer zeroExSwap: type: - object - 'null' properties: from: type: object properties: address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` amount: type: string pattern: ^\d+(\.\d+)?$ symbol: type: string required: - address - amount - symbol to: type: object properties: address: anyOf: - type: string description: >- Hex format string, e.g. `0x1234567890abcdef` - type: string enum: - '' description: >- Hex format string, e.g. `0x1234567890abcdef` amount: anyOf: - type: string pattern: ^\d+(\.\d+)?$ - type: string enum: - '' symbol: type: string required: - address - amount - symbol required: - from - to references: type: array items: anyOf: - type: object properties: type: type: string enum: - ens avatarUrl: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - avatarUrl - name - address - position - url - type: object properties: type: type: string enum: - erc20 symbol: type: string logoURI: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` decimals: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end chainId: type: - integer - 'null' exclusiveMinimum: 0 chains: type: array items: type: object properties: caip: type: string chainId: type: integer exclusiveMinimum: 0 required: - caip - chainId required: - type - symbol - logoURI - name - address - decimals - position - chainId - chains - type: object properties: type: type: string enum: - farcaster address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` fid: type: integer fname: type: string username: type: string displayName: type: - string - 'null' pfpUrl: type: - string - 'null' position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - address - fid - fname - username - displayName - pfpUrl - position - url - type: object properties: type: type: string enum: - webpage url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end title: type: string description: type: - string - 'null' favicon: type: - string - 'null' format: uri opengraph: type: - object - 'null' properties: title: type: string description: type: - string - 'null' image: type: string format: uri url: type: string format: uri required: - title - description - image - url mediaType: type: string required: - type - url - position - title - description - favicon - opengraph - mediaType - type: object properties: type: type: string enum: - file url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string required: - type - url - position - mediaType - type: object properties: type: type: string enum: - image url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height required: - type - url - position - mediaType - type: object properties: type: type: string enum: - video url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string videoTracks: type: array items: type: object properties: dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height codec: type: string required: - dimension required: - type - url - position - mediaType - type: object properties: type: type: string enum: - quoted_comment id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` chainId: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end required: - type - id - chainId - position - {} - type: 'null' path: type: string viewerReactions: type: object additionalProperties: type: array items: type: object properties: *ref_11 required: *ref_12 reactionCounts: type: object additionalProperties: type: number replies: type: object properties: extra: type: object properties: moderationEnabled: type: boolean moderationKnownReactions: type: array items: type: string required: - moderationEnabled - moderationKnownReactions pagination: type: object properties: limit: type: integer hasNext: type: boolean hasPrevious: type: boolean startCursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` endCursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` count: type: integer minimum: 0 required: - limit - hasNext - hasPrevious - count results: type: array items: type: object properties: *ref_4 required: *ref_5 required: - extra - pagination - results required: - app - author - id - channelId - commentType - content - chainId - deletedAt - logIndex - metadata - hookMetadata - parentId - targetUri - txHash - cursor - moderationStatus - moderationStatusChangedAt - moderationClassifierResult - moderationClassifierScore - createdAt - updatedAt - revision - zeroExSwap - references - path - viewerReactions - reactionCounts - replies description: >- The comment that has been created by the author. This comment triggered the notification. required: - type - reactingTo - id - createdAt - seen - seenAt - app - author - comment - type: object properties: type: type: string enum: - quote quotedComment: type: object properties: app: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` author: type: object properties: address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` ens: type: object properties: name: type: string avatarUrl: type: - string - 'null' required: - name - avatarUrl farcaster: type: object properties: fid: type: integer pfpUrl: type: string displayName: type: string username: type: string required: - fid - username required: - address id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` channelId: type: string pattern: ^d+$ commentType: type: integer minimum: 0 maximum: 255 content: type: string chainId: type: integer deletedAt: type: - string - 'null' logIndex: type: - integer - 'null' metadata: type: array items: type: object properties: key: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` value: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - key - value hookMetadata: type: array items: type: object properties: key: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` value: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - key - value parentId: type: - string - 'null' description: >- Hex format string, e.g. `0x1234567890abcdef` targetUri: type: string txHash: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` cursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` moderationStatus: type: string enum: *ref_3 moderationStatusChangedAt: type: - string - 'null' moderationClassifierResult: type: object additionalProperties: type: number minimum: 0 maximum: 1 moderationClassifierScore: type: number minimum: 0 maximum: 1 createdAt: type: - string - 'null' updatedAt: type: - string - 'null' revision: type: integer zeroExSwap: type: - object - 'null' properties: from: type: object properties: address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` amount: type: string pattern: ^\d+(\.\d+)?$ symbol: type: string required: - address - amount - symbol to: type: object properties: address: anyOf: - type: string description: >- Hex format string, e.g. `0x1234567890abcdef` - type: string enum: - '' description: >- Hex format string, e.g. `0x1234567890abcdef` amount: anyOf: - type: string pattern: ^\d+(\.\d+)?$ - type: string enum: - '' symbol: type: string required: - address - amount - symbol required: - from - to references: type: array items: anyOf: - type: object properties: type: type: string enum: - ens avatarUrl: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - avatarUrl - name - address - position - url - type: object properties: type: type: string enum: - erc20 symbol: type: string logoURI: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` decimals: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end chainId: type: - integer - 'null' exclusiveMinimum: 0 chains: type: array items: type: object properties: caip: type: string chainId: type: integer exclusiveMinimum: 0 required: - caip - chainId required: - type - symbol - logoURI - name - address - decimals - position - chainId - chains - type: object properties: type: type: string enum: - farcaster address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` fid: type: integer fname: type: string username: type: string displayName: type: - string - 'null' pfpUrl: type: - string - 'null' position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - address - fid - fname - username - displayName - pfpUrl - position - url - type: object properties: type: type: string enum: - webpage url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end title: type: string description: type: - string - 'null' favicon: type: - string - 'null' format: uri opengraph: type: - object - 'null' properties: title: type: string description: type: - string - 'null' image: type: string format: uri url: type: string format: uri required: - title - description - image - url mediaType: type: string required: - type - url - position - title - description - favicon - opengraph - mediaType - type: object properties: type: type: string enum: - file url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string required: - type - url - position - mediaType - type: object properties: type: type: string enum: - image url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height required: - type - url - position - mediaType - type: object properties: type: type: string enum: - video url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string videoTracks: type: array items: type: object properties: dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height codec: type: string required: - dimension required: - type - url - position - mediaType - type: object properties: type: type: string enum: - quoted_comment id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` chainId: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end required: - type - id - chainId - position - {} - type: 'null' path: type: string viewerReactions: type: object additionalProperties: type: array items: type: object properties: *ref_11 required: *ref_12 reactionCounts: type: object additionalProperties: type: number replies: type: object properties: extra: type: object properties: moderationEnabled: type: boolean moderationKnownReactions: type: array items: type: string required: - moderationEnabled - moderationKnownReactions pagination: type: object properties: limit: type: integer hasNext: type: boolean hasPrevious: type: boolean startCursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` endCursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` count: type: integer minimum: 0 required: - limit - hasNext - hasPrevious - count results: type: array items: type: object properties: *ref_4 required: *ref_5 required: - extra - pagination - results required: - app - author - id - channelId - commentType - content - chainId - deletedAt - logIndex - metadata - hookMetadata - parentId - targetUri - txHash - cursor - moderationStatus - moderationStatusChangedAt - moderationClassifierResult - moderationClassifierScore - createdAt - updatedAt - revision - zeroExSwap - references - path - viewerReactions - reactionCounts - replies id: type: string description: A bigint string createdAt: type: string description: A date string in ISO 8601 format seen: type: boolean seenAt: type: string description: A date string in ISO 8601 format app: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` pattern: ^0x[a-fA-F0-9]+$ author: type: object properties: address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` ens: type: object properties: name: type: string avatarUrl: type: - string - 'null' required: - name - avatarUrl farcaster: type: object properties: fid: type: integer pfpUrl: type: string displayName: type: string username: type: string required: - fid - username required: - address comment: type: object properties: app: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` author: type: object properties: address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` ens: type: object properties: name: type: string avatarUrl: type: - string - 'null' required: - name - avatarUrl farcaster: type: object properties: fid: type: integer pfpUrl: type: string displayName: type: string username: type: string required: - fid - username required: - address id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` channelId: type: string pattern: ^d+$ commentType: type: integer minimum: 0 maximum: 255 content: type: string chainId: type: integer deletedAt: type: - string - 'null' logIndex: type: - integer - 'null' metadata: type: array items: type: object properties: key: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` value: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - key - value hookMetadata: type: array items: type: object properties: key: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` value: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` required: - key - value parentId: type: - string - 'null' description: >- Hex format string, e.g. `0x1234567890abcdef` targetUri: type: string txHash: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` cursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` moderationStatus: type: string enum: *ref_3 moderationStatusChangedAt: type: - string - 'null' moderationClassifierResult: type: object additionalProperties: type: number minimum: 0 maximum: 1 moderationClassifierScore: type: number minimum: 0 maximum: 1 createdAt: type: - string - 'null' updatedAt: type: - string - 'null' revision: type: integer zeroExSwap: type: - object - 'null' properties: from: type: object properties: address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` amount: type: string pattern: ^\d+(\.\d+)?$ symbol: type: string required: - address - amount - symbol to: type: object properties: address: anyOf: - type: string description: >- Hex format string, e.g. `0x1234567890abcdef` - type: string enum: - '' description: >- Hex format string, e.g. `0x1234567890abcdef` amount: anyOf: - type: string pattern: ^\d+(\.\d+)?$ - type: string enum: - '' symbol: type: string required: - address - amount - symbol required: - from - to references: type: array items: anyOf: - type: object properties: type: type: string enum: - ens avatarUrl: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - avatarUrl - name - address - position - url - type: object properties: type: type: string enum: - erc20 symbol: type: string logoURI: type: - string - 'null' name: type: string address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` decimals: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end chainId: type: - integer - 'null' exclusiveMinimum: 0 chains: type: array items: type: object properties: caip: type: string chainId: type: integer exclusiveMinimum: 0 required: - caip - chainId required: - type - symbol - logoURI - name - address - decimals - position - chainId - chains - type: object properties: type: type: string enum: - farcaster address: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` fid: type: integer fname: type: string username: type: string displayName: type: - string - 'null' pfpUrl: type: - string - 'null' position: type: object properties: start: type: integer end: type: integer required: - start - end url: type: string format: uri required: - type - address - fid - fname - username - displayName - pfpUrl - position - url - type: object properties: type: type: string enum: - webpage url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end title: type: string description: type: - string - 'null' favicon: type: - string - 'null' format: uri opengraph: type: - object - 'null' properties: title: type: string description: type: - string - 'null' image: type: string format: uri url: type: string format: uri required: - title - description - image - url mediaType: type: string required: - type - url - position - title - description - favicon - opengraph - mediaType - type: object properties: type: type: string enum: - file url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string required: - type - url - position - mediaType - type: object properties: type: type: string enum: - image url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height required: - type - url - position - mediaType - type: object properties: type: type: string enum: - video url: type: string format: uri position: type: object properties: start: type: integer end: type: integer required: - start - end mediaType: type: string videoTracks: type: array items: type: object properties: dimension: type: object properties: width: type: integer minimum: 0 height: type: integer minimum: 0 required: - width - height codec: type: string required: - dimension required: - type - url - position - mediaType - type: object properties: type: type: string enum: - quoted_comment id: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` chainId: type: integer position: type: object properties: start: type: integer end: type: integer required: - start - end required: - type - id - chainId - position - {} - type: 'null' path: type: string viewerReactions: type: object additionalProperties: type: array items: type: object properties: *ref_11 required: *ref_12 reactionCounts: type: object additionalProperties: type: number replies: type: object properties: extra: type: object properties: moderationEnabled: type: boolean moderationKnownReactions: type: array items: type: string required: - moderationEnabled - moderationKnownReactions pagination: type: object properties: limit: type: integer hasNext: type: boolean hasPrevious: type: boolean startCursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` endCursor: type: string description: >- Hex format string, e.g. `0x1234567890abcdef` count: type: integer minimum: 0 required: - limit - hasNext - hasPrevious - count results: type: array items: type: object properties: *ref_4 required: *ref_5 required: - extra - pagination - results required: - app - author - id - channelId - commentType - content - chainId - deletedAt - logIndex - metadata - hookMetadata - parentId - targetUri - txHash - cursor - moderationStatus - moderationStatusChangedAt - moderationClassifierResult - moderationClassifierScore - createdAt - updatedAt - revision - zeroExSwap - references - path - viewerReactions - reactionCounts - replies description: >- The comment that has been created by the author. This comment triggered the notification. required: - type - quotedComment - id - createdAt - seen - seenAt - app - author - comment required: - cursor - notification pageInfo: type: object properties: hasNextPage: type: boolean description: Whether there are older notifications hasPreviousPage: type: boolean description: Whether there are newer notifications startCursor: type: object properties: id: type: string description: A bigint string required: - id description: The cursor to the first notification endCursor: type: object properties: id: type: string description: A bigint string required: - id description: The cursor to the last notification required: - hasNextPage - hasPreviousPage extra: type: object properties: unseenCount: type: string description: The number of unseen notification groups required: - unseenCount required: - notifications - pageInfo - extra required: - cursor - groupedBy - notifications pageInfo: type: object properties: hasNextPage: type: boolean description: Whether there are older notifications hasPreviousPage: type: boolean description: Whether there are newer notifications startCursor: type: object properties: us: type: string description: A bigint string id: type: string description: A bigint string required: - us - id description: The cursor to the first notification endCursor: type: object properties: us: type: string description: A bigint string id: type: string description: A bigint string required: - us - id description: The cursor to the last notification required: - hasNextPage - hasPreviousPage extra: type: object properties: unseenCount: type: string description: The number of unseen notification groups required: - unseenCount required: - notifications - pageInfo - extra '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '404': description: App not found content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' /api/internal/metrics: get: tags: - internal - metrics description: Get the internal metrics responses: '200': description: The internal metrics content: text/plain: schema: type: string /api/channels/volume: get: tags: - channels - volume description: Get channels ranked by economic volume over a time window parameters: - schema: type: integer minimum: 1 maximum: 100 default: 50 description: Number of channels per page example: 50 required: false name: limit in: query - schema: type: integer minimum: 1 default: 1 description: Page number example: 1 required: false name: page in: query - schema: type: integer minimum: 1 maximum: 168 default: 24 description: Lookback window in hours example: 24 required: false name: hours in: query responses: '200': description: Channels ranked by economic volume content: application/json: schema: type: object properties: results: type: array items: type: object properties: channelId: type: string pattern: ^\d+$ description: On-chain channel identifier (uint256) example: '42' txCount: type: integer minimum: 0 description: >- Number of transactions (CommentAdded + CommentEdited + CommentDeleted) in the time window example: 142 gasTotal: type: string pattern: ^\d+$ description: >- Sum of gas costs in wei (gasUsed * effectiveGasPrice per transaction) example: '892340000000000' valueTotal: type: string pattern: ^\d+$ description: >- Sum of native ETH sent via msg.value in wei (does not include ERC-20 hook fees) example: '892340000000000' volumeTotal: type: string pattern: ^\d+$ description: gasTotal + valueTotal in wei example: '892340000000000' required: - channelId - txCount - gasTotal - valueTotal - volumeTotal pagination: type: object properties: page: type: integer minimum: 1 example: 1 limit: type: integer minimum: 1 maximum: 100 example: 50 totalCount: type: integer minimum: 0 description: >- Total number of distinct channels with activity in the time window example: 230 totalPages: type: integer minimum: 0 example: 5 hasNext: type: boolean hasPrevious: type: boolean required: - page - limit - totalCount - totalPages - hasNext - hasPrevious required: - results - pagination '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' /api/channels/{channelId}/volume: get: tags: - channels - volume description: Get economic volume for a single channel over a time window parameters: - schema: type: string pattern: ^d+$ description: The ID of the channel required: true name: channelId in: path - schema: type: integer minimum: 1 maximum: 168 default: 24 description: Lookback window in hours example: 24 required: false name: hours in: query responses: '200': description: Channel volume data content: application/json: schema: type: object properties: channelId: type: string pattern: ^\d+$ description: On-chain channel identifier (uint256) example: '42' txCount: type: integer minimum: 0 description: >- Number of transactions (CommentAdded + CommentEdited + CommentDeleted) in the time window example: 142 gasTotal: type: string pattern: ^\d+$ description: >- Sum of gas costs in wei (gasUsed * effectiveGasPrice per transaction) example: '892340000000000' valueTotal: type: string pattern: ^\d+$ description: >- Sum of native ETH sent via msg.value in wei (does not include ERC-20 hook fees) example: '892340000000000' volumeTotal: type: string pattern: ^\d+$ description: gasTotal + valueTotal in wei example: '892340000000000' required: - channelId - txCount - gasTotal - valueTotal - volumeTotal '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIBadRequestResponse' '404': description: Channel not found content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' webhooks: {}