> ## Documentation Index
> Fetch the complete documentation index at: https://docs.synci.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Search securities

> Listed equities, ETFs and funds the price source can value, from Synci's mirrored catalogue, matched on name,
symbol or ISIN. `priced` is true only for a security Synci already holds a close for; an unverified result is
verified when a position in it is added, and refused if the provider returns no price. `country_code` and
`exchange_mic` narrow the matches to a listing country (the exchange's, ISO alpha-2) or venue (ISO 10383 MIC)
before ranking and the limit. Funds have neither (their exchange is a registration artefact, both are null on
their rows), so either filter leaves them out. `meta.total` and `meta.has_more` describe the filtered matches;
`meta.facets` lists every country and exchange among the unfiltered matches with counts, each exchange with its
`country_code`, and `no_venue` counts matches with no listing venue.



## OpenAPI

````yaml /openapi/v1.json get /finance/securities/search
openapi: 3.2.0
info:
  title: Synci
  version: '1.0'
  description: >-
    Synci is a platform for integrating financial accounts with your favorite
    apps.
servers:
  - url: https://api.synci.io/api/v1
security:
  - oauth2: []
  - http: []
tags:
  - name: Finance
    kind: nav
  - name: Connections
    parent: Finance
  - name: Accounts
    parent: Finance
  - name: Transactions
    parent: Finance
  - name: Institutions
    parent: Finance
  - name: Destinations
    kind: nav
  - name: YNAB
    parent: Destinations
  - name: Lunch Money
    parent: Destinations
  - name: Google Sheets
    parent: Destinations
  - name: SimpleFIN
    parent: Destinations
  - name: Notion
    parent: Destinations
  - name: Account
    kind: nav
  - name: Webhooks
    parent: Account
  - name: User
    parent: Account
  - name: rule-engine
    summary: Rules
    kind: nav
  - name: Rules
    parent: rule-engine
  - name: Rule Logs
    parent: rule-engine
  - name: Transfers
    kind: nav
  - name: Transfer Links
    parent: Transfers
  - name: Transfer Logs
    parent: Transfers
paths:
  /finance/securities/search:
    get:
      tags:
        - Investments
      summary: Search securities
      description: >-
        Listed equities, ETFs and funds the price source can value, from Synci's
        mirrored catalogue, matched on name,

        symbol or ISIN. `priced` is true only for a security Synci already holds
        a close for; an unverified result is

        verified when a position in it is added, and refused if the provider
        returns no price. `country_code` and

        `exchange_mic` narrow the matches to a listing country (the exchange's,
        ISO alpha-2) or venue (ISO 10383 MIC)

        before ranking and the limit. Funds have neither (their exchange is a
        registration artefact, both are null on

        their rows), so either filter leaves them out. `meta.total` and
        `meta.has_more` describe the filtered matches;

        `meta.facets` lists every country and exchange among the unfiltered
        matches with counts, each exchange with its

        `country_code`, and `no_venue` counts matches with no listing venue.
      operationId: securities.search
      parameters:
        - name: q
          in: query
          required: true
          description: A name, ticker or ISIN fragment, at least two characters.
          schema:
            type: string
            minLength: 2
            maxLength: 64
        - name: limit
          in: query
          description: At most this many results. Defaults to 20, never more than 50.
          schema:
            type:
              - integer
              - 'null'
            minimum: 1
            maximum: 50
        - name: country_code
          in: query
          description: >-
            Listing country (ISO alpha-2, the exchange's country). Funds have
            none and are left out.
          schema:
            type:
              - string
              - 'null'
            minLength: 2
            maxLength: 2
        - name: exchange_mic
          in: query
          description: >-
            Listing venue (ISO 10383 MIC, as `exchange_mic` on results and in
            `meta.facets.exchanges`).
          schema:
            type:
              - string
              - 'null'
            minLength: 3
            maxLength: 8
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        provider:
                          type: string
                          const: MARKETSTACK
                        provider_symbol:
                          type: string
                        name:
                          type: string
                        type:
                          type: string
                          enum:
                            - EQUITY
                            - ETF
                            - FUND
                            - OTHER
                        currency:
                          type:
                            - string
                            - 'null'
                        exchange_mic:
                          type:
                            - string
                            - 'null'
                          description: >-
                            A fund's exchange is a registration-market artefact,
                            not a venue: no venue, no listing country.
                        exchange_name:
                          type:
                            - string
                            - 'null'
                        country_code:
                          type:
                            - string
                            - 'null'
                        priced:
                          type: boolean
                          description: >-
                            A close is held and recent enough to value with
                            (ACTIVE or STALE); UNVERIFIED rows are checked on
                            add.
                        price_status:
                          type: string
                          enum:
                            - UNVERIFIED
                            - ACTIVE
                            - STALE
                            - UNAVAILABLE
                        last_price_at:
                          type:
                            - string
                            - 'null'
                      required:
                        - id
                        - provider
                        - provider_symbol
                        - name
                        - type
                        - currency
                        - exchange_mic
                        - exchange_name
                        - country_code
                        - priced
                        - price_status
                        - last_price_at
                  meta:
                    type: object
                    properties:
                      total:
                        type: integer
                        const: 0
                      has_more:
                        type: boolean
                      limit:
                        type: integer
                      facets:
                        type: object
                        properties:
                          countries:
                            type: array
                            items: {}
                          exchanges:
                            type: array
                            items: {}
                          no_venue:
                            type: integer
                            const: 0
                        required:
                          - countries
                          - exchanges
                          - no_venue
                    required:
                      - total
                      - has_more
                      - limit
                      - facets
                required:
                  - data
                  - meta
        '401':
          $ref: '#/components/responses/AuthenticationException'
        '403':
          $ref: '#/components/responses/AuthorizationException'
        '422':
          $ref: '#/components/responses/ValidationException'
components:
  responses:
    AuthenticationException:
      description: Unauthenticated
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Error overview.
            required:
              - message
    AuthorizationException:
      description: Authorization error
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Error overview.
            required:
              - message
    ValidationException:
      description: Validation error
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Errors overview.
              errors:
                type: object
                description: A detailed description of each field that failed validation.
                additionalProperties:
                  type: array
                  items:
                    type: string
            required:
              - message
              - errors
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://api.synci.io/oauth/authorize
          tokenUrl: https://api.synci.io/oauth/token
          scopes:
            profile:read: View your name, email, and profile details
            accounts:read: View your connected financial accounts and balances
            accounts:write: >-
              Update, sync, and remove your financial accounts, and change their
              settings
            transactions:read: View your transactions
            transactions:write: Create, update, and delete your transactions
            sensitive:read: >-
              See sensitive identifiers like account numbers and account holder
              names
            transfer-links:read: View your transfer links and their transfer history
            transfer-links:write: Create, update, and delete transfer links, and undo transfers
            rules:read: View your rules and rule activity
            rules:write: Create, update, and delete rules, and undo rule actions
            webhooks:read: View your webhook endpoints
            webhooks:write: >-
              Create, update, and delete webhook endpoints, and rotate their
              secrets
            destinations:read: View your connected destinations
            destinations:write: Connect, update, and remove destinations
            financial-connections:read: View your connected institutions
            financial-connections:write: Manage your connected institutions
    http:
      type: http
      description: Bearer token (personal access token or OAuth access token)
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.