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

# Get Cdr Suppliers



## OpenAPI

````yaml https://api.alliedoffsets.com/v2/openapi.json get /cdr/suppliers
openapi: 3.1.0
info:
  title: API Documentation
  description: >

    ## Pagination and Data Format


    ### 1. Pagination

    Our API uses **cursor-based pagination** for all endpoints. To retrieve the
    next page of results for a given endpoint, use the `cursor` value provided
    in the response of the previous request.


    ### 2. Data Format

    All data returned by the API is provided in a compressed [JSON
    Lines](https://jsonlines.org) format, typically in `.gz` compression. You do
    not need to extract these files beforehand, as libraries such as `pandas`
    can handle reading compressed files directly.


    ### 3. Processing Large Files

    Due to the large volume of data, it is recommended to read the data in
    chunks to optimize performance. Below is an example using Python and the
    `pandas` library to process a compressed JSON Lines file:


    ```python

    import pandas as pd


    def read_json_file(file_path):
        try:
            # Read the compressed JSON lines file in chunks
            df = pd.read_json(file_path, compression="gzip", lines=True, chunksize=10000)
            for df_chunk in df:
                print(df_chunk.head())
            return df
        except (ValueError, IOError) as e:
            raise ValueError(f"Failed to read the JSON file: {e}")

    if __name__ == "__main__":
        df = read_json_file("price_explorer.jsonl.gz")
    ```




    - **Compression Handling:** The `pandas` library can read compressed files
    directly, so files do not need to be manually extracted before processing.

    - **Reading in Chunks:** To handle large files efficiently, the data is read
    in manageable chunks using the `chunksize` parameter. The chunk size can be
    adjusted based on the client’s memory and performance requirements.


    ### 4. Download URLs

    Any download URLs provided by the API are valid for **one minute** after the
    request is made. Ensure that you download the files within this time frame
    to avoid errors.
  contact:
    name: API Support
    email: tech@alliedoffsets.com
  version: '2.0'
servers:
  - url: /v2
  - url: https://api.alliedoffsets.com/v2
    description: Production
security: []
paths:
  /cdr/suppliers:
    get:
      tags:
        - CDR
      summary: Get Cdr Suppliers
      operationId: Get_cdr_suppliers_cdr_suppliers_get
      parameters:
        - required: false
          schema:
            type: string
            title: Cursor
          name: cursor
          in: query
        - required: false
          schema:
            type: integer
            title: Limit
            default: 100
          name: limit
          in: query
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CursorResponse_S3APITableResponse_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - OAuth2PasswordBearer:
            - cdr
        - OAuth2PasswordBearer: []
components:
  schemas:
    CursorResponse_S3APITableResponse_:
      properties:
        cursor:
          type: string
          title: Cursor
        result:
          items:
            $ref: '#/components/schemas/S3APITableResponse'
          type: array
          title: Result
      type: object
      required:
        - result
      title: CursorResponse[S3APITableResponse]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    S3APITableResponse:
      properties:
        created_at:
          type: integer
          title: Created At
        updated_at:
          type: integer
          title: Updated At
        filename:
          type: string
          title: Filename
        download_url:
          type: string
          title: Download Url
        is_trial:
          type: boolean
          title: Is Trial
      type: object
      required:
        - created_at
        - updated_at
        - filename
        - is_trial
      title: S3APITableResponse
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: /auth/token

````