مرجع API

API الخاص بـ واجهة تحويل رمز السهم وISIN واسم الشركة إلى نطاق

حوّل رمز سهم أو رمز ISIN أو اسم شركة إلى النطاق الرسمي للشركة. استخدم هذا المرجع لاختيار نقطة النهاية المناسبة ومعرفة ما تعيده بالضبط.

العمليات

GET /v1/company/resolve عرض مرجع API

GET /v1/company/resolve

العملية: resolveCompanyIdentifier الوحدات والمصادقة: 1 المصادقة مطلوبة
GET /v1/company/resolve الرصيد: 1

معاملات الاستعلام

المعامل النوع مطلوب
ticker string اختياري
exchange string اختياري
isin string اختياري
name string اختياري
match string
القيم المسموحة fullprefix
الافتراضي full
اختياري
limit integer
الافتراضي 5
اختياري

حقول الرد

الحقل النوع
query object
query.type string
query.value string
query.exchange string | null
query.match string | null
query.limit integer | null
status string
reason string
domain string | null
website string | null
company object
company.id string
company.name string
company.domain string | null
company.website string | null
company.domains[] string[]
company.identifiers object
company.identifiers.wikidata string | null
company.identifiers.cik string | null
company.identifiers.isins[] string[]
company.identifiers.listings[] object[]
company.identifiers.listings[] object
company.identifiers.listings[].ticker string
company.identifiers.listings[].exchange object
company.identifiers.listings[].exchange.name string | null
company.identifiers.listings[].exchange.mic string | null
company.identifiers.listings[].exchange.wikidata string | null
company.identifiers.listings[].source string
company.confidence string
company.score number
company.match object
company.match.field string
company.match.value string
company.match.kind string
company.sources[] string[]
company.evidence[] object[]
company.evidence[] object
company.evidence[].source string
company.evidence[].field string
company.evidence[].value string
company.evidence[].url string
candidates[] object[]
candidates[] object
candidates[].id string
candidates[].name string
candidates[].domain string | null
candidates[].website string | null
candidates[].domains[] string[]
candidates[].identifiers object
candidates[].identifiers.wikidata string | null
candidates[].identifiers.cik string | null
candidates[].identifiers.isins[] string[]
candidates[].identifiers.listings[] object[]
candidates[].identifiers.listings[] object
candidates[].identifiers.listings[].ticker string
candidates[].identifiers.listings[].exchange object
candidates[].identifiers.listings[].exchange.name string | null
candidates[].identifiers.listings[].exchange.mic string | null
candidates[].identifiers.listings[].exchange.wikidata string | null
candidates[].identifiers.listings[].source string
candidates[].confidence string
candidates[].score number
candidates[].match object
candidates[].match.field string
candidates[].match.value string
candidates[].match.kind string
candidates[].sources[] string[]
candidates[].evidence[] object[]
candidates[].evidence[] object
candidates[].evidence[].source string
candidates[].evidence[].field string
candidates[].evidence[].value string
candidates[].evidence[].url string
classification object
classification.status string
classification.reason string
classification.evidence object
classification.evidence.source string
classification.evidence.method string
classification.evidence.observed_at string
classification.evidence.detail string
classification.checked_at string
checked_at string
meta object
meta.sources[] object[]
meta.sources[] object
meta.sources[].source string
meta.sources[].snapshot_at string | null
meta.sources[].records integer
meta.sources[].stale boolean
meta.sources[].licence string
meta.candidates_total integer

طلب مثال

curl -H "X-API-Key: $DOMSCAN_API_KEY" "https://domscan.net/v1/company/resolve?ticker=example&exchange=example&isin=example&name=example&match=full&limit=25"
const response = await fetch("https://domscan.net/v1/company/resolve?ticker=example&exchange=example&isin=example&name=example&match=full&limit=25", {
  headers: { "X-API-Key": process.env.DOMSCAN_API_KEY },
});
const data = await response.json();
console.log(data);
import os
import requests

response = requests.get(
    "https://domscan.net/v1/company/resolve?ticker=example&exchange=example&isin=example&name=example&match=full&limit=25",
    headers={"X-API-Key": os.environ["DOMSCAN_API_KEY"]},
)
print(response.json())
package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	req, err := http.NewRequest(http.MethodGet, "https://domscan.net/v1/company/resolve?ticker=example&exchange=example&isin=example&name=example&match=full&limit=25", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("X-API-Key", os.Getenv("DOMSCAN_API_KEY"))

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	data, err := io.ReadAll(resp.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(resp.Status, string(data))
}
require "json"
require "net/http"

uri = URI("https://domscan.net/v1/company/resolve?ticker=example&exchange=example&isin=example&name=example&match=full&limit=25")
request = Net::HTTP::Get.new(uri)
request["X-API-Key"] = ENV.fetch("DOMSCAN_API_KEY")

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end
puts JSON.pretty_generate(JSON.parse(response.body))

مثال الرد

{
  "query": {
    "type": "ticker",
    "value": "example",
    "exchange": "example",
    "match": "full",
    "limit": 1
  },
  "status": "present",
  "reason": "resolved",
  "domain": "example.com",
  "website": "example",
  "company": {
    "id": "example-id",
    "name": "example",
    "domain": "example.com",
    "website": "example",
    "domains": [
      "example.com",
      "example.org"
    ],
    "identifiers": {
      "wikidata": "example",
      "cik": "example",
      "isins": [
        "example"
      ],
      "listings": [
        {
          "ticker": "example",
          "exchange": {
            "name": "example",
            "mic": "example",
            "wikidata": "example"
          },
          "source": "sec"
        }
      ]
    },
    "confidence": "high",
    "score": 0.85,
    "match": {
      "field": "ticker",
      "value": "example",
      "kind": "exact"
    },
    "sources": [
      "sec"
    ],
    "evidence": [
      {
        "source": "sec",
        "field": "example",
        "value": "example",
        "url": "https://example.com"
      }
    ]
  },
  "candidates": [
    {
      "id": "example-id",
      "name": "example",
      "domain": "example.com",
      "website": "example",
      "domains": [
        "example.com",
        "example.org"
      ],
      "identifiers": {
        "wikidata": "example",
        "cik": "example",
        "isins": [
          "example"
        ],
        "listings": [
          {
            "ticker": "example",
            "exchange": {
              "name": "example",
              "mic": "example",
              "wikidata": "example"
            },
            "source": "sec"
          }
        ]
      },
      "confidence": "high",
      "score": 0.85,
      "match": {
        "field": "ticker",
        "value": "example",
        "kind": "exact"
      },
      "sources": [
        "sec"
      ],
      "evidence": [
        {
          "source": "sec",
          "field": "example",
          "value": "example",
          "url": "https://example.com"
        }
      ]
    }
  ],
  "classification": {
    "status": "present",
    "evidence": {
      "source": "rdap",
      "method": "rdap_lookup",
      "observed_at": "2026-08-27T12:00:00Z",
      "detail": "example"
    },
    "checked_at": "2026-08-27T12:00:00Z",
    "reason": "blocked"
  },
  "checked_at": "2026-08-27T12:00:00Z",
  "meta": {
    "sources": [
      {
        "source": "sec",
        "snapshot_at": "2026-08-27T12:00:00Z",
        "records": 1,
        "stale": false,
        "licence": "example"
      }
    ],
    "candidates_total": 1
  }
}

رموز حالة HTTP

  • 200 OK
  • 400 طلب غير صالح
  • 401 غير مصرح
  • 402 الدفع مطلوب
  • 429 طلبات كثيرة جداً

موارد المرجع