{
  "info": {
    "name": "DFin API v1",
    "description": "Postman collection for DFin API v1 endpoints. Set the api_key collection variable before sending requests.",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "auth": {
    "type": "bearer",
    "bearer": [
      {
        "key": "token",
        "value": "{{api_key}}",
        "type": "string"
      }
    ]
  },
  "variable": [
    {
      "key": "base_url",
      "value": "https://www.dfin.pro",
      "type": "string"
    },
    {
      "key": "api_key",
      "value": "paste-your-api-key-here",
      "type": "string"
    }
  ],
  "item": [
    {
      "name": "4.1 Search filings",
      "request": {
        "auth": {
          "type": "bearer",
          "bearer": [
            {
              "key": "token",
              "value": "{{api_key}}",
              "type": "string"
            }
          ]
        },
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json",
            "type": "text"
          }
        ],
        "url": {
          "raw": "{{base_url}}/api/v1/filings/search/",
          "host": [
            "{{base_url}}"
          ],
          "path": [
            "api",
            "v1",
            "filings",
            "search"
          ]
        },
        "description": "Search structured company filings.",
        "body": {
          "mode": "raw",
          "raw": "{\n  \"queries\": [\n    \"revenue growth\",\n    \"margin expansion\"\n  ],\n  \"ticker\": \"AAPL.US\",\n  \"fiscal_year\": 2024,\n  \"filing_type\": \"10-K\",\n  \"results\": 5,\n  \"rerank\": false,\n  \"searchtype\": \"hybrid\"\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        }
      }
    },
    {
      "name": "5.1 Get screener options",
      "request": {
        "auth": {
          "type": "bearer",
          "bearer": [
            {
              "key": "token",
              "value": "{{api_key}}",
              "type": "string"
            }
          ]
        },
        "method": "GET",
        "header": [],
        "url": {
          "raw": "{{base_url}}/api/v1/screener/options/",
          "host": [
            "{{base_url}}"
          ],
          "path": [
            "api",
            "v1",
            "screener",
            "options"
          ]
        },
        "description": "Return compact request-building metadata for the current screener API contract."
      },
      "response": [
        {
          "name": "Example response",
          "originalRequest": {
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{api_key}}",
                  "type": "string"
                }
              ]
            },
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/api/v1/screener/options/",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "v1",
                "screener",
                "options"
              ]
            },
            "description": "Return compact request-building metadata for the current screener API contract."
          },
          "status": "OK",
          "code": 200,
          "header": [
            {
              "key": "Content-Type",
              "value": "application/json"
            }
          ],
          "body": "{\n  \"result_formats\": [\n    \"rows\",\n    \"tickers\"\n  ],\n  \"page\": {\n    \"default_limit\": 100,\n    \"default_offset\": 0,\n    \"max_limit\": 1000\n  },\n  \"sort\": {\n    \"fields\": [\n      \"marketCap_usd\",\n      \"return_1y\"\n    ]\n  },\n  \"modes\": {\n    \"basic\": [\n      \"country\",\n      \"sector\",\n      \"marketCap_usd\",\n      \"...\"\n    ],\n    \"advanced\": [\n      \"country\",\n      \"incomeStatementGrowth\",\n      \"marketCap_usd\",\n      \"...\"\n    ]\n  },\n  \"filter_type_defaults\": {\n    \"range\": {\n      \"operators\": [\n        \"min\",\n        \"max\"\n      ]\n    },\n    \"growth_rule_group\": {\n      \"horizons\": [\n        1,\n        2,\n        3,\n        5,\n        7,\n        8,\n        10\n      ],\n      \"value_types\": [\n        \"cagr\",\n        \"multiple\"\n      ],\n      \"value_type_formats\": {\n        \"cagr\": \"percent\",\n        \"multiple\": \"number\"\n      },\n      \"missing_data_policy\": \"exclude\",\n      \"max_rules\": 5\n    }\n  },\n  \"filters\": {\n    \"country\": {\n      \"label\": \"Country\",\n      \"input_type\": \"multi_select\",\n      \"operators\": [\n        \"include\",\n        \"exclude\"\n      ],\n      \"default_operator\": \"include\",\n      \"options_source\": \"countries\"\n    }\n  },\n  \"option_values\": {\n    \"countries\": [\n      \"Canada\",\n      \"United States\"\n    ]\n  },\n  \"fields\": [\n    \"companyName\",\n    \"full_ticker\",\n    \"marketCap_usd\"\n  ]\n}"
        }
      ]
    },
    {
      "name": "5.3 Run a basic screener",
      "request": {
        "auth": {
          "type": "bearer",
          "bearer": [
            {
              "key": "token",
              "value": "{{api_key}}",
              "type": "string"
            }
          ]
        },
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json",
            "type": "text"
          }
        ],
        "url": {
          "raw": "{{base_url}}/api/v1/screener/basic/",
          "host": [
            "{{base_url}}"
          ],
          "path": [
            "api",
            "v1",
            "screener",
            "basic"
          ]
        },
        "description": "Run the simple screener filter set.",
        "body": {
          "mode": "raw",
          "raw": "{\n  \"filters\": {\n    \"country\": {\n      \"operator\": \"include\",\n      \"values\": [\n        \"United States\"\n      ]\n    },\n    \"sector\": {\n      \"operator\": \"include\",\n      \"values\": [\n        \"Information Technology\"\n      ]\n    },\n    \"marketCap_usd\": {\n      \"min\": 1000000000\n    },\n    \"return_1y\": {\n      \"min\": 0.1\n    }\n  },\n  \"sort\": {\n    \"field\": \"marketCap_usd\",\n    \"desc\": true\n  },\n  \"page\": {\n    \"limit\": 100,\n    \"offset\": 0\n  },\n  \"fields\": [\n    \"full_ticker\",\n    \"companyName\",\n    \"marketCap_usd\"\n  ],\n  \"result_format\": \"rows\"\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        }
      },
      "response": [
        {
          "name": "Example response",
          "originalRequest": {
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{api_key}}",
                  "type": "string"
                }
              ]
            },
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json",
                "type": "text"
              }
            ],
            "url": {
              "raw": "{{base_url}}/api/v1/screener/basic/",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "v1",
                "screener",
                "basic"
              ]
            },
            "description": "Run the simple screener filter set.",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"filters\": {\n    \"country\": {\n      \"operator\": \"include\",\n      \"values\": [\n        \"United States\"\n      ]\n    },\n    \"sector\": {\n      \"operator\": \"include\",\n      \"values\": [\n        \"Information Technology\"\n      ]\n    },\n    \"marketCap_usd\": {\n      \"min\": 1000000000\n    },\n    \"return_1y\": {\n      \"min\": 0.1\n    }\n  },\n  \"sort\": {\n    \"field\": \"marketCap_usd\",\n    \"desc\": true\n  },\n  \"page\": {\n    \"limit\": 100,\n    \"offset\": 0\n  },\n  \"fields\": [\n    \"full_ticker\",\n    \"companyName\",\n    \"marketCap_usd\"\n  ],\n  \"result_format\": \"rows\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          },
          "status": "OK",
          "code": 200,
          "header": [
            {
              "key": "Content-Type",
              "value": "application/json"
            }
          ],
          "body": "{\n  \"total\": 1,\n  \"limit\": 100,\n  \"offset\": 0,\n  \"loaded_fields\": [\n    \"full_ticker\",\n    \"companyName\",\n    \"marketCap_usd\"\n  ],\n  \"temporary_columns\": [],\n  \"rows\": [\n    {\n      \"full_ticker\": \"AAPL.US\",\n      \"companyName\": \"Apple\",\n      \"marketCap_usd\": 3000000000000\n    }\n  ]\n}"
        }
      ]
    },
    {
      "name": "5.4 Run an advanced screener",
      "request": {
        "auth": {
          "type": "bearer",
          "bearer": [
            {
              "key": "token",
              "value": "{{api_key}}",
              "type": "string"
            }
          ]
        },
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json",
            "type": "text"
          }
        ],
        "url": {
          "raw": "{{base_url}}/api/v1/screener/advanced/",
          "host": [
            "{{base_url}}"
          ],
          "path": [
            "api",
            "v1",
            "screener",
            "advanced"
          ]
        },
        "description": "Run the advanced screener contract.",
        "body": {
          "mode": "raw",
          "raw": "{\n  \"filters\": {\n    \"country\": {\n      \"operator\": \"include\",\n      \"values\": [\n        \"United States\"\n      ]\n    },\n    \"incomeStatementGrowth\": {\n      \"rules\": [\n        {\n          \"metric\": \"revenue\",\n          \"horizon_years\": 5,\n          \"value_type\": \"cagr\",\n          \"currency_basis\": \"reported\",\n          \"min\": 0.1\n        }\n      ]\n    }\n  },\n  \"result_format\": \"tickers\",\n  \"page\": {\n    \"limit\": 100,\n    \"offset\": 0\n  }\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        }
      },
      "response": [
        {
          "name": "Example response",
          "originalRequest": {
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{api_key}}",
                  "type": "string"
                }
              ]
            },
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json",
                "type": "text"
              }
            ],
            "url": {
              "raw": "{{base_url}}/api/v1/screener/advanced/",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "v1",
                "screener",
                "advanced"
              ]
            },
            "description": "Run the advanced screener contract.",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"filters\": {\n    \"country\": {\n      \"operator\": \"include\",\n      \"values\": [\n        \"United States\"\n      ]\n    },\n    \"incomeStatementGrowth\": {\n      \"rules\": [\n        {\n          \"metric\": \"revenue\",\n          \"horizon_years\": 5,\n          \"value_type\": \"cagr\",\n          \"currency_basis\": \"reported\",\n          \"min\": 0.1\n        }\n      ]\n    }\n  },\n  \"result_format\": \"tickers\",\n  \"page\": {\n    \"limit\": 100,\n    \"offset\": 0\n  }\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          },
          "status": "OK",
          "code": 200,
          "header": [
            {
              "key": "Content-Type",
              "value": "application/json"
            }
          ],
          "body": "{\n  \"total\": 2,\n  \"limit\": 100,\n  \"offset\": 0,\n  \"tickers\": [\n    \"AAPL.US\",\n    \"MSFT.US\"\n  ]\n}"
        }
      ]
    }
  ]
}