Zora TrendsByName API

The TrendsByName API from Zora — 1 operation(s) for trendsbyname.

OpenAPI Specification

zora-trendsbyname-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Zora SDK ApiKey TrendsByName API
  description: Access to Zora data for SDK users
  version: 1.0.0
servers:
- url: https://api-sdk.zora.engineering/
  description: SDK API Production Server
- url: https://api-sdk-staging.zora.engineering/
  description: SDK API Staging Server
- url: http://localhost:8787/
  description: SDK API Local Server
security:
- apiKey: []
tags:
- name: TrendsByName
paths:
  /trendsByName:
    get:
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  trendsByName:
                    type: object
                    properties:
                      pageInfo:
                        type: object
                        properties:
                          hasNextPage:
                            type: boolean
                            nullable: false
                            description: When paginating forwards, are there more items?
                          startCursor:
                            type: string
                            nullable: true
                            description: When paginating backwards, the cursor to continue.
                          endCursor:
                            type: string
                            nullable: true
                            description: When paginating forwards, the cursor to continue.
                        required:
                        - hasNextPage
                        nullable: false
                      count:
                        type: integer
                        nullable: false
                        description: The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
                      edges:
                        type: array
                        items:
                          type: object
                          properties:
                            node:
                              type: object
                              properties:
                                id:
                                  type: string
                                  nullable: false
                                  description: The Globally Unique ID of this object
                                platformBlocked:
                                  type: boolean
                                  nullable: false
                                  description: The `Boolean` scalar type represents `true` or `false`.
                                name:
                                  type: string
                                  nullable: false
                                  description: The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
                                description:
                                  type: string
                                  nullable: false
                                  description: The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
                                address:
                                  type: string
                                  nullable: false
                                coinType:
                                  type: string
                                  enum:
                                  - CREATOR
                                  - CONTENT
                                  - TREND
                                  nullable: false
                                symbol:
                                  type: string
                                  nullable: false
                                  description: The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
                                totalSupply:
                                  type: string
                                  nullable: false
                                  description: The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
                                totalVolume:
                                  type: string
                                  nullable: false
                                  description: The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
                                volume24h:
                                  type: string
                                  nullable: false
                                  description: The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
                                createdAt:
                                  type: string
                                  nullable: true
                                  description: Date with time (isoformat)
                                creatorAddress:
                                  type: string
                                  nullable: true
                                poolCurrencyToken:
                                  type: object
                                  properties:
                                    address:
                                      type: string
                                      nullable: true
                                      description: The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
                                    name:
                                      type: string
                                      nullable: true
                                      description: The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
                                    decimals:
                                      type: integer
                                      nullable: true
                                      description: The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
                                  nullable: true
                                tokenPrice:
                                  type: object
                                  properties:
                                    priceInUsdc:
                                      type: string
                                      nullable: true
                                      description: Price of the pool in respect to USDC, not always available
                                    currencyAddress:
                                      type: string
                                      nullable: false
                                      description: Ethereum address of the currency
                                    priceInPoolToken:
                                      type: string
                                      nullable: false
                                      description: Price against the native token of the primary currency pool
                                  required:
                                  - currencyAddress
                                  - priceInPoolToken
                                  nullable: true
                                marketCap:
                                  type: string
                                  nullable: false
                                  description: The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
                                marketCapDelta24h:
                                  type: string
                                  nullable: false
                                  description: The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
                                chainId:
                                  type: integer
                                  nullable: false
                                  description: The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
                                tokenUri:
                                  type: string
                                  nullable: true
                                  description: The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
                                platformReferrerAddress:
                                  type: string
                                  nullable: true
                                payoutRecipientAddress:
                                  type: string
                                  nullable: true
                                creatorProfile:
                                  type: object
                                  properties:
                                    id:
                                      type: string
                                      nullable: false
                                      description: The Globally Unique ID of this object
                                    handle:
                                      type: string
                                      nullable: false
                                      description: Manually set username, or truncated wallet address if the profile isn't a GraphQLAccountProfile. For full wallet address, use the profile_id field instead.
                                    platformBlocked:
                                      type: boolean
                                      nullable: false
                                      description: The `Boolean` scalar type represents `true` or `false`.
                                    avatar:
                                      type: object
                                      properties:
                                        previewImage:
                                          type: object
                                          properties:
                                            blurhash:
                                              type: string
                                              nullable: true
                                              description: The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
                                            medium:
                                              type: string
                                              nullable: false
                                              description: The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
                                            small:
                                              type: string
                                              nullable: false
                                              description: The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
                                          required:
                                          - medium
                                          - small
                                          nullable: false
                                      required:
                                      - previewImage
                                      nullable: true
                                    socialAccounts:
                                      type: object
                                      properties:
                                        instagram:
                                          type: object
                                          properties:
                                            username:
                                              type: string
                                              nullable: true
                                              description: The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
                                            displayName:
                                              type: string
                                              nullable: true
                                              description: The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
                                            followerCount:
                                              type: integer
                                              nullable: true
                                              description: The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
                                            id:
                                              type: string
                                              nullable: true
                                              description: The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
                                          nullable: true
                                        tiktok:
                                          type: object
                                          properties:
                                            username:
                                              type: string
                                              nullable: true
                                              description: The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
                                            displayName:
                                              type: string
                                              nullable: true
                                              description: The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
                                            followerCount:
                                              type: integer
                                              nullable: true
                                              description: The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
                                            id:
                                              type: string
                                              nullable: true
                                              description: The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
                                          nullable: true
                                        twitter:
                                          type: object
                                          properties:
                                            username:
                                              type: string
                                              nullable: true
                                              description: The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
                                            displayName:
                                              type: string
                                              nullable: true
                                              description: The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
                                            followerCount:
                                              type: integer
                                              nullable: true
                                              description: The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
                                            id:
                                              type: string
                                              nullable: true
                                              description: The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
                                          nullable: true
                                        farcaster:
                                          type: object
                                          properties:
                                            username:
                                              type: string
                                              nullable: true
                                              description: The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
                                            displayName:
                                              type: string
                                              nullable: true
                                              description: The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
                                            followerCount:
                                              type: integer
                                              nullable: true
                                              description: The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
                                            id:
                                              type: string
                                              nullable: true
                                              description: The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
                                          nullable: true
                                      nullable: false
                                    creatorCoin:
                                      type: object
                                      properties:
                                        address:
                                          type: string
                                          nullable: false
                                      required:
                                      - address
                                      nullable: true
                                  required:
                                  - id
                                  - handle
                                  - platformBlocked
                                  - socialAccounts
                                  nullable: true
                                mediaContent:
                                  type: object
                                  properties:
                                    mimeType:
                                      type: string
                                      nullable: true
                                      description: The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
                                    originalUri:
                                      type: string
                                      nullable: false
                                      description: The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
                                    previewImage:
                                      type: object
                                      properties:
                                        small:
                                          type: string
                                          nullable: false
                                          description: The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
                                        medium:
                                          type: string
                                          nullable: false
                                          description: The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
                                        blurhash:
                                          type: string
                                          nullable: true
                                          description: The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
                                      required:
                                      - small
                                      - medium
                                      nullable: true
                                    videoPreviewUrl:
                                      type: string
                                      nullable: true
                                      description: The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
                                    videoHlsUrl:
                                      type: string
                                      nullable: true
                                      description: The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
                                  required:
                                  - originalUri
                                  nullable: true
                                uniqueHolders:
                                  type: integer
                                  nullable: false
                                  description: The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
                                uniswapV4PoolKey:
                                  type: object
                                  properties:
                                    token0Address:
                                      type: string
                                      nullable: false
                                    token1Address:
                                      type: string
                                      nullable: false
                                    fee:
                                      type: integer
                                      nullable: false
                                      description: The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
                                    tickSpacing:
                                      type: integer
                                      nullable: false
                                      description: The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
                                    hookAddress:
                                      type: string
                                      nullable: false
                                  required:
                                  - token0Address
                                  - token1Address
                                  - fee
                                  - tickSpacing
                                  - hookAddress
                                  nullable: false
                                uniswapV3PoolAddress:
                                  type: string
                                  nullable: false
                              required:
                              - id
                              - platformBlocked
                              - name
                              - description
                              - address
                              - coinType
                              - symbol
                              - totalSupply
                              - totalVolume
                              - volume24h
                              - marketCap
                              - marketCapDelta24h
                              - chainId
                              - uniqueHolders
                              - uniswapV4PoolKey
                              - uniswapV3PoolAddress
                              nullable: false
                            cursor:
                              type: string
                              nullable: false
                              description: The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
                          required:
                          - node
                          - cursor
                        nullable: false
                    required:
                    - pageInfo
                    - count
                    - edges
                    nullable: false
                required:
                - trendsByName
        '400':
          description: Bad request
        '500':
          description: Internal server error
      operationId: GetTrendsByName
      parameters:
      - name: name
        in: query
        schema:
          type: string
          nullable: false
        required: true
      - name: first
        in: query
        schema:
          type: integer
          nullable: false
          default: 10
        required: false
      - name: after
        in: query
        schema:
          type: string
          nullable: true
        required: false
      summary: zoraSDK_trendsByName query
      tags:
      - TrendsByName
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: api-key